Class Api.Builder (0.14.1)

public static final class Api.Builder extends GeneratedMessageV3.Builder<Api.Builder> implements ApiOrBuilder

A top-level description of an API. Produced by producers and are commitments to provide services.

Protobuf type google.events.cloud.apigeeregistry.v1.Api

Implements

ApiOrBuilder

Static Methods

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
TypeDescription
Descriptor

Methods

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public Api.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
NameDescription
fieldFieldDescriptor
valueObject
Returns
TypeDescription
Api.Builder
Overrides

build()

public Api build()
Returns
TypeDescription
Api

buildPartial()

public Api buildPartial()
Returns
TypeDescription
Api

clear()

public Api.Builder clear()
Returns
TypeDescription
Api.Builder
Overrides

clearAnnotations()

public Api.Builder clearAnnotations()
Returns
TypeDescription
Api.Builder

clearAvailability()

public Api.Builder clearAvailability()

A user-definable description of the availability of this service. Format: free-form, but we expect single words that describe availability, e.g., "NONE", "TESTING", "PREVIEW", "GENERAL", "DEPRECATED", "SHUTDOWN".

string availability = 6;

Returns
TypeDescription
Api.Builder

This builder for chaining.

clearCreateTime()

public Api.Builder clearCreateTime()

Output only. Creation timestamp.

.google.protobuf.Timestamp create_time = 4;

Returns
TypeDescription
Api.Builder

clearDescription()

public Api.Builder clearDescription()

A detailed description.

string description = 3;

Returns
TypeDescription
Api.Builder

This builder for chaining.

clearDisplayName()

public Api.Builder clearDisplayName()

Human-meaningful name.

string display_name = 2;

Returns
TypeDescription
Api.Builder

This builder for chaining.

clearField(Descriptors.FieldDescriptor field)

public Api.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
NameDescription
fieldFieldDescriptor
Returns
TypeDescription
Api.Builder
Overrides

clearLabels()

public Api.Builder clearLabels()
Returns
TypeDescription
Api.Builder

clearName()

public Api.Builder clearName()

Resource name.

string name = 1;

Returns
TypeDescription
Api.Builder

This builder for chaining.

clearOneof(Descriptors.OneofDescriptor oneof)

public Api.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
NameDescription
oneofOneofDescriptor
Returns
TypeDescription
Api.Builder
Overrides

clearRecommendedDeployment()

public Api.Builder clearRecommendedDeployment()

The recommended deployment of the API. Format: projects/{project}/locations/{location}/apis/{api}/deployments/{deployment}

string recommended_deployment = 8;

Returns
TypeDescription
Api.Builder

This builder for chaining.

clearRecommendedVersion()

public Api.Builder clearRecommendedVersion()

The recommended version of the API. Format: projects/{project}/locations/{location}/apis/{api}/versions/{version}

string recommended_version = 7;

Returns
TypeDescription
Api.Builder

This builder for chaining.

clearUpdateTime()

public Api.Builder clearUpdateTime()

Output only. Last update timestamp.

.google.protobuf.Timestamp update_time = 5;

Returns
TypeDescription
Api.Builder

clone()

public Api.Builder clone()
Returns
TypeDescription
Api.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 = 10;

Parameter
NameDescription
keyString
Returns
TypeDescription
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 = 9;

Parameter
NameDescription
keyString
Returns
TypeDescription
boolean

getAnnotations()

public Map<String,String> getAnnotations()

Use #getAnnotationsMap() instead.

Returns
TypeDescription
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 = 10;

Returns
TypeDescription
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 = 10;

Returns
TypeDescription
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 = 10;

Parameters
NameDescription
keyString
defaultValueString
Returns
TypeDescription
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 = 10;

Parameter
NameDescription
keyString
Returns
TypeDescription
String

getAvailability()

public String getAvailability()

A user-definable description of the availability of this service. Format: free-form, but we expect single words that describe availability, e.g., "NONE", "TESTING", "PREVIEW", "GENERAL", "DEPRECATED", "SHUTDOWN".

string availability = 6;

Returns
TypeDescription
String

The availability.

getAvailabilityBytes()

public ByteString getAvailabilityBytes()

A user-definable description of the availability of this service. Format: free-form, but we expect single words that describe availability, e.g., "NONE", "TESTING", "PREVIEW", "GENERAL", "DEPRECATED", "SHUTDOWN".

