Interface VersionOrBuilder (0.7.0)

public interface VersionOrBuilder extends MessageOrBuilder

Implements

MessageOrBuilder

Methods

containsAttributes(String key)

public abstract boolean containsAttributes(String key)

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];

Parameter
Name	Description
`key`	`String`

Returns
Type	Description
`boolean`

getAccreditation()

public abstract 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
Type	Description
`AttributeValues`	The accreditation.

getAccreditationOrBuilder()

public abstract AttributeValuesOrBuilder getAccreditationOrBuilder()

.google.cloud.apihub.v1.AttributeValues accreditation = 13 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
`AttributeValuesOrBuilder`

getApiOperations(int index)

public abstract String getApiOperations(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) = { ... }

Parameter
Name	Description
`index`	`int` The index of the element to return.

Returns
Type	Description
`String`	The apiOperations at the given index.

getApiOperationsBytes(int index)

public abstract ByteString getApiOperationsBytes(int index)

repeated string api_operations = 6 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.resource_reference) = { ... }

Parameter
Name	Description
`index`	`int` The index of the value to return.

Returns
Type	Description
`ByteString`	The bytes of the apiOperations at the given index.

getApiOperationsCount()

public abstract int getApiOperationsCount()

repeated string api_operations = 6 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.resource_reference) = { ... }

Returns
Type	Description
`int`	The count of apiOperations.

getApiOperationsList()

public abstract List<String> getApiOperationsList()

repeated string api_operations = 6 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.resource_reference) = { ... }

Returns
Type	Description
`List<String>`	A list containing the apiOperations.

getAttributes() (deprecated)

public abstract Map<String,AttributeValues> getAttributes()

Use #getAttributesMap() instead.

Returns
Type	Description
`Map<String,AttributeValues>`

getAttributesCount()

public abstract int getAttributesCount()

map<string, .google.cloud.apihub.v1.AttributeValues> attributes = 14 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
`int`

getAttributesMap()

public abstract Map<String,AttributeValues> getAttributesMap()

map<string, .google.cloud.apihub.v1.AttributeValues> attributes = 14 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
`Map<String,AttributeValues>`

getAttributesOrDefault(String key, AttributeValues defaultValue)

public abstract AttributeValues getAttributesOrDefault(String key, AttributeValues defaultValue)

map<string, .google.cloud.apihub.v1.AttributeValues> attributes = 14 [(.google.api.field_behavior) = OPTIONAL];

Parameters
Name	Description
`key`	`String`
`defaultValue`	`AttributeValues`

Returns
Type	Description
`AttributeValues`

getAttributesOrThrow(String key)

public abstract AttributeValues getAttributesOrThrow(String key)

map<string, .google.cloud.apihub.v1.AttributeValues> attributes = 14 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name	Description
`key`	`String`

Returns
Type	Description
`AttributeValues`

getCompliance()

public abstract 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
Type	Description
`AttributeValues`	The compliance.

getComplianceOrBuilder()

public abstract AttributeValuesOrBuilder getComplianceOrBuilder()

.google.cloud.apihub.v1.AttributeValues compliance = 12 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
`AttributeValuesOrBuilder`

getCreateTime()

public abstract 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
Type	Description
`Timestamp`	The createTime.

getCreateTimeOrBuilder()

public abstract TimestampOrBuilder getCreateTimeOrBuilder()

Output only. The time at which the version was created.

.google.protobuf.Timestamp create_time = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
`TimestampOrBuilder`

getDefinitions(int index)

public abstract String getDefinitions(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) = { ... }

Parameter
Name	Description
`index`	`int` The index of the element to return.

Returns
Type	Description
`String`	The definitions at the given index.

getDefinitionsBytes(int index)

public abstract ByteString getDefinitionsBytes(int index)

repeated string definitions = 7 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.resource_reference) = { ... }

Parameter
Name	Description
`index`	`int` The index of the value to return.

Returns
Type	Description
`ByteString`	The bytes of the definitions at the given index.

getDefinitionsCount()

public abstract int getDefinitionsCount()

repeated string definitions = 7 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.resource_reference) = { ... }

Returns
Type	Description
`int`	The count of definitions.

getDefinitionsList()

public abstract List<String> getDefinitionsList()

repeated string definitions = 7 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.resource_reference) = { ... }

Returns
Type	Description
`List<String>`	A list containing the definitions.

getDeployments(int index)

public abstract String getDeployments(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) = { ... }

Parameter
Name	Description
`index`	`int` The index of the element to return.

Returns
Type	Description
`String`	The deployments at the given index.

getDeploymentsBytes(int index)

public abstract ByteString getDeploymentsBytes(int index)

