Class ApiDeployment.Builder (0.53.0) 

public static final class ApiDeployment.Builder extends GeneratedMessageV3.Builder<ApiDeployment.Builder> implements ApiDeploymentOrBuilder

Describes a service running at particular address that provides a particular version of an API. ApiDeployments have revisions which correspond to different configurations of a single deployment in time. Revision identifiers should be updated whenever the served API spec or endpoint address changes.

Protobuf type google.cloud.apigeeregistry.v1.ApiDeployment

Inheritance

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

Static Methods

getDescriptor()

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

Methods

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

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

build()

public ApiDeployment build()
Returns
Type Description
ApiDeployment

buildPartial()

public ApiDeployment buildPartial()
Returns
Type Description
ApiDeployment

clear()

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

clearAccessGuidance()

public ApiDeployment.Builder clearAccessGuidance()

Text briefly describing how to access the endpoint. Changes to this value will not affect the revision.

string access_guidance = 12;

Returns
Type Description
ApiDeployment.Builder

This builder for chaining.

clearAnnotations()

public ApiDeployment.Builder clearAnnotations()
Returns
Type Description
ApiDeployment.Builder

clearApiSpecRevision()

public ApiDeployment.Builder clearApiSpecRevision()

The full resource name (including revision ID) of the spec of the API being served by the deployment. Changes to this value will update the revision. Format: apis/{api}/deployments/{deployment}