string availability = 6;

Returns
TypeDescription
ByteString

The bytes for availability.

getCreateTime()

public Timestamp getCreateTime()

Output only. Creation timestamp.

.google.protobuf.Timestamp create_time = 4;

Returns
TypeDescription
Timestamp

The createTime.

getCreateTimeBuilder()

public Timestamp.Builder getCreateTimeBuilder()

Output only. Creation timestamp.

.google.protobuf.Timestamp create_time = 4;

Returns
TypeDescription
Builder

getCreateTimeOrBuilder()

public TimestampOrBuilder getCreateTimeOrBuilder()

Output only. Creation timestamp.

.google.protobuf.Timestamp create_time = 4;

Returns
TypeDescription
TimestampOrBuilder

getDefaultInstanceForType()

public Api getDefaultInstanceForType()
Returns
TypeDescription
Api

getDescription()

public String getDescription()

A detailed description.

string description = 3;

Returns
TypeDescription
String

The description.

getDescriptionBytes()

public ByteString getDescriptionBytes()

A detailed description.

string description = 3;

Returns
TypeDescription
ByteString

The bytes for description.

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
TypeDescription
Descriptor
Overrides

getDisplayName()

public String getDisplayName()

Human-meaningful name.

string display_name = 2;

Returns
TypeDescription
String

The displayName.

getDisplayNameBytes()

public ByteString getDisplayNameBytes()

Human-meaningful name.

string display_name = 2;

Returns
TypeDescription
ByteString

The bytes for displayName.

getLabels()

public Map<String,String> getLabels()

Use #getLabelsMap() instead.

Returns
TypeDescription
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 = 9;

Returns
TypeDescription
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 = 9;

Returns
TypeDescription
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 = 9;

Parameters
NameDescription
keyString
defaultValueString
Returns
TypeDescription
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 = 9;

Parameter
NameDescription
keyString
Returns
TypeDescription
String

getMutableAnnotations()

public Map<String,String> getMutableAnnotations()

Use alternate mutation accessors instead.

Returns
TypeDescription
Map<String,String>

getMutableLabels()

public Map<String,String> getMutableLabels()

Use alternate mutation accessors instead.

Returns
TypeDescription
Map<String,String>

getName()

public String getName()

Resource name.

string name = 1;

Returns
TypeDescription
String

The name.

getNameBytes()

public ByteString getNameBytes()

Resource name.

string name = 1;

Returns
TypeDescription
ByteString

The bytes for name.

getRecommendedDeployment()

public String getRecommendedDeployment()

The recommended deployment of the API. Format: projects/{project}/locations/{location}/apis/{api}/deployments/{deployment}

string recommended_deployment = 8;

Returns
TypeDescription
String

The recommendedDeployment.

getRecommendedDeploymentBytes()

public ByteString getRecommendedDeploymentBytes()

The recommended deployment of the API. Format: projects/{project}/locations/{location}/apis/{api}/deployments/{deployment}

string recommended_deployment = 8;

Returns
TypeDescription
ByteString

The bytes for recommendedDeployment.

getRecommendedVersion()

public String getRecommendedVersion()

The recommended version of the API. Format: projects/{project}/locations/{location}/apis/{api}/versions/{version}

string recommended_version = 7;

Returns
TypeDescription
String

The recommendedVersion.

getRecommendedVersionBytes()

public ByteString getRecommendedVersionBytes()

The recommended version of the API. Format: projects/{project}/locations/{location}/apis/{api}/versions/{version}

string recommended_version = 7;

Returns
TypeDescription
ByteString

The bytes for recommendedVersion.

getUpdateTime()

public Timestamp getUpdateTime()

Output only. Last update timestamp.

.google.protobuf.Timestamp update_time = 5;

Returns
TypeDescription
Timestamp

The updateTime.

getUpdateTimeBuilder()

public Timestamp.Builder getUpdateTimeBuilder()

Output only. Last update timestamp.

.google.protobuf.Timestamp update_time = 5;

Returns
TypeDescription
Builder

getUpdateTimeOrBuilder()

public TimestampOrBuilder getUpdateTimeOrBuilder()

Output only. Last update timestamp.

.google.protobuf.Timestamp update_time = 5;

Returns
TypeDescription
TimestampOrBuilder

hasCreateTime()