repeated string deployments = 8 [(.google.api.field_behavior) = OPTIONAL, (.google.api.resource_reference) = { ... }

Parameter
Name	Description
`index`	`int` The index of the value to return.

Returns
Type	Description
`ByteString`	The bytes of the deployments at the given index.

getDeploymentsCount()

public abstract int getDeploymentsCount()

repeated string deployments = 8 [(.google.api.field_behavior) = OPTIONAL, (.google.api.resource_reference) = { ... }

Returns
Type	Description
`int`	The count of deployments.

getDeploymentsList()

public abstract List<String> getDeploymentsList()

repeated string deployments = 8 [(.google.api.field_behavior) = OPTIONAL, (.google.api.resource_reference) = { ... }

Returns
Type	Description
`List<String>`	A list containing the deployments.

getDescription()

public abstract String getDescription()

Optional. The description of the version.

string description = 3 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
`String`	The description.

getDescriptionBytes()

public abstract ByteString getDescriptionBytes()

Optional. The description of the version.

string description = 3 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
`ByteString`	The bytes for description.

getDisplayName()

public abstract String getDisplayName()

Required. The display name of the version.

string display_name = 2 [(.google.api.field_behavior) = REQUIRED];

Returns
Type	Description
`String`	The displayName.

getDisplayNameBytes()

public abstract ByteString getDisplayNameBytes()

Required. The display name of the version.

string display_name = 2 [(.google.api.field_behavior) = REQUIRED];

Returns
Type	Description
`ByteString`	The bytes for displayName.

getDocumentation()

public abstract Documentation getDocumentation()

Optional. The documentation of the version.

.google.cloud.apihub.v1.Documentation documentation = 4 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
`Documentation`	The documentation.

getDocumentationOrBuilder()

public abstract DocumentationOrBuilder getDocumentationOrBuilder()

Optional. The documentation of the version.

.google.cloud.apihub.v1.Documentation documentation = 4 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
`DocumentationOrBuilder`

getLifecycle()

public abstract 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
Type	Description
`AttributeValues`	The lifecycle.

getLifecycleOrBuilder()

public abstract AttributeValuesOrBuilder getLifecycleOrBuilder()

.google.cloud.apihub.v1.AttributeValues lifecycle = 11 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
`AttributeValuesOrBuilder`

getName()

public abstract 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
Type	Description
`String`	The name.

getNameBytes()

public abstract 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
Type	Description
`ByteString`	The bytes for name.

getSelectedDeployment()

public abstract 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
Type	Description
`String`	The selectedDeployment.

getSelectedDeploymentBytes()

public abstract ByteString getSelectedDeploymentBytes()

string selected_deployment = 16 [(.google.api.field_behavior) = OPTIONAL, (.google.api.resource_reference) = { ... }

Returns
Type	Description
`ByteString`	The bytes for selectedDeployment.

getSpecs(int index)

public abstract String getSpecs(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) = { ... }

Parameter
Name	Description
`index`	`int` The index of the element to return.

Returns
Type	Description
`String`	The specs at the given index.

getSpecsBytes(int index)

public abstract ByteString getSpecsBytes(int index)

repeated string specs = 5 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.resource_reference) = { ... }

Parameter
Name	Description
`index`	`int` The index of the value to return.

Returns
Type	Description
`ByteString`	The bytes of the specs at the given index.

getSpecsCount()

public abstract int getSpecsCount()

repeated string specs = 5 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.resource_reference) = { ... }

Returns
Type	Description
`int`	The count of specs.

getSpecsList()

public abstract List<String> getSpecsList()

repeated string specs = 5 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.resource_reference) = { ... }

Returns
Type	Description
`List<String>`	A list containing the specs.

getUpdateTime()

public abstract 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
Type	Description
`Timestamp`	The updateTime.

getUpdateTimeOrBuilder()

public abstract 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];

Returns
Type	Description
`TimestampOrBuilder`

hasAccreditation()

public abstract boolean hasAccreditation()

.google.cloud.apihub.v1.AttributeValues accreditation = 13 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
`boolean`	Whether the accreditation field is set.

hasCompliance()

public abstract boolean hasCompliance()

.google.cloud.apihub.v1.AttributeValues compliance = 12 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
`boolean`	Whether the compliance field is set.

hasCreateTime()

public abstract 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
Type	Description
`boolean`	Whether the createTime field is set.

hasDocumentation()

public abstract boolean hasDocumentation()

Optional. The documentation of the version.

.google.cloud.apihub.v1.Documentation documentation = 4 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
`boolean`	Whether the documentation field is set.

hasLifecycle()

public abstract boolean hasLifecycle()

.google.cloud.apihub.v1.AttributeValues lifecycle = 11 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
`boolean`	Whether the lifecycle field is set.

hasUpdateTime()

public abstract 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
Type	Description
`boolean`	Whether the updateTime field is set.