Class Api.Builder (0.15.0)

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

An API that can be served by one or more Gateways.

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

Implements

ApiOrBuilder

Static Methods

getDescriptor()

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

Methods

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

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

build()

public Api build()
Returns
Type Description
Api

buildPartial()

public Api buildPartial()
Returns
Type Description
Api

clear()

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

clearCreateTime()

public Api.Builder clearCreateTime()

Output only. Created time.

.google.protobuf.Timestamp create_time = 2;

Returns
Type Description
Api.Builder

clearDisplayName()

public Api.Builder clearDisplayName()

Optional. Display name.

string display_name = 5;

Returns
Type Description
Api.Builder

This builder for chaining.

clearField(Descriptors.FieldDescriptor field)

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

clearLabels()

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

clearManagedService()

public Api.Builder clearManagedService()

Optional. Immutable. The name of a Google Managed Service ( https://cloud.google.com/service-infrastructure/docs/glossary#managed). If not specified, a new Service will automatically be created in the same project as this API.

string managed_service = 7;

Returns
Type Description
Api.Builder

This builder for chaining.

clearName()

public Api.Builder clearName()

Output only. Resource name of the API. Format: projects/{project}/locations/global/apis/{api}

string name = 1;

Returns
Type Description
Api.Builder

This builder for chaining.

clearOneof(Descriptors.OneofDescriptor oneof)

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

clearState()

public Api.Builder clearState()

Output only. State of the API.

.google.events.cloud.apigateway.v1.Api.State state = 12;

Returns
Type Description
Api.Builder

This builder for chaining.

clearUpdateTime()

public Api.Builder clearUpdateTime()

Output only. Updated time.

.google.protobuf.Timestamp update_time = 3;

Returns
Type Description
Api.Builder

clone()

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

containsLabels(String key)

public boolean containsLabels(String key)

Optional. Resource labels to represent user-provided metadata. Refer to cloud documentation on labels for more details. https://cloud.google.com/compute/docs/labeling-resources

map<string, string> labels = 4;

Parameter
Name Description
key String
Returns
Type Description
boolean

getCreateTime()

public Timestamp getCreateTime()

Output only. Created time.

.google.protobuf.Timestamp create_time = 2;

Returns
Type Description
Timestamp

The createTime.

getCreateTimeBuilder()

public Timestamp.Builder getCreateTimeBuilder()

Output only. Created time.

.google.protobuf.Timestamp create_time = 2;

Returns
Type Description
Builder

getCreateTimeOrBuilder()

public TimestampOrBuilder getCreateTimeOrBuilder()

Output only. Created time.

.google.protobuf.Timestamp create_time = 2;

Returns
Type Description
TimestampOrBuilder

getDefaultInstanceForType()

public Api getDefaultInstanceForType()
Returns
Type Description
Api

getDescriptorForType()

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

getDisplayName()

public String getDisplayName()

Optional. Display name.

string display_name = 5;

Returns
Type Description
String

The displayName.

getDisplayNameBytes()

public ByteString getDisplayNameBytes()

Optional. Display name.

string display_name = 5;

Returns
Type Description
ByteString

The bytes for displayName.

getLabels()

public Map<String,String> getLabels()

Use #getLabelsMap() instead.

Returns
Type Description
Map<String,String>

getLabelsCount()

public int getLabelsCount()

Optional. Resource labels to represent user-provided metadata. Refer to cloud documentation on labels for more details. https://cloud.google.com/compute/docs/labeling-resources

map<string, string> labels = 4;

Returns
Type Description
int

getLabelsMap()

public Map<String,String> getLabelsMap()

Optional. Resource labels to represent user-provided metadata. Refer to cloud documentation on labels for more details. https://cloud.google.com/compute/docs/labeling-resources

map<string, string> labels = 4;

Returns
Type Description
Map<String,String>

getLabelsOrDefault(String key, String defaultValue)

public String getLabelsOrDefault(String key, String defaultValue)

Optional. Resource labels to represent user-provided metadata. Refer to cloud documentation on labels for more details. https://cloud.google.com/compute/docs/labeling-resources

map<string, string> labels = 4;

Parameters
Name Description
key String
defaultValue String
Returns
Type Description
String

getLabelsOrThrow(String key)

public String getLabelsOrThrow(String key)

Optional. Resource labels to represent user-provided metadata. Refer to cloud documentation on labels for more details. https://cloud.google.com/compute/docs/labeling-resources

map<string, string> labels = 4;

Parameter
Name Description
key String
Returns
Type Description
String

getManagedService()

public String getManagedService()

Optional. Immutable. The name of a Google Managed Service ( https://cloud.google.com/service-infrastructure/docs/glossary#managed). If not specified, a new Service will automatically be created in the same project as this API.

string managed_service = 7;

Returns
Type Description
String

The managedService.

getManagedServiceBytes()

public ByteString getManagedServiceBytes()

Optional. Immutable. The name of a Google Managed Service ( https://cloud.google.com/service-infrastructure/docs/glossary#managed). If not specified, a new Service will automatically be created in the same project as this API.

string managed_service = 7;

Returns
Type Description
ByteString

The bytes for managedService.

getMutableLabels()

public Map<String,String> getMutableLabels()

Use alternate mutation accessors instead.

Returns
Type Description
Map<String,String>

getName()

public String getName()

Output only. Resource name of the API. Format: projects/{project}/locations/global/apis/{api}

string name = 1;

Returns
Type Description
String

The name.

getNameBytes()

public ByteString getNameBytes()

Output only. Resource name of the API. Format: projects/{project}/locations/global/apis/{api}

string name = 1;

Returns
Type Description
ByteString

The bytes for name.

getState()

public Api.State getState()

Output only. State of the API.

.google.events.cloud.apigateway.v1.Api.State state = 12;

Returns
Type Description
Api.State

The state.

getStateValue()

public int getStateValue()

Output only. State of the API.

.google.events.cloud.apigateway.v1.Api.State state = 12;

Returns
Type Description
int

The enum numeric value on the wire for state.

getUpdateTime()

public Timestamp getUpdateTime()

Output only. Updated time.

.google.protobuf.Timestamp update_time = 3;

Returns
Type Description
Timestamp

The updateTime.

getUpdateTimeBuilder()

public Timestamp.Builder getUpdateTimeBuilder()

Output only. Updated time.

.google.protobuf.Timestamp update_time = 3;

Returns
Type Description
Builder

getUpdateTimeOrBuilder()

public TimestampOrBuilder getUpdateTimeOrBuilder()

Output only. Updated time.

.google.protobuf.Timestamp update_time = 3;

Returns
Type Description
TimestampOrBuilder

hasCreateTime()

public boolean hasCreateTime()

Output only. Created time.

.google.protobuf.Timestamp create_time = 2;

Returns
Type Description
boolean

Whether the createTime field is set.

hasUpdateTime()

public boolean hasUpdateTime()

Output only. Updated time.

.google.protobuf.Timestamp update_time = 3;

Returns
Type Description
boolean

Whether the updateTime field is set.

internalGetFieldAccessorTable()

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

internalGetMapField(int number)

protected MapField internalGetMapField(int number)
Parameter
Name Description
number int
Returns
Type Description
MapField
Overrides

internalGetMutableMapField(int number)

protected MapField internalGetMutableMapField(int number)
Parameter
Name Description
number int
Returns
Type Description
MapField
Overrides

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

mergeCreateTime(Timestamp value)

public Api.Builder mergeCreateTime(Timestamp value)

Output only. Created time.

.google.protobuf.Timestamp create_time = 2;

Parameter
Name Description
value Timestamp
Returns
Type Description
Api.Builder

mergeFrom(Api other)

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

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

mergeFrom(Message other)

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

mergeUnknownFields(UnknownFieldSet unknownFields)

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

mergeUpdateTime(Timestamp value)

public Api.Builder mergeUpdateTime(Timestamp value)

Output only. Updated time.

.google.protobuf.Timestamp update_time = 3;

Parameter
Name Description
value Timestamp
Returns
Type Description
Api.Builder

putAllLabels(Map<String,String> values)

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

Optional. Resource labels to represent user-provided metadata. Refer to cloud documentation on labels for more details. https://cloud.google.com/compute/docs/labeling-resources

map<string, string> labels = 4;

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

putLabels(String key, String value)

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

Optional. Resource labels to represent user-provided metadata. Refer to cloud documentation on labels for more details. https://cloud.google.com/compute/docs/labeling-resources

map<string, string> labels = 4;

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

removeLabels(String key)

public Api.Builder removeLabels(String key)

Optional. Resource labels to represent user-provided metadata. Refer to cloud documentation on labels for more details. https://cloud.google.com/compute/docs/labeling-resources

map<string, string> labels = 4;

Parameter
Name Description
key String
Returns
Type Description
Api.Builder

setCreateTime(Timestamp value)

public Api.Builder setCreateTime(Timestamp value)

Output only. Created time.

.google.protobuf.Timestamp create_time = 2;

Parameter
Name Description
value Timestamp
Returns
Type Description
Api.Builder

setCreateTime(Timestamp.Builder builderForValue)

public Api.Builder setCreateTime(Timestamp.Builder builderForValue)

Output only. Created time.

.google.protobuf.Timestamp create_time = 2;

Parameter
Name Description
builderForValue Builder
Returns
Type Description
Api.Builder

setDisplayName(String value)

public Api.Builder setDisplayName(String value)

Optional. Display name.

string display_name = 5;

Parameter
Name Description
value String

The displayName to set.

Returns
Type Description
Api.Builder

This builder for chaining.

setDisplayNameBytes(ByteString value)

public Api.Builder setDisplayNameBytes(ByteString value)

Optional. Display name.

string display_name = 5;

Parameter
Name Description
value ByteString

The bytes for displayName to set.

Returns
Type Description
Api.Builder

This builder for chaining.

setField(Descriptors.FieldDescriptor field, Object value)

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

setManagedService(String value)

public Api.Builder setManagedService(String value)

Optional. Immutable. The name of a Google Managed Service ( https://cloud.google.com/service-infrastructure/docs/glossary#managed). If not specified, a new Service will automatically be created in the same project as this API.

string managed_service = 7;

Parameter
Name Description
value String

The managedService to set.

Returns
Type Description
Api.Builder

This builder for chaining.

setManagedServiceBytes(ByteString value)

public Api.Builder setManagedServiceBytes(ByteString value)

Optional. Immutable. The name of a Google Managed Service ( https://cloud.google.com/service-infrastructure/docs/glossary#managed). If not specified, a new Service will automatically be created in the same project as this API.

string managed_service = 7;

Parameter
Name Description
value ByteString

The bytes for managedService to set.

Returns
Type Description
Api.Builder

This builder for chaining.

setName(String value)

public Api.Builder setName(String value)

Output only. Resource name of the API. Format: projects/{project}/locations/global/apis/{api}

string name = 1;

Parameter
Name Description
value String

The name to set.

Returns
Type Description
Api.Builder

This builder for chaining.

setNameBytes(ByteString value)

public Api.Builder setNameBytes(ByteString value)

Output only. Resource name of the API. Format: projects/{project}/locations/global/apis/{api}

string name = 1;

Parameter
Name Description
value ByteString

The bytes for name to set.

Returns
Type Description
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
Name Description
field FieldDescriptor
index int
value Object
Returns
Type Description
Api.Builder
Overrides

setState(Api.State value)

public Api.Builder setState(Api.State value)

Output only. State of the API.

.google.events.cloud.apigateway.v1.Api.State state = 12;

Parameter
Name Description
value Api.State

The state to set.

Returns
Type Description
Api.Builder

This builder for chaining.

setStateValue(int value)

public Api.Builder setStateValue(int value)

Output only. State of the API.

.google.events.cloud.apigateway.v1.Api.State state = 12;

Parameter
Name Description
value int

The enum numeric value on the wire for state to set.

Returns
Type Description
Api.Builder

This builder for chaining.

setUnknownFields(UnknownFieldSet unknownFields)

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

setUpdateTime(Timestamp value)

public Api.Builder setUpdateTime(Timestamp value)

Output only. Updated time.

.google.protobuf.Timestamp update_time = 3;

Parameter
Name Description
value Timestamp
Returns
Type Description
Api.Builder

setUpdateTime(Timestamp.Builder builderForValue)

public Api.Builder setUpdateTime(Timestamp.Builder builderForValue)

Output only. Updated time.

.google.protobuf.Timestamp update_time = 3;

Parameter
Name Description
builderForValue Builder
Returns
Type Description
Api.Builder