public boolean hasCreateTime()

Output only. Creation timestamp.

.google.protobuf.Timestamp create_time = 4;

Returns
TypeDescription
boolean

Whether the createTime field is set.

hasUpdateTime()

public boolean hasUpdateTime()

Output only. Last update timestamp.

.google.protobuf.Timestamp update_time = 5;

Returns
TypeDescription
boolean

Whether the updateTime field is set.

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

internalGetMapField(int number)

protected MapField internalGetMapField(int number)
Parameter
NameDescription
numberint
Returns
TypeDescription
MapField
Overrides

internalGetMutableMapField(int number)

protected MapField internalGetMutableMapField(int number)
Parameter
NameDescription
numberint
Returns
TypeDescription
MapField
Overrides

isInitialized()

public final boolean isInitialized()
Returns
TypeDescription
boolean
Overrides

mergeCreateTime(Timestamp value)

public Api.Builder mergeCreateTime(Timestamp value)

Output only. Creation timestamp.

.google.protobuf.Timestamp create_time = 4;

Parameter
NameDescription
valueTimestamp
Returns
TypeDescription
Api.Builder

mergeFrom(Api other)

public Api.Builder mergeFrom(Api other)
Parameter
NameDescription
otherApi
Returns
TypeDescription
Api.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public Api.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputCodedInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
Api.Builder
Overrides
Exceptions
TypeDescription
IOException

mergeFrom(Message other)

public Api.Builder mergeFrom(Message other)
Parameter
NameDescription
otherMessage
Returns
TypeDescription
Api.Builder
Overrides

mergeUnknownFields(UnknownFieldSet unknownFields)

public final Api.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
NameDescription
unknownFieldsUnknownFieldSet
Returns
TypeDescription
Api.Builder
Overrides

mergeUpdateTime(Timestamp value)

public Api.Builder mergeUpdateTime(Timestamp value)

Output only. Last update timestamp.

.google.protobuf.Timestamp update_time = 5;

Parameter
NameDescription
valueTimestamp
Returns
TypeDescription
Api.Builder

putAllAnnotations(Map<String,String> values)

public Api.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 = 10;

Parameter
NameDescription
valuesMap<String,String>
Returns
TypeDescription
Api.Builder

putAllLabels(Map<String,String> values)

public Api.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 = 9;

Parameter
NameDescription
valuesMap<String,String>
Returns
TypeDescription
Api.Builder

putAnnotations(String key, String value)

public Api.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 = 10;

Parameters
NameDescription
keyString
valueString
Returns
TypeDescription
Api.Builder

putLabels(String key, String value)

public Api.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 = 9;

Parameters
NameDescription
keyString
valueString
Returns
TypeDescription
Api.Builder

removeAnnotations(String key)

public Api.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 = 10;

Parameter
NameDescription
keyString
Returns
TypeDescription
Api.Builder

removeLabels(String key)

public Api.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 = 9;

Parameter
NameDescription
keyString
Returns
TypeDescription
Api.Builder

setAvailability(String value)

public Api.Builder setAvailability(String value)

A user-definable description of the availability of this service. Format: free-form, but we expect single words that describe availability, e.g., "NONE", "TESTING", "PREVIEW", "GENERAL", "DEPRECATED", "SHUTDOWN".

string availability = 6;

Parameter
NameDescription
valueString

The availability to set.

Returns
TypeDescription
Api.Builder

This builder for chaining.

setAvailabilityBytes(ByteString value)

public Api.Builder setAvailabilityBytes(ByteString value)

A user-definable description of the availability of this service. Format: free-form, but we expect single words that describe availability, e.g., "NONE", "TESTING", "PREVIEW", "GENERAL", "DEPRECATED", "SHUTDOWN".

string availability = 6;

Parameter
NameDescription
valueByteString

The bytes for availability to set.

Returns
TypeDescription
Api.Builder

This builder for chaining.

setCreateTime(Timestamp value)

public Api.Builder setCreateTime(Timestamp value)

Output only. Creation timestamp.

.google.protobuf.Timestamp create_time = 4;

Parameter
NameDescription
valueTimestamp
Returns
TypeDescription
Api.Builder

setCreateTime(Timestamp.Builder builderForValue)

public Api.Builder setCreateTime(Timestamp.Builder builderForValue)

Output only. Creation timestamp.