string api_spec_revision = 8 [(.google.api.resource_reference) = { ... }

Returns
Type Description
ApiDeployment.Builder

This builder for chaining.

clearCreateTime()

public ApiDeployment.Builder clearCreateTime()

Output only. Creation timestamp; when the deployment resource was created.

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

Returns
Type Description
ApiDeployment.Builder

clearDescription()

public ApiDeployment.Builder clearDescription()

A detailed description.

string description = 3;

Returns
Type Description
ApiDeployment.Builder

This builder for chaining.

clearDisplayName()

public ApiDeployment.Builder clearDisplayName()

Human-meaningful name.

string display_name = 2;

Returns
Type Description
ApiDeployment.Builder

This builder for chaining.

clearEndpointUri()

public ApiDeployment.Builder clearEndpointUri()

The address where the deployment is serving. Changes to this value will update the revision.

string endpoint_uri = 9;

Returns
Type Description
ApiDeployment.Builder

This builder for chaining.

clearExternalChannelUri()

public ApiDeployment.Builder clearExternalChannelUri()

The address of the external channel of the API (e.g., the Developer Portal). Changes to this value will not affect the revision.

string external_channel_uri = 10;

Returns
Type Description
ApiDeployment.Builder

This builder for chaining.

clearField(Descriptors.FieldDescriptor field)

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

clearIntendedAudience()

public ApiDeployment.Builder clearIntendedAudience()

Text briefly identifying the intended audience of the API. Changes to this value will not affect the revision.

string intended_audience = 11;

Returns
Type Description
ApiDeployment.Builder

This builder for chaining.

clearLabels()

public ApiDeployment.Builder clearLabels()
Returns
Type Description
ApiDeployment.Builder

clearName()

public ApiDeployment.Builder clearName()

Resource name.

string name = 1;

Returns
Type Description
ApiDeployment.Builder

This builder for chaining.

clearOneof(Descriptors.OneofDescriptor oneof)

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

clearRevisionCreateTime()

public ApiDeployment.Builder clearRevisionCreateTime()

Output only. Revision creation timestamp; when the represented revision was created.

.google.protobuf.Timestamp revision_create_time = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
ApiDeployment.Builder

clearRevisionId()

public ApiDeployment.Builder clearRevisionId()

Output only. Immutable. The revision ID of the deployment. A new revision is committed whenever the deployment contents are changed. The format is an 8-character hexadecimal string.

string revision_id = 4 [(.google.api.field_behavior) = IMMUTABLE, (.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
ApiDeployment.Builder

This builder for chaining.

clearRevisionUpdateTime()

public ApiDeployment.Builder clearRevisionUpdateTime()

Output only. Last update timestamp: when the represented revision was last modified.

.google.protobuf.Timestamp revision_update_time = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
ApiDeployment.Builder

clone()

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

containsAnnotations(String key)

public boolean containsAnnotations(String key)

Annotations attach non-identifying metadata to resources.

Annotation keys and values are less restricted than those of labels, but should be generally used for small values of broad interest. Larger, topic- specific metadata should be stored in Artifacts.

map<string, string> annotations = 15;

Parameter
Name Description
key String
Returns
Type Description
boolean

containsLabels(String key)

public boolean containsLabels(String key)

Labels attach identifying metadata to resources. Identifying metadata can be used to filter list operations.

Label keys and values can be no longer than 64 characters (Unicode codepoints), can only contain lowercase letters, numeric characters, underscores and dashes. International characters are allowed. No more than 64 user labels can be associated with one resource (System labels are excluded).

See https://goo.gl/xmQnxf for more information and examples of labels. System reserved label keys are prefixed with apigeeregistry.googleapis.com/ and cannot be changed.

map<string, string> labels = 14;

Parameter
Name Description
key String
Returns
Type Description
boolean

getAccessGuidance()

public String getAccessGuidance()

Text briefly describing how to access the endpoint. Changes to this value will not affect the revision.

string access_guidance = 12;

Returns
Type Description
String

The accessGuidance.

getAccessGuidanceBytes()

public ByteString getAccessGuidanceBytes()

Text briefly describing how to access the endpoint. Changes to this value will not affect the revision.

string access_guidance = 12;

Returns
Type Description
ByteString

The bytes for accessGuidance.

getAnnotations() (deprecated)

public Map<String,String> getAnnotations()

Use #getAnnotationsMap() instead.

Returns
Type Description
Map<String,String>

getAnnotationsCount()

public int getAnnotationsCount()

Annotations attach non-identifying metadata to resources.

Annotation keys and values are less restricted than those of labels, but should be generally used for small values of broad interest. Larger, topic- specific metadata should be stored in Artifacts.

map<string, string> annotations = 15;

Returns
Type Description
int

getAnnotationsMap()

public Map<String,String> getAnnotationsMap()

Annotations attach non-identifying metadata to resources.

Annotation keys and values are less restricted than those of labels, but should be generally used for small values of broad interest. Larger, topic- specific metadata should be stored in Artifacts.

map<string, string> annotations = 15;

Returns
Type Description
Map<String,String>

getAnnotationsOrDefault(String key, String defaultValue)

public String getAnnotationsOrDefault(String key, String defaultValue)

Annotations attach non-identifying metadata to resources.

Annotation keys and values are less restricted than those of labels, but should be generally used for small values of broad interest. Larger, topic- specific metadata should be stored in Artifacts.

map<string, string> annotations = 15;

Parameters
Name Description
key String
defaultValue String
Returns
Type Description
String

getAnnotationsOrThrow(String key)

public String getAnnotationsOrThrow(String key)

Annotations attach non-identifying metadata to resources.

Annotation keys and values are less restricted than those of labels, but should be generally used for small values of broad interest. Larger, topic- specific metadata should be stored in Artifacts.

map<string, string> annotations = 15;

Parameter
Name Description
key String
Returns
Type Description
String

getApiSpecRevision()

public String getApiSpecRevision()

The full resource name (including revision ID) of the spec of the API being served by the deployment. Changes to this value will update the revision. Format: apis/{api}/deployments/{deployment}

string api_spec_revision = 8 [(.google.api.resource_reference) = { ... }

Returns
Type Description
String

The apiSpecRevision.

getApiSpecRevisionBytes()

public ByteString getApiSpecRevisionBytes()

The full resource name (including revision ID) of the spec of the API being served by the deployment. Changes to this value will update the revision. Format: apis/{api}/deployments/{deployment}

string api_spec_revision = 8 [(.google.api.resource_reference) = { ... }

Returns
Type Description
ByteString

The bytes for apiSpecRevision.

getCreateTime()

public Timestamp getCreateTime()

Output only. Creation timestamp; when the deployment resource was created.

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

Returns
Type Description
Timestamp

The createTime.

getCreateTimeBuilder()

public Timestamp.Builder getCreateTimeBuilder()

Output only. Creation timestamp; when the deployment resource was created.

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

Returns
Type Description
Builder

getCreateTimeOrBuilder()

public TimestampOrBuilder getCreateTimeOrBuilder()

Output only. Creation timestamp; when the deployment resource was created.

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

Returns
Type Description
TimestampOrBuilder

getDefaultInstanceForType()

public ApiDeployment getDefaultInstanceForType()
Returns
Type Description
ApiDeployment

getDescription()

public String getDescription()

A detailed description.

string description = 3;

Returns
Type Description
String

The description.

getDescriptionBytes()

public ByteString getDescriptionBytes()

A detailed description.

string description = 3;

Returns
Type Description
ByteString

The bytes for description.

getDescriptorForType()

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

getDisplayName()

public String getDisplayName()

Human-meaningful name.

string display_name = 2;

Returns
Type Description
String

The displayName.

getDisplayNameBytes()

public ByteString getDisplayNameBytes()

Human-meaningful name.

string display_name = 2;

Returns
Type Description
ByteString

The bytes for displayName.

getEndpointUri()

public String getEndpointUri()

The address where the deployment is serving. Changes to this value will update the revision.

string endpoint_uri = 9;

Returns
Type Description
String

The endpointUri.

getEndpointUriBytes()

public ByteString getEndpointUriBytes()

The address where the deployment is serving. Changes to this value will update the revision.

string endpoint_uri = 9;

Returns
Type Description
ByteString

The bytes for endpointUri.

getExternalChannelUri()

public String getExternalChannelUri()

The address of the external channel of the API (e.g., the Developer Portal). Changes to this value will not affect the revision.

string external_channel_uri = 10;

Returns
Type Description
String

The externalChannelUri.

getExternalChannelUriBytes()

public ByteString getExternalChannelUriBytes()

The address of the external channel of the API (e.g., the Developer Portal). Changes to this value will not affect the revision.

string external_channel_uri = 10;

Returns
Type Description
ByteString

The bytes for externalChannelUri.

getIntendedAudience()

public String getIntendedAudience()

Text briefly identifying the intended audience of the API. Changes to this value will not affect the revision.

string intended_audience = 11;

Returns
Type Description
String

The intendedAudience.

getIntendedAudienceBytes()

public ByteString getIntendedAudienceBytes()

Text briefly identifying the intended audience of the API. Changes to this value will not affect the revision.

string intended_audience = 11;

Returns
Type Description
ByteString

The bytes for intendedAudience.

getLabels() (deprecated)

public Map<String,String> getLabels()

Use #getLabelsMap() instead.

Returns
Type Description
Map<String,String>

getLabelsCount()

public int getLabelsCount()

Labels attach identifying metadata to resources. Identifying metadata can be used to filter list operations.

Label keys and values can be no longer than 64 characters (Unicode codepoints), can only contain lowercase letters, numeric characters, underscores and dashes. International characters are allowed. No more than 64 user labels can be associated with one resource (System labels are excluded).

See https://goo.gl/xmQnxf for more information and examples of labels. System reserved label keys are prefixed with apigeeregistry.googleapis.com/ and cannot be changed.

map<string, string> labels = 14;

Returns
Type Description
int

getLabelsMap()

public Map<String,String> getLabelsMap()

Labels attach identifying metadata to resources. Identifying metadata can be used to filter list operations.

Label keys and values can be no longer than 64 characters (Unicode codepoints), can only contain lowercase letters, numeric characters, underscores and dashes. International characters are allowed. No more than 64 user labels can be associated with one resource (System labels are excluded).

See https://goo.gl/xmQnxf for more information and examples of labels. System reserved label keys are prefixed with apigeeregistry.googleapis.com/ and cannot be changed.

map<string, string> labels = 14;

Returns
Type Description
Map<String,String>

getLabelsOrDefault(String key, String defaultValue)

public String getLabelsOrDefault(String key, String defaultValue)

Labels attach identifying metadata to resources. Identifying metadata can be used to filter list operations.

Label keys and values can be no longer than 64 characters (Unicode codepoints), can only contain lowercase letters, numeric characters, underscores and dashes. International characters are allowed. No more than 64 user labels can be associated with one resource (System labels are excluded).

See https://goo.gl/xmQnxf for more information and examples of labels. System reserved label keys are prefixed with apigeeregistry.googleapis.com/ and cannot be changed.

map<string, string> labels = 14;

Parameters
Name Description
key String
defaultValue String
Returns
Type Description
String

getLabelsOrThrow(String key)

public String getLabelsOrThrow(String key)

Labels attach identifying metadata to resources. Identifying metadata can be used to filter list operations.

Label keys and values can be no longer than 64 characters (Unicode codepoints), can only contain lowercase letters, numeric characters, underscores and dashes. International characters are allowed. No more than 64 user labels can be associated with one resource (System labels are excluded).

See https://goo.gl/xmQnxf for more information and examples of labels. System reserved label keys are prefixed with apigeeregistry.googleapis.com/ and cannot be changed.

map<string, string> labels = 14;

Parameter
Name Description
key String
Returns
Type Description
String

getMutableAnnotations() (deprecated)

public Map<String,String> getMutableAnnotations()

Use alternate mutation accessors instead.

Returns
Type Description
Map<String,String>

getMutableLabels() (deprecated)

public Map<String,String> getMutableLabels()

Use alternate mutation accessors instead.

Returns
Type Description
Map<String,String>

getName()

public String getName()

Resource name.

string name = 1;

Returns
Type Description
String

The name.

getNameBytes()

public ByteString getNameBytes()

Resource name.

string name = 1;

Returns
Type Description
ByteString

The bytes for name.

getRevisionCreateTime()

public Timestamp getRevisionCreateTime()

Output only. Revision creation timestamp; when the represented revision was created.

.google.protobuf.Timestamp revision_create_time = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
Timestamp

The revisionCreateTime.

getRevisionCreateTimeBuilder()

public Timestamp.Builder getRevisionCreateTimeBuilder()

Output only. Revision creation timestamp; when the represented revision was created.

.google.protobuf.Timestamp revision_create_time = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
Builder

getRevisionCreateTimeOrBuilder()

public TimestampOrBuilder getRevisionCreateTimeOrBuilder()

Output only. Revision creation timestamp; when the represented revision was created.

.google.protobuf.Timestamp revision_create_time = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
TimestampOrBuilder

getRevisionId()

public String getRevisionId()

Output only. Immutable. The revision ID of the deployment. A new revision is committed whenever the deployment contents are changed. The format is an 8-character hexadecimal string.

string revision_id = 4 [(.google.api.field_behavior) = IMMUTABLE, (.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
String

The revisionId.

getRevisionIdBytes()

public ByteString getRevisionIdBytes()

Output only. Immutable. The revision ID of the deployment. A new revision is committed whenever the deployment contents are changed. The format is an 8-character hexadecimal string.

string revision_id = 4 [(.google.api.field_behavior) = IMMUTABLE, (.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
ByteString

The bytes for revisionId.

getRevisionUpdateTime()

public Timestamp getRevisionUpdateTime()

Output only. Last update timestamp: when the represented revision was last modified.

.google.protobuf.Timestamp revision_update_time = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
Timestamp

The revisionUpdateTime.

getRevisionUpdateTimeBuilder()

public Timestamp.Builder getRevisionUpdateTimeBuilder()

Output only. Last update timestamp: when the represented revision was last modified.

.google.protobuf.Timestamp revision_update_time = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
Builder

getRevisionUpdateTimeOrBuilder()

public TimestampOrBuilder getRevisionUpdateTimeOrBuilder()

Output only. Last update timestamp: when the represented revision was last modified.

.google.protobuf.Timestamp revision_update_time = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
TimestampOrBuilder

hasCreateTime()

public boolean hasCreateTime()

Output only. Creation timestamp; when the deployment resource was created.

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

Returns
Type Description
boolean

Whether the createTime field is set.

hasRevisionCreateTime()

public boolean hasRevisionCreateTime()

Output only. Revision creation timestamp; when the represented revision was created.

.google.protobuf.Timestamp revision_create_time = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
boolean

Whether the revisionCreateTime field is set.

hasRevisionUpdateTime()

public boolean hasRevisionUpdateTime()

Output only. Last update timestamp: when the represented revision was last modified.

.google.protobuf.Timestamp revision_update_time = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
boolean

Whether the revisionUpdateTime 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 ApiDeployment.Builder mergeCreateTime(Timestamp value)

Output only. Creation timestamp; when the deployment resource was created.

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

Parameter
Name Description
value Timestamp
Returns
Type Description
ApiDeployment.Builder

mergeFrom(ApiDeployment other)

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

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

mergeFrom(Message other)

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

mergeRevisionCreateTime(Timestamp value)

public ApiDeployment.Builder mergeRevisionCreateTime(Timestamp value)

Output only. Revision creation timestamp; when the represented revision was created.

.google.protobuf.Timestamp revision_create_time = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
value Timestamp
Returns
Type Description
ApiDeployment.Builder

mergeRevisionUpdateTime(Timestamp value)

public ApiDeployment.Builder mergeRevisionUpdateTime(Timestamp value)

Output only. Last update timestamp: when the represented revision was last modified.

.google.protobuf.Timestamp revision_update_time = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
value Timestamp
Returns
Type Description
ApiDeployment.Builder

mergeUnknownFields(UnknownFieldSet unknownFields)

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

putAllAnnotations(Map<String,String> values)

public ApiDeployment.Builder putAllAnnotations(Map<String,String> values)

Annotations attach non-identifying metadata to resources.

Annotation keys and values are less restricted than those of labels, but should be generally used for small values of broad interest. Larger, topic- specific metadata should be stored in Artifacts.

map<string, string> annotations = 15;

Parameter
Name Description
values Map<String,String>
Returns
Type Description
ApiDeployment.Builder

putAllLabels(Map<String,String> values)

public ApiDeployment.Builder putAllLabels(Map<String,String> values)

Labels attach identifying metadata to resources. Identifying metadata can be used to filter list operations.

Label keys and values can be no longer than 64 characters (Unicode codepoints), can only contain lowercase letters, numeric characters, underscores and dashes. International characters are allowed. No more than 64 user labels can be associated with one resource (System labels are excluded).

See https://goo.gl/xmQnxf for more information and examples of labels. System reserved label keys are prefixed with apigeeregistry.googleapis.com/ and cannot be changed.

map<string, string> labels = 14;

Parameter
Name Description
values Map<String,String>
Returns
Type Description
ApiDeployment.Builder

putAnnotations(String key, String value)

public ApiDeployment.Builder putAnnotations(String key, String value)

Annotations attach non-identifying metadata to resources.

Annotation keys and values are less restricted than those of labels, but should be generally used for small values of broad interest. Larger, topic- specific metadata should be stored in Artifacts.

map<string, string> annotations = 15;

Parameters
Name Description
key String
value String
Returns
Type Description
ApiDeployment.Builder

putLabels(String key, String value)

public ApiDeployment.Builder putLabels(String key, String value)

Labels attach identifying metadata to resources. Identifying metadata can be used to filter list operations.

Label keys and values can be no longer than 64 characters (Unicode codepoints), can only contain lowercase letters, numeric characters, underscores and dashes. International characters are allowed. No more than 64 user labels can be associated with one resource (System labels are excluded).

See https://goo.gl/xmQnxf for more information and examples of labels. System reserved label keys are prefixed with apigeeregistry.googleapis.com/ and cannot be changed.

map<string, string> labels = 14;

Parameters
Name Description
key String
value String
Returns
Type Description
ApiDeployment.Builder

removeAnnotations(String key)

public ApiDeployment.Builder removeAnnotations(String key)

Annotations attach non-identifying metadata to resources.

Annotation keys and values are less restricted than those of labels, but should be generally used for small values of broad interest. Larger, topic- specific metadata should be stored in Artifacts.

map<string, string> annotations = 15;

Parameter
Name Description
key String
Returns
Type Description
ApiDeployment.Builder

removeLabels(String key)

public ApiDeployment.Builder removeLabels(String key)

Labels attach identifying metadata to resources. Identifying metadata can be used to filter list operations.

Label keys and values can be no longer than 64 characters (Unicode codepoints), can only contain lowercase letters, numeric characters, underscores and dashes. International characters are allowed. No more than 64 user labels can be associated with one resource (System labels are excluded).

See https://goo.gl/xmQnxf for more information and examples of labels. System reserved label keys are prefixed with apigeeregistry.googleapis.com/ and cannot be changed.

map<string, string> labels = 14;

Parameter
Name Description
key String
Returns
Type Description
ApiDeployment.Builder

setAccessGuidance(String value)

public ApiDeployment.Builder setAccessGuidance(String value)

Text briefly describing how to access the endpoint. Changes to this value will not affect the revision.

string access_guidance = 12;

Parameter
Name Description
value String

The accessGuidance to set.
Returns
Type Description
ApiDeployment.Builder

This builder for chaining.

setAccessGuidanceBytes(ByteString value)

public ApiDeployment.Builder setAccessGuidanceBytes(ByteString value)

Text briefly describing how to access the endpoint. Changes to this value will not affect the revision.

string access_guidance = 12;

Parameter
Name Description
value ByteString

The bytes for accessGuidance to set.
Returns
Type Description
ApiDeployment.Builder

This builder for chaining.

setApiSpecRevision(String value)

public ApiDeployment.Builder setApiSpecRevision(String value)

The full resource name (including revision ID) of the spec of the API being served by the deployment. Changes to this value will update the revision. Format: apis/{api}/deployments/{deployment}

string api_spec_revision = 8 [(.google.api.resource_reference) = { ... }

Parameter
Name Description
value String

The apiSpecRevision to set.
Returns
Type Description
ApiDeployment.Builder

This builder for chaining.

setApiSpecRevisionBytes(ByteString value)

public ApiDeployment.Builder setApiSpecRevisionBytes(ByteString value)

The full resource name (including revision ID) of the spec of the API being served by the deployment. Changes to this value will update the revision. Format: apis/{api}/deployments/{deployment}

string api_spec_revision = 8 [(.google.api.resource_reference) = { ... }

Parameter
Name Description
value ByteString

The bytes for apiSpecRevision to set.
Returns
Type Description
ApiDeployment.Builder

This builder for chaining.

setCreateTime(Timestamp value)

public ApiDeployment.Builder setCreateTime(Timestamp value)

Output only. Creation timestamp; when the deployment resource was created.

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

Parameter
Name Description
value Timestamp
Returns
Type Description
ApiDeployment.Builder

setCreateTime(Timestamp.Builder builderForValue)

public ApiDeployment.Builder setCreateTime(Timestamp.Builder builderForValue)

Output only. Creation timestamp; when the deployment resource was created.

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

Parameter
Name Description
builderForValue Builder
Returns
Type Description
ApiDeployment.Builder

setDescription(String value)

public ApiDeployment.Builder setDescription(String value)

A detailed description.

string description = 3;

Parameter
Name Description
value String

The description to set.
Returns
Type Description
ApiDeployment.Builder

This builder for chaining.

setDescriptionBytes(ByteString value)

public ApiDeployment.Builder setDescriptionBytes(ByteString value)

A detailed description.

string description = 3;

Parameter
Name Description
value ByteString

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

This builder for chaining.

setDisplayName(String value)

public ApiDeployment.Builder setDisplayName(String value)

Human-meaningful name.

string display_name = 2;

Parameter
Name Description
value String

The displayName to set.
Returns
Type Description
ApiDeployment.Builder

This builder for chaining.

setDisplayNameBytes(ByteString value)

public ApiDeployment.Builder setDisplayNameBytes(ByteString value)

Human-meaningful name.

string display_name = 2;

Parameter
Name Description
value ByteString

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

This builder for chaining.

setEndpointUri(String value)

public ApiDeployment.Builder setEndpointUri(String value)

The address where the deployment is serving. Changes to this value will update the revision.

string endpoint_uri = 9;

Parameter
Name Description
value String

The endpointUri to set.
Returns
Type Description
ApiDeployment.Builder

This builder for chaining.

setEndpointUriBytes(ByteString value)

public ApiDeployment.Builder setEndpointUriBytes(ByteString value)

The address where the deployment is serving. Changes to this value will update the revision.

string endpoint_uri = 9;

Parameter
Name Description
value ByteString

The bytes for endpointUri to set.
Returns
Type Description
ApiDeployment.Builder

This builder for chaining.

setExternalChannelUri(String value)

public ApiDeployment.Builder setExternalChannelUri(String value)

The address of the external channel of the API (e.g., the Developer Portal). Changes to this value will not affect the revision.

string external_channel_uri = 10;

Parameter
Name Description
value String

The externalChannelUri to set.
Returns
Type Description
ApiDeployment.Builder

This builder for chaining.

setExternalChannelUriBytes(ByteString value)

public ApiDeployment.Builder setExternalChannelUriBytes(ByteString value)

The address of the external channel of the API (e.g., the Developer Portal). Changes to this value will not affect the revision.

string external_channel_uri = 10;

Parameter
Name Description
value ByteString

The bytes for externalChannelUri to set.
Returns
Type Description
ApiDeployment.Builder

This builder for chaining.

setField(Descriptors.FieldDescriptor field, Object value)

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

setIntendedAudience(String value)

public ApiDeployment.Builder setIntendedAudience(String value)

Text briefly identifying the intended audience of the API. Changes to this value will not affect the revision.

string intended_audience = 11;

Parameter
Name Description
value String

The intendedAudience to set.
Returns
Type Description
ApiDeployment.Builder

This builder for chaining.

setIntendedAudienceBytes(ByteString value)

public ApiDeployment.Builder setIntendedAudienceBytes(ByteString value)

Text briefly identifying the intended audience of the API. Changes to this value will not affect the revision.

string intended_audience = 11;

Parameter
Name Description
value ByteString

The bytes for intendedAudience to set.
Returns
Type Description
ApiDeployment.Builder

This builder for chaining.

setName(String value)

public ApiDeployment.Builder setName(String value)

Resource name.

string name = 1;

Parameter
Name Description
value String

The name to set.
Returns
Type Description
ApiDeployment.Builder

This builder for chaining.

setNameBytes(ByteString value)

public ApiDeployment.Builder setNameBytes(ByteString value)

Resource name.

string name = 1;

Parameter
Name Description
value ByteString

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

This builder for chaining.

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

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

setRevisionCreateTime(Timestamp value)

public ApiDeployment.Builder setRevisionCreateTime(Timestamp value)

Output only. Revision creation timestamp; when the represented revision was created.

.google.protobuf.Timestamp revision_create_time = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
value Timestamp
Returns
Type Description
ApiDeployment.Builder

setRevisionCreateTime(Timestamp.Builder builderForValue)

public ApiDeployment.Builder setRevisionCreateTime(Timestamp.Builder builderForValue)

Output only. Revision creation timestamp; when the represented revision was created.

.google.protobuf.Timestamp revision_create_time = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
builderForValue Builder
Returns
Type Description
ApiDeployment.Builder

setRevisionId(String value)

public ApiDeployment.Builder setRevisionId(String value)

Output only. Immutable. The revision ID of the deployment. A new revision is committed whenever the deployment contents are changed. The format is an 8-character hexadecimal string.

string revision_id = 4 [(.google.api.field_behavior) = IMMUTABLE, (.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
value String

The revisionId to set.
Returns
Type Description
ApiDeployment.Builder

This builder for chaining.

setRevisionIdBytes(ByteString value)

public ApiDeployment.Builder setRevisionIdBytes(ByteString value)

Output only. Immutable. The revision ID of the deployment. A new revision is committed whenever the deployment contents are changed. The format is an 8-character hexadecimal string.

string revision_id = 4 [(.google.api.field_behavior) = IMMUTABLE, (.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
value ByteString

The bytes for revisionId to set.
Returns
Type Description
ApiDeployment.Builder

This builder for chaining.

setRevisionUpdateTime(Timestamp value)

public ApiDeployment.Builder setRevisionUpdateTime(Timestamp value)

Output only. Last update timestamp: when the represented revision was last modified.

.google.protobuf.Timestamp revision_update_time = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
value Timestamp
Returns
Type Description
ApiDeployment.Builder

setRevisionUpdateTime(Timestamp.Builder builderForValue)

public ApiDeployment.Builder setRevisionUpdateTime(Timestamp.Builder builderForValue)

Output only. Last update timestamp: when the represented revision was last modified.

.google.protobuf.Timestamp revision_update_time = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
builderForValue Builder
Returns
Type Description
ApiDeployment.Builder

setUnknownFields(UnknownFieldSet unknownFields)

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