Class Deployment.Builder (0.28.0) 

public static final class Deployment.Builder extends GeneratedMessageV3.Builder<Deployment.Builder> implements DeploymentOrBuilder

Details of the deployment where APIs are hosted. A deployment could represent an Apigee proxy, API gateway, other Google Cloud services or non-Google Cloud services as well. A deployment entity is a root level entity in the API hub and exists independent of any API.

Protobuf type google.cloud.apihub.v1.Deployment

Inheritance

Object > AbstractMessageLite.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessageV3.Builder > Deployment.Builder

Implements

DeploymentOrBuilder

Static Methods

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
Type Description
Descriptor

Methods

addAllApiVersions(Iterable<String> values)

public Deployment.Builder addAllApiVersions(Iterable<String> values)

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
values Iterable<String>

The apiVersions to add.
Returns
Type Description
Deployment.Builder

This builder for chaining.

addAllEndpoints(Iterable<String> values)

public Deployment.Builder addAllEndpoints(Iterable<String> values)

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
values Iterable<String>

The endpoints to add.
Returns
Type Description
Deployment.Builder

This builder for chaining.

addAllSourceMetadata(Iterable<? extends SourceMetadata> values)

public Deployment.Builder addAllSourceMetadata(Iterable<? extends SourceMetadata> values)

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
values Iterable<? extends com.google.cloud.apihub.v1.SourceMetadata>
Returns
Type Description
Deployment.Builder

addApiVersions(String value)

public Deployment.Builder addApiVersions(String value)

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
value String

The apiVersions to add.
Returns
Type Description
Deployment.Builder

This builder for chaining.

addApiVersionsBytes(ByteString value)

public Deployment.Builder addApiVersionsBytes(ByteString value)

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
value ByteString

The bytes of the apiVersions to add.
Returns
Type Description
Deployment.Builder

This builder for chaining.

addEndpoints(String value)

public Deployment.Builder addEndpoints(String value)

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
value String

The endpoints to add.
Returns
Type Description
Deployment.Builder

This builder for chaining.

addEndpointsBytes(ByteString value)

public Deployment.Builder addEndpointsBytes(ByteString value)

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
value ByteString

The bytes of the endpoints to add.
Returns
Type Description
Deployment.Builder

This builder for chaining.

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public Deployment.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
Deployment.Builder
Overrides

addSourceMetadata(SourceMetadata value)

public Deployment.Builder addSourceMetadata(SourceMetadata value)

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
value SourceMetadata
Returns
Type Description
Deployment.Builder

addSourceMetadata(SourceMetadata.Builder builderForValue)

public Deployment.Builder addSourceMetadata(SourceMetadata.Builder builderForValue)

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
builderForValue SourceMetadata.Builder
Returns
Type Description
Deployment.Builder

addSourceMetadata(int index, SourceMetadata value)

public Deployment.Builder addSourceMetadata(int index, SourceMetadata value)

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

Parameters
Name Description
index int
value SourceMetadata
Returns
Type Description
Deployment.Builder

addSourceMetadata(int index, SourceMetadata.Builder builderForValue)

public Deployment.Builder addSourceMetadata(int index, SourceMetadata.Builder builderForValue)

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

Parameters
Name Description
index int
builderForValue SourceMetadata.Builder
Returns
Type Description
Deployment.Builder

addSourceMetadataBuilder()

public SourceMetadata.Builder addSourceMetadataBuilder()

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
SourceMetadata.Builder

addSourceMetadataBuilder(int index)