.google.protobuf.Timestamp create_time = 4;

Parameter
NameDescription
builderForValueBuilder
Returns
TypeDescription
Api.Builder

setDescription(String value)

public Api.Builder setDescription(String value)

A detailed description.

string description = 3;

Parameter
NameDescription
valueString

The description to set.

Returns
TypeDescription
Api.Builder

This builder for chaining.

setDescriptionBytes(ByteString value)

public Api.Builder setDescriptionBytes(ByteString value)

A detailed description.

string description = 3;

Parameter
NameDescription
valueByteString

The bytes for description to set.

Returns
TypeDescription
Api.Builder

This builder for chaining.

setDisplayName(String value)

public Api.Builder setDisplayName(String value)

Human-meaningful name.

string display_name = 2;

Parameter
NameDescription
valueString

The displayName to set.

Returns
TypeDescription
Api.Builder

This builder for chaining.

setDisplayNameBytes(ByteString value)

public Api.Builder setDisplayNameBytes(ByteString value)

Human-meaningful name.

string display_name = 2;

Parameter
NameDescription
valueByteString

The bytes for displayName to set.

Returns
TypeDescription
Api.Builder

This builder for chaining.

setField(Descriptors.FieldDescriptor field, Object value)

public Api.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
NameDescription
fieldFieldDescriptor
valueObject
Returns
TypeDescription
Api.Builder
Overrides

setName(String value)

public Api.Builder setName(String value)

Resource name.

string name = 1;

Parameter
NameDescription
valueString

The name to set.

Returns
TypeDescription
Api.Builder

This builder for chaining.

setNameBytes(ByteString value)

public Api.Builder setNameBytes(ByteString value)

Resource name.

string name = 1;

Parameter
NameDescription
valueByteString

The bytes for name to set.

Returns
TypeDescription
Api.Builder

This builder for chaining.

setRecommendedDeployment(String value)

public Api.Builder setRecommendedDeployment(String value)

The recommended deployment of the API. Format: projects/{project}/locations/{location}/apis/{api}/deployments/{deployment}

string recommended_deployment = 8;

Parameter
NameDescription
valueString

The recommendedDeployment to set.

Returns
TypeDescription
Api.Builder

This builder for chaining.

setRecommendedDeploymentBytes(ByteString value)

public Api.Builder setRecommendedDeploymentBytes(ByteString value)

The recommended deployment of the API. Format: projects/{project}/locations/{location}/apis/{api}/deployments/{deployment}

string recommended_deployment = 8;

Parameter
NameDescription
valueByteString

The bytes for recommendedDeployment to set.

Returns
TypeDescription
Api.Builder

This builder for chaining.

setRecommendedVersion(String value)

public Api.Builder setRecommendedVersion(String value)

The recommended version of the API. Format: projects/{project}/locations/{location}/apis/{api}/versions/{version}

string recommended_version = 7;

Parameter
NameDescription
valueString

The recommendedVersion to set.

Returns
TypeDescription
Api.Builder

This builder for chaining.

setRecommendedVersionBytes(ByteString value)

public Api.Builder setRecommendedVersionBytes(ByteString value)

The recommended version of the API. Format: projects/{project}/locations/{location}/apis/{api}/versions/{version}

string recommended_version = 7;

Parameter
NameDescription
valueByteString

The bytes for recommendedVersion to set.

Returns
TypeDescription
Api.Builder

This builder for chaining.

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

public Api.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Parameters
NameDescription
fieldFieldDescriptor
indexint
valueObject
Returns
TypeDescription
Api.Builder
Overrides

setUnknownFields(UnknownFieldSet unknownFields)

public final Api.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
NameDescription
unknownFieldsUnknownFieldSet
Returns
TypeDescription
Api.Builder
Overrides

setUpdateTime(Timestamp value)

public Api.Builder setUpdateTime(Timestamp value)

Output only. Last update timestamp.

.google.protobuf.Timestamp update_time = 5;

Parameter
NameDescription
valueTimestamp
Returns
TypeDescription
Api.Builder

setUpdateTime(Timestamp.Builder builderForValue)

public Api.Builder setUpdateTime(Timestamp.Builder builderForValue)

Output only. Last update timestamp.

.google.protobuf.Timestamp update_time = 5;

Parameter
NameDescription
builderForValueBuilder
Returns
TypeDescription
Api.Builder