Interface DeploymentOrBuilder (0.28.0) 

public interface DeploymentOrBuilder extends MessageOrBuilder

Implements

MessageOrBuilder

Methods

containsAttributes(String key)

public abstract boolean containsAttributes(String key)

Optional. The list of user defined attributes associated with the deployment 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 = 13 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
key String
Returns
Type Description
boolean

getApiVersions(int index)

public abstract String getApiVersions(int index)

Output only. The API versions linked to this deployment. Note: A particular deployment could be linked to multiple different API versions (of same or different APIs).

repeated string api_versions = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
index int

The index of the element to return.
Returns
Type Description
String

The apiVersions at the given index.

getApiVersionsBytes(int index)

public abstract ByteString getApiVersionsBytes(int index)

Output only. The API versions linked to this deployment. Note: A particular deployment could be linked to multiple different API versions (of same or different APIs).

repeated string api_versions = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
index int

The index of the value to return.
Returns
Type Description
ByteString

The bytes of the apiVersions at the given index.

getApiVersionsCount()

public abstract int getApiVersionsCount()

Output only. The API versions linked to this deployment. Note: A particular deployment could be linked to multiple different API versions (of same or different APIs).

repeated string api_versions = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
int

The count of apiVersions.

getApiVersionsList()

public abstract List<String> getApiVersionsList()

Output only. The API versions linked to this deployment. Note: A particular deployment could be linked to multiple different API versions (of same or different APIs).

repeated string api_versions = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
List<String>

A list containing the apiVersions.

getAttributes() (deprecated)

public abstract Map<String,AttributeValues> getAttributes()

Use #getAttributesMap() instead.

Returns
Type Description
Map<String,AttributeValues>

getAttributesCount()

public abstract int getAttributesCount()

Optional. The list of user defined attributes associated with the deployment 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 = 13 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
int

getAttributesMap()

public abstract Map<String,AttributeValues> getAttributesMap()

Optional. The list of user defined attributes associated with the deployment 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 = 13 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
Map<String,AttributeValues>

getAttributesOrDefault(String key, AttributeValues defaultValue)

public abstract AttributeValues getAttributesOrDefault(String key, AttributeValues defaultValue)