public SourceMetadata.Builder addSourceMetadataBuilder(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.Builder

build()

public Deployment build()
Returns
Type Description
Deployment

buildPartial()

public Deployment buildPartial()
Returns
Type Description
Deployment

clear()

public Deployment.Builder clear()
Returns
Type Description
Deployment.Builder
Overrides

clearApiVersions()

public Deployment.Builder clearApiVersions()

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
Deployment.Builder

This builder for chaining.

clearAttributes()

public Deployment.Builder clearAttributes()
Returns
Type Description
Deployment.Builder

clearCreateTime()

public Deployment.Builder clearCreateTime()

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
Deployment.Builder

clearDeploymentType()

public Deployment.Builder clearDeploymentType()

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
Deployment.Builder

clearDescription()

public Deployment.Builder clearDescription()

Optional. The description of the deployment.

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

Returns
Type Description
Deployment.Builder

This builder for chaining.

clearDisplayName()

public Deployment.Builder clearDisplayName()

Required. The display name of the deployment.

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

Returns
Type Description
Deployment.Builder

This builder for chaining.

clearDocumentation()

public Deployment.Builder clearDocumentation()

Optional. The documentation of the deployment.

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

Returns
Type Description
Deployment.Builder

clearEndpoints()

public Deployment.Builder clearEndpoints()

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
Deployment.Builder

This builder for chaining.

clearEnvironment()

public Deployment.Builder clearEnvironment()

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
Deployment.Builder

clearField(Descriptors.FieldDescriptor field)

public Deployment.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
Name Description
field FieldDescriptor
Returns
Type Description
Deployment.Builder
Overrides

clearManagementUrl()

public Deployment.Builder clearManagementUrl()

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
Deployment.Builder

clearName()

public Deployment.Builder clearName()

Identifier. The name of the deployment.

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

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

Returns
Type Description
Deployment.Builder

This builder for chaining.

clearOneof(Descriptors.OneofDescriptor oneof)

public Deployment.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
Name Description
oneof OneofDescriptor
Returns
Type Description
Deployment.Builder
Overrides

clearResourceUri()

public Deployment.Builder clearResourceUri()

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
Deployment.Builder

This builder for chaining.

clearSlo()

public Deployment.Builder clearSlo()

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
Deployment.Builder

clearSourceEnvironment()

public Deployment.Builder clearSourceEnvironment()

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
Deployment.Builder

This builder for chaining.

clearSourceMetadata()

public Deployment.Builder clearSourceMetadata()

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
Deployment.Builder

clearSourceProject()

public Deployment.Builder clearSourceProject()

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
Deployment.Builder

This builder for chaining.

clearSourceUri()

public Deployment.Builder clearSourceUri()

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
Deployment.Builder

clearUpdateTime()

public Deployment.Builder clearUpdateTime()

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
Deployment.Builder

clone()

public Deployment.Builder clone()
Returns
Type Description
Deployment.Builder
Overrides

containsAttributes(String key)

public 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 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 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 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 ProtocolStringList 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
ProtocolStringList

A list containing the apiVersions.

getAttributes() (deprecated)

public Map<String,AttributeValues> getAttributes()

Use #getAttributesMap() instead.

Returns
Type Description
Map<String,AttributeValues>

getAttributesCount()

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

getCreateTimeBuilder()

public Timestamp.Builder getCreateTimeBuilder()

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
Builder

getCreateTimeOrBuilder()

public 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

getDefaultInstanceForType()

public Deployment getDefaultInstanceForType()
Returns
Type Description
Deployment

getDeploymentType()

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

getDeploymentTypeBuilder()

public AttributeValues.Builder getDeploymentTypeBuilder()

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

getDeploymentTypeOrBuilder()

public 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 String getDescription()

Optional. The description of the deployment.

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

Returns
Type Description
String

The description.

getDescriptionBytes()

public ByteString getDescriptionBytes()

Optional. The description of the deployment.

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

Returns
Type Description
ByteString

The bytes for description.

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
Type Description
Descriptor
Overrides

getDisplayName()

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

getDocumentationBuilder()

public Documentation.Builder getDocumentationBuilder()

Optional. The documentation of the deployment.

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

Returns
Type Description
Documentation.Builder

getDocumentationOrBuilder()

public 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 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 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 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 ProtocolStringList 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
ProtocolStringList

A list containing the endpoints.

getEnvironment()

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

getEnvironmentBuilder()

public AttributeValues.Builder getEnvironmentBuilder()

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

getEnvironmentOrBuilder()

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

getManagementUrlBuilder()

public AttributeValues.Builder getManagementUrlBuilder()

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

getManagementUrlOrBuilder()

public 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

getMutableAttributes() (deprecated)

public Map<String,AttributeValues> getMutableAttributes()

Use alternate mutation accessors instead.

Returns
Type Description
Map<String,AttributeValues>

getName()

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

getSloBuilder()

public AttributeValues.Builder getSloBuilder()

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

getSloOrBuilder()

public 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 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 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 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

getSourceMetadataBuilder(int index)

public SourceMetadata.Builder getSourceMetadataBuilder(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.Builder

getSourceMetadataBuilderList()

public List<SourceMetadata.Builder> getSourceMetadataBuilderList()

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<Builder>

getSourceMetadataCount()

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

getSourceUriBuilder()

public AttributeValues.Builder getSourceUriBuilder()

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

getSourceUriOrBuilder()

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

getUpdateTimeBuilder()

public Timestamp.Builder getUpdateTimeBuilder()

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
Builder

getUpdateTimeOrBuilder()

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

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

internalGetMapFieldReflection(int number)

protected MapFieldReflectionAccessor internalGetMapFieldReflection(int number)
Parameter
Name Description
number int
Returns
Type Description
com.google.protobuf.MapFieldReflectionAccessor
Overrides
com.google.protobuf.GeneratedMessageV3.Builder.internalGetMapFieldReflection(int)

internalGetMutableMapFieldReflection(int number)

protected MapFieldReflectionAccessor internalGetMutableMapFieldReflection(int number)
Parameter
Name Description
number int
Returns
Type Description
com.google.protobuf.MapFieldReflectionAccessor
Overrides
com.google.protobuf.GeneratedMessageV3.Builder.internalGetMutableMapFieldReflection(int)

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

mergeCreateTime(Timestamp value)

public Deployment.Builder mergeCreateTime(Timestamp value)

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

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

Parameter
Name Description
value Timestamp
Returns
Type Description
Deployment.Builder

mergeDeploymentType(AttributeValues value)

public Deployment.Builder mergeDeploymentType(AttributeValues value)

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

Parameter
Name Description
value AttributeValues
Returns
Type Description
Deployment.Builder

mergeDocumentation(Documentation value)

public Deployment.Builder mergeDocumentation(Documentation value)

Optional. The documentation of the deployment.

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

Parameter
Name Description
value Documentation
Returns
Type Description
Deployment.Builder

mergeEnvironment(AttributeValues value)

public Deployment.Builder mergeEnvironment(AttributeValues value)

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

Parameter
Name Description
value AttributeValues
Returns
Type Description
Deployment.Builder

mergeFrom(Deployment other)

public Deployment.Builder mergeFrom(Deployment other)
Parameter
Name Description
other Deployment
Returns
Type Description
Deployment.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public Deployment.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Deployment.Builder
Overrides
Exceptions
Type Description
IOException

mergeFrom(Message other)

public Deployment.Builder mergeFrom(Message other)
Parameter
Name Description
other Message
Returns
Type Description
Deployment.Builder
Overrides

mergeManagementUrl(AttributeValues value)

public Deployment.Builder mergeManagementUrl(AttributeValues value)

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

Parameter
Name Description
value AttributeValues
Returns
Type Description
Deployment.Builder

mergeSlo(AttributeValues value)

public Deployment.Builder mergeSlo(AttributeValues value)

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

Parameter
Name Description
value AttributeValues
Returns
Type Description
Deployment.Builder

mergeSourceUri(AttributeValues value)

public Deployment.Builder mergeSourceUri(AttributeValues value)

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

Parameter
Name Description
value AttributeValues
Returns
Type Description
Deployment.Builder

mergeUnknownFields(UnknownFieldSet unknownFields)

public final Deployment.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
Deployment.Builder
Overrides

mergeUpdateTime(Timestamp value)

public Deployment.Builder mergeUpdateTime(Timestamp value)

Output only. The time at which the deployment was last updated.

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

Parameter
Name Description
value Timestamp
Returns
Type Description
Deployment.Builder

putAllAttributes(Map<String,AttributeValues> values)

public Deployment.Builder putAllAttributes(Map<String,AttributeValues> values)

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
values Map<String,AttributeValues>
Returns
Type Description
Deployment.Builder

putAttributes(String key, AttributeValues value)

public Deployment.Builder putAttributes(String key, AttributeValues value)

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
value AttributeValues
Returns
Type Description
Deployment.Builder

putAttributesBuilderIfAbsent(String key)

public AttributeValues.Builder putAttributesBuilderIfAbsent(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.Builder

removeAttributes(String key)

public Deployment.Builder removeAttributes(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
Deployment.Builder

removeSourceMetadata(int index)

public Deployment.Builder removeSourceMetadata(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
Deployment.Builder

setApiVersions(int index, String value)

public Deployment.Builder setApiVersions(int index, String value)

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

Parameters
Name Description
index int

The index to set the value at.
value String

The apiVersions to set.
Returns
Type Description
Deployment.Builder

This builder for chaining.

setCreateTime(Timestamp value)

public Deployment.Builder setCreateTime(Timestamp value)

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

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

Parameter
Name Description
value Timestamp
Returns
Type Description
Deployment.Builder

setCreateTime(Timestamp.Builder builderForValue)

public Deployment.Builder setCreateTime(Timestamp.Builder builderForValue)

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

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

Parameter
Name Description
builderForValue Builder
Returns
Type Description
Deployment.Builder

setDeploymentType(AttributeValues value)

public Deployment.Builder setDeploymentType(AttributeValues value)

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

Parameter
Name Description
value AttributeValues
Returns
Type Description
Deployment.Builder

setDeploymentType(AttributeValues.Builder builderForValue)

public Deployment.Builder setDeploymentType(AttributeValues.Builder builderForValue)

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

Parameter
Name Description
builderForValue AttributeValues.Builder
Returns
Type Description
Deployment.Builder

setDescription(String value)

public Deployment.Builder setDescription(String value)

Optional. The description of the deployment.

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

Parameter
Name Description
value String

The description to set.
Returns
Type Description
Deployment.Builder

This builder for chaining.

setDescriptionBytes(ByteString value)

public Deployment.Builder setDescriptionBytes(ByteString value)

Optional. The description of the deployment.

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

Parameter
Name Description
value ByteString

The bytes for description to set.
Returns
Type Description
Deployment.Builder

This builder for chaining.

setDisplayName(String value)

public Deployment.Builder setDisplayName(String value)

Required. The display name of the deployment.

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

Parameter
Name Description
value String

The displayName to set.
Returns
Type Description
Deployment.Builder

This builder for chaining.

setDisplayNameBytes(ByteString value)

public Deployment.Builder setDisplayNameBytes(ByteString value)

Required. The display name of the deployment.

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

Parameter
Name Description
value ByteString

The bytes for displayName to set.
Returns
Type Description
Deployment.Builder

This builder for chaining.

setDocumentation(Documentation value)

public Deployment.Builder setDocumentation(Documentation value)

Optional. The documentation of the deployment.

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

Parameter
Name Description
value Documentation
Returns
Type Description
Deployment.Builder

setDocumentation(Documentation.Builder builderForValue)

public Deployment.Builder setDocumentation(Documentation.Builder builderForValue)

Optional. The documentation of the deployment.

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

Parameter
Name Description
builderForValue Documentation.Builder
Returns
Type Description
Deployment.Builder

setEndpoints(int index, String value)

public Deployment.Builder setEndpoints(int index, String value)

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

Parameters
Name Description
index int

The index to set the value at.
value String

The endpoints to set.
Returns
Type Description
Deployment.Builder

This builder for chaining.

setEnvironment(AttributeValues value)

public Deployment.Builder setEnvironment(AttributeValues value)

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

Parameter
Name Description
value AttributeValues
Returns
Type Description
Deployment.Builder

setEnvironment(AttributeValues.Builder builderForValue)

public Deployment.Builder setEnvironment(AttributeValues.Builder builderForValue)

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

Parameter
Name Description
builderForValue AttributeValues.Builder
Returns
Type Description
Deployment.Builder

setField(Descriptors.FieldDescriptor field, Object value)

public Deployment.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
Deployment.Builder
Overrides

setManagementUrl(AttributeValues value)

public Deployment.Builder setManagementUrl(AttributeValues value)

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

Parameter
Name Description
value AttributeValues
Returns
Type Description
Deployment.Builder

setManagementUrl(AttributeValues.Builder builderForValue)

public Deployment.Builder setManagementUrl(AttributeValues.Builder builderForValue)

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

Parameter
Name Description
builderForValue AttributeValues.Builder
Returns
Type Description
Deployment.Builder

setName(String value)

public Deployment.Builder setName(String value)

Identifier. The name of the deployment.

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

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

Parameter
Name Description
value String

The name to set.
Returns
Type Description
Deployment.Builder

This builder for chaining.

setNameBytes(ByteString value)

public Deployment.Builder setNameBytes(ByteString value)

Identifier. The name of the deployment.

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

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

Parameter
Name Description
value ByteString

The bytes for name to set.
Returns
Type Description
Deployment.Builder

This builder for chaining.

setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

public Deployment.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Parameters
Name Description
field FieldDescriptor
index int
value Object
Returns
Type Description
Deployment.Builder
Overrides

setResourceUri(String value)

public Deployment.Builder setResourceUri(String value)

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

Parameter
Name Description
value String

The resourceUri to set.
Returns
Type Description
Deployment.Builder

This builder for chaining.

setResourceUriBytes(ByteString value)

public Deployment.Builder setResourceUriBytes(ByteString value)

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

Parameter
Name Description
value ByteString

The bytes for resourceUri to set.
Returns
Type Description
Deployment.Builder

This builder for chaining.

setSlo(AttributeValues value)

public Deployment.Builder setSlo(AttributeValues value)

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

Parameter
Name Description
value AttributeValues
Returns
Type Description
Deployment.Builder

setSlo(AttributeValues.Builder builderForValue)

public Deployment.Builder setSlo(AttributeValues.Builder builderForValue)

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

Parameter
Name Description
builderForValue AttributeValues.Builder
Returns
Type Description
Deployment.Builder

setSourceEnvironment(String value)

public Deployment.Builder setSourceEnvironment(String value)

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

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

Parameter
Name Description
value String

The sourceEnvironment to set.
Returns
Type Description
Deployment.Builder

This builder for chaining.

setSourceEnvironmentBytes(ByteString value)

public Deployment.Builder setSourceEnvironmentBytes(ByteString value)

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

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

Parameter
Name Description
value ByteString

The bytes for sourceEnvironment to set.
Returns
Type Description
Deployment.Builder

This builder for chaining.

setSourceMetadata(int index, SourceMetadata value)

public Deployment.Builder setSourceMetadata(int index, SourceMetadata value)

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

Parameters
Name Description
index int
value SourceMetadata
Returns
Type Description
Deployment.Builder

setSourceMetadata(int index, SourceMetadata.Builder builderForValue)

public Deployment.Builder setSourceMetadata(int index, SourceMetadata.Builder builderForValue)

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

Parameters
Name Description
index int
builderForValue SourceMetadata.Builder
Returns
Type Description
Deployment.Builder

setSourceProject(String value)

public Deployment.Builder setSourceProject(String value)

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

Parameter
Name Description
value String

The sourceProject to set.
Returns
Type Description
Deployment.Builder

This builder for chaining.

setSourceProjectBytes(ByteString value)

public Deployment.Builder setSourceProjectBytes(ByteString value)

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

Parameter
Name Description
value ByteString

The bytes for sourceProject to set.
Returns
Type Description
Deployment.Builder

This builder for chaining.

setSourceUri(AttributeValues value)

public Deployment.Builder setSourceUri(AttributeValues value)

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

Parameter
Name Description
value AttributeValues
Returns
Type Description
Deployment.Builder

setSourceUri(AttributeValues.Builder builderForValue)

public Deployment.Builder setSourceUri(AttributeValues.Builder builderForValue)

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

Parameter
Name Description
builderForValue AttributeValues.Builder
Returns
Type Description
Deployment.Builder

setUnknownFields(UnknownFieldSet unknownFields)

public final Deployment.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
Deployment.Builder
Overrides

setUpdateTime(Timestamp value)

public Deployment.Builder setUpdateTime(Timestamp value)

Output only. The time at which the deployment was last updated.

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

Parameter
Name Description
value Timestamp
Returns
Type Description
Deployment.Builder

setUpdateTime(Timestamp.Builder builderForValue)

public Deployment.Builder setUpdateTime(Timestamp.Builder builderForValue)

Output only. The time at which the deployment was last updated.

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

Parameter
Name Description
builderForValue Builder
Returns
Type Description
Deployment.Builder