Package com.google.cloud.apihub.v1
Interface VersionOrBuilder
- All Superinterfaces:
com.google.protobuf.MessageLiteOrBuilder,com.google.protobuf.MessageOrBuilder
- All Known Implementing Classes:
Version,Version.Builder
@Generated
public interface VersionOrBuilder
extends com.google.protobuf.MessageOrBuilder
-
Method Summary
Modifier and TypeMethodDescriptionbooleancontainsAttributes(String key) Optional.Optional.Optional.getApiOperations(int index) Output only.com.google.protobuf.ByteStringgetApiOperationsBytes(int index) Output only.intOutput only.Output only.Deprecated.intOptional.Optional.getAttributesOrDefault(String key, AttributeValues defaultValue) Optional.Optional.Optional.Optional.com.google.protobuf.TimestampOutput only.com.google.protobuf.TimestampOrBuilderOutput only.getDefinitions(int index) Output only.com.google.protobuf.ByteStringgetDefinitionsBytes(int index) Output only.intOutput only.Output only.getDeployments(int index) Optional.com.google.protobuf.ByteStringgetDeploymentsBytes(int index) Optional.intOptional.Optional.Optional.com.google.protobuf.ByteStringOptional.Required.com.google.protobuf.ByteStringRequired.Optional.Optional.Optional.Optional.getName()Identifier.com.google.protobuf.ByteStringIdentifier.Optional.com.google.protobuf.ByteStringOptional.getSourceMetadata(int index) Output only.intOutput only.Output only.getSourceMetadataOrBuilder(int index) Output only.List<? extends SourceMetadataOrBuilder>Output only.getSpecs(int index) Output only.com.google.protobuf.ByteStringgetSpecsBytes(int index) Output only.intOutput only.Output only.com.google.protobuf.TimestampOutput only.com.google.protobuf.TimestampOrBuilderOutput only.booleanOptional.booleanOptional.booleanOutput only.booleanOptional.booleanOptional.booleanOutput only.Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder
isInitializedMethods inherited from interface com.google.protobuf.MessageOrBuilder
findInitializationErrors, getAllFields, getDefaultInstanceForType, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof
-
Method Details
-
getName
String getName()Identifier. The name of the version. Format: `projects/{project}/locations/{location}/apis/{api}/versions/{version}`string name = 1 [(.google.api.field_behavior) = IDENTIFIER];- Returns:
- The name.
-
getNameBytes
com.google.protobuf.ByteString getNameBytes()Identifier. The name of the version. Format: `projects/{project}/locations/{location}/apis/{api}/versions/{version}`string name = 1 [(.google.api.field_behavior) = IDENTIFIER];- Returns:
- The bytes for name.
-
getDisplayName
String getDisplayName()Required. The display name of the version.
string display_name = 2 [(.google.api.field_behavior) = REQUIRED];- Returns:
- The displayName.
-
getDisplayNameBytes
com.google.protobuf.ByteString getDisplayNameBytes()Required. The display name of the version.
string display_name = 2 [(.google.api.field_behavior) = REQUIRED];- Returns:
- The bytes for displayName.
-
getDescription
String getDescription()Optional. The description of the version.
string description = 3 [(.google.api.field_behavior) = OPTIONAL];- Returns:
- The description.
-
getDescriptionBytes
com.google.protobuf.ByteString getDescriptionBytes()Optional. The description of the version.
string description = 3 [(.google.api.field_behavior) = OPTIONAL];- Returns:
- The bytes for description.
-
hasDocumentation
boolean hasDocumentation()Optional. The documentation of the version.
.google.cloud.apihub.v1.Documentation documentation = 4 [(.google.api.field_behavior) = OPTIONAL];- Returns:
- Whether the documentation field is set.
-
getDocumentation
Documentation getDocumentation()Optional. The documentation of the version.
.google.cloud.apihub.v1.Documentation documentation = 4 [(.google.api.field_behavior) = OPTIONAL];- Returns:
- The documentation.
-
getDocumentationOrBuilder
DocumentationOrBuilder getDocumentationOrBuilder()Optional. The documentation of the version.
.google.cloud.apihub.v1.Documentation documentation = 4 [(.google.api.field_behavior) = OPTIONAL]; -
getSpecsList
Output only. The specs associated with this version. Note that an API version can be associated with multiple specs. Format is `projects/{project}/locations/{location}/apis/{api}/versions/{version}/specs/{spec}`repeated string specs = 5 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.resource_reference) = { ... }- Returns:
- A list containing the specs.
-
getSpecsCount
int getSpecsCount()Output only. The specs associated with this version. Note that an API version can be associated with multiple specs. Format is `projects/{project}/locations/{location}/apis/{api}/versions/{version}/specs/{spec}`repeated string specs = 5 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.resource_reference) = { ... }- Returns:
- The count of specs.
-
getSpecs
Output only. The specs associated with this version. Note that an API version can be associated with multiple specs. Format is `projects/{project}/locations/{location}/apis/{api}/versions/{version}/specs/{spec}`repeated string specs = 5 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.resource_reference) = { ... }- Parameters:
index- The index of the element to return.- Returns:
- The specs at the given index.
-
getSpecsBytes
com.google.protobuf.ByteString getSpecsBytes(int index) Output only. The specs associated with this version. Note that an API version can be associated with multiple specs. Format is `projects/{project}/locations/{location}/apis/{api}/versions/{version}/specs/{spec}`repeated string specs = 5 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.resource_reference) = { ... }- Parameters:
index- The index of the value to return.- Returns:
- The bytes of the specs at the given index.
-
getApiOperationsList
Output only. The operations contained in the API version. These operations will be added to the version when a new spec is added or when an existing spec is updated. Format is `projects/{project}/locations/{location}/apis/{api}/versions/{version}/operations/{operation}`repeated string api_operations = 6 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.resource_reference) = { ... }- Returns:
- A list containing the apiOperations.
-
getApiOperationsCount
int getApiOperationsCount()Output only. The operations contained in the API version. These operations will be added to the version when a new spec is added or when an existing spec is updated. Format is `projects/{project}/locations/{location}/apis/{api}/versions/{version}/operations/{operation}`repeated string api_operations = 6 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.resource_reference) = { ... }- Returns:
- The count of apiOperations.
-
getApiOperations
Output only. The operations contained in the API version. These operations will be added to the version when a new spec is added or when an existing spec is updated. Format is `projects/{project}/locations/{location}/apis/{api}/versions/{version}/operations/{operation}`repeated string api_operations = 6 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.resource_reference) = { ... }- Parameters:
index- The index of the element to return.- Returns:
- The apiOperations at the given index.
-
getApiOperationsBytes
com.google.protobuf.ByteString getApiOperationsBytes(int index) Output only. The operations contained in the API version. These operations will be added to the version when a new spec is added or when an existing spec is updated. Format is `projects/{project}/locations/{location}/apis/{api}/versions/{version}/operations/{operation}`repeated string api_operations = 6 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.resource_reference) = { ... }- Parameters:
index- The index of the value to return.- Returns:
- The bytes of the apiOperations at the given index.
-
getDefinitionsList
Output only. The definitions contained in the API version. These definitions will be added to the version when a new spec is added or when an existing spec is updated. Format is `projects/{project}/locations/{location}/apis/{api}/versions/{version}/definitions/{definition}`repeated string definitions = 7 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.resource_reference) = { ... }- Returns:
- A list containing the definitions.
-
getDefinitionsCount
int getDefinitionsCount()Output only. The definitions contained in the API version. These definitions will be added to the version when a new spec is added or when an existing spec is updated. Format is `projects/{project}/locations/{location}/apis/{api}/versions/{version}/definitions/{definition}`repeated string definitions = 7 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.resource_reference) = { ... }- Returns:
- The count of definitions.
-
getDefinitions
Output only. The definitions contained in the API version. These definitions will be added to the version when a new spec is added or when an existing spec is updated. Format is `projects/{project}/locations/{location}/apis/{api}/versions/{version}/definitions/{definition}`repeated string definitions = 7 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.resource_reference) = { ... }- Parameters:
index- The index of the element to return.- Returns:
- The definitions at the given index.
-
getDefinitionsBytes
com.google.protobuf.ByteString getDefinitionsBytes(int index) Output only. The definitions contained in the API version. These definitions will be added to the version when a new spec is added or when an existing spec is updated. Format is `projects/{project}/locations/{location}/apis/{api}/versions/{version}/definitions/{definition}`repeated string definitions = 7 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.resource_reference) = { ... }- Parameters:
index- The index of the value to return.- Returns:
- The bytes of the definitions at the given index.
-
getDeploymentsList
Optional. The deployments linked to this API version. Note: A particular API version could be deployed to multiple deployments (for dev deployment, UAT deployment, etc) Format is `projects/{project}/locations/{location}/deployments/{deployment}`repeated string deployments = 8 [(.google.api.field_behavior) = OPTIONAL, (.google.api.resource_reference) = { ... }- Returns:
- A list containing the deployments.
-
getDeploymentsCount
int getDeploymentsCount()Optional. The deployments linked to this API version. Note: A particular API version could be deployed to multiple deployments (for dev deployment, UAT deployment, etc) Format is `projects/{project}/locations/{location}/deployments/{deployment}`repeated string deployments = 8 [(.google.api.field_behavior) = OPTIONAL, (.google.api.resource_reference) = { ... }- Returns:
- The count of deployments.
-
getDeployments
Optional. The deployments linked to this API version. Note: A particular API version could be deployed to multiple deployments (for dev deployment, UAT deployment, etc) Format is `projects/{project}/locations/{location}/deployments/{deployment}`repeated string deployments = 8 [(.google.api.field_behavior) = OPTIONAL, (.google.api.resource_reference) = { ... }- Parameters:
index- The index of the element to return.- Returns:
- The deployments at the given index.
-
getDeploymentsBytes
com.google.protobuf.ByteString getDeploymentsBytes(int index) Optional. The deployments linked to this API version. Note: A particular API version could be deployed to multiple deployments (for dev deployment, UAT deployment, etc) Format is `projects/{project}/locations/{location}/deployments/{deployment}`repeated string deployments = 8 [(.google.api.field_behavior) = OPTIONAL, (.google.api.resource_reference) = { ... }- Parameters:
index- The index of the value to return.- Returns:
- The bytes of the deployments at the given index.
-
hasCreateTime
boolean hasCreateTime()Output only. The time at which the version was created.
.google.protobuf.Timestamp create_time = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];- Returns:
- Whether the createTime field is set.
-
getCreateTime
com.google.protobuf.Timestamp getCreateTime()Output only. The time at which the version was created.
.google.protobuf.Timestamp create_time = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];- Returns:
- The createTime.
-
getCreateTimeOrBuilder
com.google.protobuf.TimestampOrBuilder getCreateTimeOrBuilder()Output only. The time at which the version was created.
.google.protobuf.Timestamp create_time = 9 [(.google.api.field_behavior) = OUTPUT_ONLY]; -
hasUpdateTime
boolean hasUpdateTime()Output only. The time at which the version was last updated.
.google.protobuf.Timestamp update_time = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];- Returns:
- Whether the updateTime field is set.
-
getUpdateTime
com.google.protobuf.Timestamp getUpdateTime()Output only. The time at which the version was last updated.
.google.protobuf.Timestamp update_time = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];- Returns:
- The updateTime.
-
getUpdateTimeOrBuilder
com.google.protobuf.TimestampOrBuilder getUpdateTimeOrBuilder()Output only. The time at which the version was last updated.
.google.protobuf.Timestamp update_time = 10 [(.google.api.field_behavior) = OUTPUT_ONLY]; -
hasLifecycle
boolean hasLifecycle()Optional. The lifecycle of the API version. This maps to the following system defined attribute: `projects/{project}/locations/{location}/attributes/system-lifecycle` attribute. The number of values for this attribute will be based on the cardinality of the attribute. The same can be retrieved via GetAttribute API. All values should be from the list of allowed values defined for the attribute..google.cloud.apihub.v1.AttributeValues lifecycle = 11 [(.google.api.field_behavior) = OPTIONAL];- Returns:
- Whether the lifecycle field is set.
-
getLifecycle
AttributeValues getLifecycle()Optional. The lifecycle of the API version. This maps to the following system defined attribute: `projects/{project}/locations/{location}/attributes/system-lifecycle` attribute. The number of values for this attribute will be based on the cardinality of the attribute. The same can be retrieved via GetAttribute API. All values should be from the list of allowed values defined for the attribute..google.cloud.apihub.v1.AttributeValues lifecycle = 11 [(.google.api.field_behavior) = OPTIONAL];- Returns:
- The lifecycle.
-
getLifecycleOrBuilder
AttributeValuesOrBuilder getLifecycleOrBuilder()Optional. The lifecycle of the API version. This maps to the following system defined attribute: `projects/{project}/locations/{location}/attributes/system-lifecycle` attribute. The number of values for this attribute will be based on the cardinality of the attribute. The same can be retrieved via GetAttribute API. All values should be from the list of allowed values defined for the attribute..google.cloud.apihub.v1.AttributeValues lifecycle = 11 [(.google.api.field_behavior) = OPTIONAL]; -
hasCompliance
boolean hasCompliance()Optional. The compliance associated with the API version. This maps to the following system defined attribute: `projects/{project}/locations/{location}/attributes/system-compliance` attribute. The number of values for this attribute will be based on the cardinality of the attribute. The same can be retrieved via GetAttribute API. All values should be from the list of allowed values defined for the attribute..google.cloud.apihub.v1.AttributeValues compliance = 12 [(.google.api.field_behavior) = OPTIONAL];- Returns:
- Whether the compliance field is set.
-
getCompliance
AttributeValues getCompliance()Optional. The compliance associated with the API version. This maps to the following system defined attribute: `projects/{project}/locations/{location}/attributes/system-compliance` attribute. The number of values for this attribute will be based on the cardinality of the attribute. The same can be retrieved via GetAttribute API. All values should be from the list of allowed values defined for the attribute..google.cloud.apihub.v1.AttributeValues compliance = 12 [(.google.api.field_behavior) = OPTIONAL];- Returns:
- The compliance.
-
getComplianceOrBuilder
AttributeValuesOrBuilder getComplianceOrBuilder()Optional. The compliance associated with the API version. This maps to the following system defined attribute: `projects/{project}/locations/{location}/attributes/system-compliance` attribute. The number of values for this attribute will be based on the cardinality of the attribute. The same can be retrieved via GetAttribute API. All values should be from the list of allowed values defined for the attribute..google.cloud.apihub.v1.AttributeValues compliance = 12 [(.google.api.field_behavior) = OPTIONAL]; -
hasAccreditation
boolean hasAccreditation()Optional. The accreditations associated with the API version. This maps to the following system defined attribute: `projects/{project}/locations/{location}/attributes/system-accreditation` attribute. The number of values for this attribute will be based on the cardinality of the attribute. The same can be retrieved via GetAttribute API. All values should be from the list of allowed values defined for the attribute..google.cloud.apihub.v1.AttributeValues accreditation = 13 [(.google.api.field_behavior) = OPTIONAL];- Returns:
- Whether the accreditation field is set.
-
getAccreditation
AttributeValues getAccreditation()Optional. The accreditations associated with the API version. This maps to the following system defined attribute: `projects/{project}/locations/{location}/attributes/system-accreditation` attribute. The number of values for this attribute will be based on the cardinality of the attribute. The same can be retrieved via GetAttribute API. All values should be from the list of allowed values defined for the attribute..google.cloud.apihub.v1.AttributeValues accreditation = 13 [(.google.api.field_behavior) = OPTIONAL];- Returns:
- The accreditation.
-
getAccreditationOrBuilder
AttributeValuesOrBuilder getAccreditationOrBuilder()Optional. The accreditations associated with the API version. This maps to the following system defined attribute: `projects/{project}/locations/{location}/attributes/system-accreditation` attribute. The number of values for this attribute will be based on the cardinality of the attribute. The same can be retrieved via GetAttribute API. All values should be from the list of allowed values defined for the attribute..google.cloud.apihub.v1.AttributeValues accreditation = 13 [(.google.api.field_behavior) = OPTIONAL]; -
getAttributesCount
int getAttributesCount()Optional. The list of user defined attributes associated with the Version resource. The key is the attribute name. It will be of the format: `projects/{project}/locations/{location}/attributes/{attribute}`. The value is the attribute values associated with the resource.map<string, .google.cloud.apihub.v1.AttributeValues> attributes = 14 [(.google.api.field_behavior) = OPTIONAL]; -
containsAttributes
Optional. The list of user defined attributes associated with the Version resource. The key is the attribute name. It will be of the format: `projects/{project}/locations/{location}/attributes/{attribute}`. The value is the attribute values associated with the resource.map<string, .google.cloud.apihub.v1.AttributeValues> attributes = 14 [(.google.api.field_behavior) = OPTIONAL]; -
getAttributes
Deprecated.UsegetAttributesMap()instead. -
getAttributesMap
Map<String,AttributeValues> getAttributesMap()Optional. The list of user defined attributes associated with the Version resource. The key is the attribute name. It will be of the format: `projects/{project}/locations/{location}/attributes/{attribute}`. The value is the attribute values associated with the resource.map<string, .google.cloud.apihub.v1.AttributeValues> attributes = 14 [(.google.api.field_behavior) = OPTIONAL]; -
getAttributesOrDefault
Optional. The list of user defined attributes associated with the Version resource. The key is the attribute name. It will be of the format: `projects/{project}/locations/{location}/attributes/{attribute}`. The value is the attribute values associated with the resource.map<string, .google.cloud.apihub.v1.AttributeValues> attributes = 14 [(.google.api.field_behavior) = OPTIONAL]; -
getAttributesOrThrow
Optional. The list of user defined attributes associated with the Version resource. The key is the attribute name. It will be of the format: `projects/{project}/locations/{location}/attributes/{attribute}`. The value is the attribute values associated with the resource.map<string, .google.cloud.apihub.v1.AttributeValues> attributes = 14 [(.google.api.field_behavior) = OPTIONAL]; -
getSelectedDeployment
String getSelectedDeployment()Optional. The selected deployment for a Version resource. This can be used when special handling is needed on client side for a particular deployment linked to the version. Format is `projects/{project}/locations/{location}/deployments/{deployment}`string selected_deployment = 16 [(.google.api.field_behavior) = OPTIONAL, (.google.api.resource_reference) = { ... }- Returns:
- The selectedDeployment.
-
getSelectedDeploymentBytes
com.google.protobuf.ByteString getSelectedDeploymentBytes()Optional. The selected deployment for a Version resource. This can be used when special handling is needed on client side for a particular deployment linked to the version. Format is `projects/{project}/locations/{location}/deployments/{deployment}`string selected_deployment = 16 [(.google.api.field_behavior) = OPTIONAL, (.google.api.resource_reference) = { ... }- Returns:
- The bytes for selectedDeployment.
-
getSourceMetadataList
List<SourceMetadata> getSourceMetadataList()Output only. The list of sources and metadata from the sources of the version.
repeated .google.cloud.apihub.v1.SourceMetadata source_metadata = 17 [(.google.api.field_behavior) = OUTPUT_ONLY]; -
getSourceMetadata
Output only. The list of sources and metadata from the sources of the version.
repeated .google.cloud.apihub.v1.SourceMetadata source_metadata = 17 [(.google.api.field_behavior) = OUTPUT_ONLY]; -
getSourceMetadataCount
int getSourceMetadataCount()Output only. The list of sources and metadata from the sources of the version.
repeated .google.cloud.apihub.v1.SourceMetadata source_metadata = 17 [(.google.api.field_behavior) = OUTPUT_ONLY]; -
getSourceMetadataOrBuilderList
List<? extends SourceMetadataOrBuilder> getSourceMetadataOrBuilderList()Output only. The list of sources and metadata from the sources of the version.
repeated .google.cloud.apihub.v1.SourceMetadata source_metadata = 17 [(.google.api.field_behavior) = OUTPUT_ONLY]; -
getSourceMetadataOrBuilder
Output only. The list of sources and metadata from the sources of the version.
repeated .google.cloud.apihub.v1.SourceMetadata source_metadata = 17 [(.google.api.field_behavior) = OUTPUT_ONLY];
-