Optional. The list of user defined attributes associated with the deployment 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 = 13 [(.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)

Optional. The list of user defined attributes associated with the deployment 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 = 13 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
key String
Returns
Type Description
AttributeValues

getCreateTime()

public abstract Timestamp getCreateTime()

Output only. The time at which the deployment 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 deployment was created.

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

Returns
Type Description
TimestampOrBuilder

getDeploymentType()

public abstract AttributeValues getDeploymentType()

Required. The type of deployment. This maps to the following system defined attribute: projects/{project}/locations/{location}/attributes/system-deployment-type 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 deployment_type = 5 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
AttributeValues

The deploymentType.

getDeploymentTypeOrBuilder()

public abstract AttributeValuesOrBuilder getDeploymentTypeOrBuilder()

Required. The type of deployment. This maps to the following system defined attribute: projects/{project}/locations/{location}/attributes/system-deployment-type 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 deployment_type = 5 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
AttributeValuesOrBuilder

getDescription()

public abstract String getDescription()

Optional. The description of the deployment.

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

Returns
Type Description
String

The description.

getDescriptionBytes()

public abstract ByteString getDescriptionBytes()

Optional. The description of the deployment.

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 deployment.

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 deployment.

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 deployment.

.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 deployment.

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

Returns
Type Description
DocumentationOrBuilder

getEndpoints(int index)

public abstract String getEndpoints(int index)

Required. The endpoints at which this deployment resource is listening for API requests. This could be a list of complete URIs, hostnames or an IP addresses.

repeated string endpoints = 7 [(.google.api.field_behavior) = REQUIRED];

Parameter
Name Description
index int

The index of the element to return.
Returns
Type Description
String

The endpoints at the given index.

getEndpointsBytes(int index)

public abstract ByteString getEndpointsBytes(int index)

Required. The endpoints at which this deployment resource is listening for API requests. This could be a list of complete URIs, hostnames or an IP addresses.

repeated string endpoints = 7 [(.google.api.field_behavior) = REQUIRED];

Parameter
Name Description
index int

The index of the value to return.
Returns
Type Description
ByteString

The bytes of the endpoints at the given index.

getEndpointsCount()

public abstract int getEndpointsCount()

Required. The endpoints at which this deployment resource is listening for API requests. This could be a list of complete URIs, hostnames or an IP addresses.

repeated string endpoints = 7 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
int

The count of endpoints.

getEndpointsList()

public abstract List<String> getEndpointsList()

Required. The endpoints at which this deployment resource is listening for API requests. This could be a list of complete URIs, hostnames or an IP addresses.

repeated string endpoints = 7 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
List<String>

A list containing the endpoints.

getEnvironment()

public abstract AttributeValues getEnvironment()

Optional. The environment mapping to this deployment. This maps to the following system defined attribute: projects/{project}/locations/{location}/attributes/system-environment 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 environment = 12 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
AttributeValues

The environment.

getEnvironmentOrBuilder()

public abstract AttributeValuesOrBuilder getEnvironmentOrBuilder()

Optional. The environment mapping to this deployment. This maps to the following system defined attribute: projects/{project}/locations/{location}/attributes/system-environment 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 environment = 12 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
AttributeValuesOrBuilder

getManagementUrl()

public abstract AttributeValues getManagementUrl()

Optional. The uri where users can navigate to for the management of the deployment. This maps to the following system defined attribute: projects/{project}/locations/{location}/attributes/system-management-url The number of values for this attribute will be based on the cardinality of the attribute. The same can be retrieved via GetAttribute API. The value of the attribute should be a valid URL.

.google.cloud.apihub.v1.AttributeValues management_url = 15 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
AttributeValues

The managementUrl.

getManagementUrlOrBuilder()

public abstract AttributeValuesOrBuilder getManagementUrlOrBuilder()

Optional. The uri where users can navigate to for the management of the deployment. This maps to the following system defined attribute: projects/{project}/locations/{location}/attributes/system-management-url The number of values for this attribute will be based on the cardinality of the attribute. The same can be retrieved via GetAttribute API. The value of the attribute should be a valid URL.

.google.cloud.apihub.v1.AttributeValues management_url = 15 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
AttributeValuesOrBuilder

getName()

public abstract String getName()

Identifier. The name of the deployment.

Format: projects/{project}/locations/{location}/deployments/{deployment}

string name = 1 [(.google.api.field_behavior) = IDENTIFIER];

Returns
Type Description
String

The name.

getNameBytes()

public abstract ByteString getNameBytes()

Identifier. The name of the deployment.

Format: projects/{project}/locations/{location}/deployments/{deployment}

string name = 1 [(.google.api.field_behavior) = IDENTIFIER];

Returns
Type Description
ByteString

The bytes for name.

getResourceUri()

public abstract String getResourceUri()

Required. The resource URI identifies the deployment within its gateway. For Apigee gateways, its recommended to use the format: organizations/{org}/environments/{env}/apis/{api}. For ex: if a proxy with name orders is deployed in staging environment of cymbal organization, the resource URI would be: organizations/cymbal/environments/staging/apis/orders.

string resource_uri = 6 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
String

The resourceUri.

getResourceUriBytes()

public abstract ByteString getResourceUriBytes()

Required. The resource URI identifies the deployment within its gateway. For Apigee gateways, its recommended to use the format: organizations/{org}/environments/{env}/apis/{api}. For ex: if a proxy with name orders is deployed in staging environment of cymbal organization, the resource URI would be: organizations/cymbal/environments/staging/apis/orders.

string resource_uri = 6 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
ByteString

The bytes for resourceUri.

getSlo()

public abstract AttributeValues getSlo()

Optional. The SLO for this deployment. This maps to the following system defined attribute: projects/{project}/locations/{location}/attributes/system-slo 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 slo = 11 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
AttributeValues

The slo.

getSloOrBuilder()

public abstract AttributeValuesOrBuilder getSloOrBuilder()

Optional. The SLO for this deployment. This maps to the following system defined attribute: projects/{project}/locations/{location}/attributes/system-slo 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 slo = 11 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
AttributeValuesOrBuilder

getSourceEnvironment()

public abstract String getSourceEnvironment()

Optional. The environment at source for the deployment. For example: prod, dev, staging, etc.

string source_environment = 18 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
String

The sourceEnvironment.

getSourceEnvironmentBytes()

public abstract ByteString getSourceEnvironmentBytes()

Optional. The environment at source for the deployment. For example: prod, dev, staging, etc.

string source_environment = 18 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
ByteString

The bytes for sourceEnvironment.

getSourceMetadata(int index)

public abstract SourceMetadata getSourceMetadata(int index)

Output only. The list of sources and metadata from the sources of the deployment.

repeated .google.cloud.apihub.v1.SourceMetadata source_metadata = 14 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
index int
Returns
Type Description
SourceMetadata

getSourceMetadataCount()

public abstract int getSourceMetadataCount()

Output only. The list of sources and metadata from the sources of the deployment.

repeated .google.cloud.apihub.v1.SourceMetadata source_metadata = 14 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
int

getSourceMetadataList()

public abstract List<SourceMetadata> getSourceMetadataList()

Output only. The list of sources and metadata from the sources of the deployment.

repeated .google.cloud.apihub.v1.SourceMetadata source_metadata = 14 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
List<SourceMetadata>

getSourceMetadataOrBuilder(int index)

public abstract SourceMetadataOrBuilder getSourceMetadataOrBuilder(int index)

Output only. The list of sources and metadata from the sources of the deployment.

repeated .google.cloud.apihub.v1.SourceMetadata source_metadata = 14 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
index int
Returns
Type Description
SourceMetadataOrBuilder

getSourceMetadataOrBuilderList()

public abstract List<? extends SourceMetadataOrBuilder> getSourceMetadataOrBuilderList()

Output only. The list of sources and metadata from the sources of the deployment.

repeated .google.cloud.apihub.v1.SourceMetadata source_metadata = 14 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
List<? extends com.google.cloud.apihub.v1.SourceMetadataOrBuilder>

getSourceProject()

public abstract String getSourceProject()

Optional. The project to which the deployment belongs. For GCP gateways, this will refer to the project identifier. For others like Edge/OPDK, this will refer to the org identifier.

string source_project = 17 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
String

The sourceProject.

getSourceProjectBytes()

public abstract ByteString getSourceProjectBytes()

Optional. The project to which the deployment belongs. For GCP gateways, this will refer to the project identifier. For others like Edge/OPDK, this will refer to the org identifier.

string source_project = 17 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
ByteString

The bytes for sourceProject.

getSourceUri()

public abstract AttributeValues getSourceUri()

Optional. The uri where additional source specific information for this deployment can be found. This maps to the following system defined attribute: projects/{project}/locations/{location}/attributes/system-source-uri The number of values for this attribute will be based on the cardinality of the attribute. The same can be retrieved via GetAttribute API. The value of the attribute should be a valid URI, and in case of Cloud Storage URI, it should point to a Cloud Storage object, not a directory.

.google.cloud.apihub.v1.AttributeValues source_uri = 16 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
AttributeValues

The sourceUri.

getSourceUriOrBuilder()

public abstract AttributeValuesOrBuilder getSourceUriOrBuilder()

Optional. The uri where additional source specific information for this deployment can be found. This maps to the following system defined attribute: projects/{project}/locations/{location}/attributes/system-source-uri The number of values for this attribute will be based on the cardinality of the attribute. The same can be retrieved via GetAttribute API. The value of the attribute should be a valid URI, and in case of Cloud Storage URI, it should point to a Cloud Storage object, not a directory.

.google.cloud.apihub.v1.AttributeValues source_uri = 16 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
AttributeValuesOrBuilder

getUpdateTime()

public abstract Timestamp getUpdateTime()

Output only. The time at which the deployment 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 deployment was last updated.

.google.protobuf.Timestamp update_time = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
TimestampOrBuilder

hasCreateTime()

public abstract boolean hasCreateTime()

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

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

Returns
Type Description
boolean

Whether the createTime field is set.

hasDeploymentType()

public abstract boolean hasDeploymentType()

Required. The type of deployment. This maps to the following system defined attribute: projects/{project}/locations/{location}/attributes/system-deployment-type 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 deployment_type = 5 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
boolean

Whether the deploymentType field is set.

hasDocumentation()

public abstract boolean hasDocumentation()

Optional. The documentation of the deployment.

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

Returns
Type Description
boolean

Whether the documentation field is set.

hasEnvironment()

public abstract boolean hasEnvironment()

Optional. The environment mapping to this deployment. This maps to the following system defined attribute: projects/{project}/locations/{location}/attributes/system-environment 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 environment = 12 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
boolean

Whether the environment field is set.

hasManagementUrl()

public abstract boolean hasManagementUrl()

Optional. The uri where users can navigate to for the management of the deployment. This maps to the following system defined attribute: projects/{project}/locations/{location}/attributes/system-management-url The number of values for this attribute will be based on the cardinality of the attribute. The same can be retrieved via GetAttribute API. The value of the attribute should be a valid URL.

.google.cloud.apihub.v1.AttributeValues management_url = 15 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
boolean

Whether the managementUrl field is set.

hasSlo()

public abstract boolean hasSlo()

Optional. The SLO for this deployment. This maps to the following system defined attribute: projects/{project}/locations/{location}/attributes/system-slo 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 slo = 11 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
boolean

Whether the slo field is set.

hasSourceUri()

public abstract boolean hasSourceUri()

Optional. The uri where additional source specific information for this deployment can be found. This maps to the following system defined attribute: projects/{project}/locations/{location}/attributes/system-source-uri The number of values for this attribute will be based on the cardinality of the attribute. The same can be retrieved via GetAttribute API. The value of the attribute should be a valid URI, and in case of Cloud Storage URI, it should point to a Cloud Storage object, not a directory.

.google.cloud.apihub.v1.AttributeValues source_uri = 16 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
boolean

Whether the sourceUri field is set.

hasUpdateTime()

public abstract boolean hasUpdateTime()

Output only. The time at which the deployment 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.