Class Api.Builder (2.49.0)
Stay organized with collections
Save and categorize content based on your preferences.
- 2.80.0 (latest)
- 2.78.0
- 2.76.0
- 2.75.0
- 2.74.0
- 2.73.0
- 2.72.0
- 2.70.0
- 2.68.0
- 2.67.0
- 2.64.0
- 2.63.0
- 2.62.0
- 2.60.0
- 2.59.0
- 2.58.0
- 2.57.0
- 2.56.0
- 2.55.0
- 2.54.0
- 2.53.0
- 2.52.0
- 2.51.0
- 2.49.0
- 2.48.0
- 2.47.0
- 2.46.0
- 2.45.0
- 2.44.0
- 2.43.0
- 2.42.0
- 2.41.0
- 2.40.0
- 2.39.0
- 2.37.0
- 2.36.0
- 2.35.0
- 2.34.0
- 2.33.0
- 2.32.0
- 2.31.0
- 2.30.0
- 2.29.0
- 2.28.0
- 2.27.0
- 2.24.0
- 2.23.0
- 2.22.0
- 2.21.0
- 2.20.0
- 2.19.0
- 2.18.0
- 2.17.0
- 2.16.0
- 2.15.0
- 2.14.0
- 2.13.0
- 2.12.0
- 2.11.0
- 2.10.0
- 2.9.0
- 2.8.0
- 2.7.0
- 2.6.0
- 2.5.0
- 2.4.0
- 2.3.7
- 2.2.1
- 2.1.12
publicstaticfinalclass Api.BuilderextendsGeneratedMessageV3.Builder<Api.Builder>implementsApiOrBuilderAn API that can be served by one or more Gateways.
Protobuf type google.cloud.apigateway.v1.Api
Inheritance
Object > AbstractMessageLite.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessageV3.Builder > Api.BuilderImplements
ApiOrBuilderInherited Members
Static Methods
getDescriptor()
publicstaticfinalDescriptors.DescriptorgetDescriptor()| Returns | |
|---|---|
| Type | Description |
Descriptor |
|
Methods
addRepeatedField(Descriptors.FieldDescriptor field, Object value)
publicApi.BuilderaddRepeatedField(Descriptors.FieldDescriptorfield,Objectvalue)| Parameters | |
|---|---|
| Name | Description |
field |
FieldDescriptor |
value |
Object |
| Returns | |
|---|---|
| Type | Description |
Api.Builder |
|
build()
publicApibuild()| Returns | |
|---|---|
| Type | Description |
Api |
|
buildPartial()
publicApibuildPartial()| Returns | |
|---|---|
| Type | Description |
Api |
|
clear()
publicApi.Builderclear()| Returns | |
|---|---|
| Type | Description |
Api.Builder |
|
clearCreateTime()
publicApi.BuilderclearCreateTime()Output only. Created time.
.google.protobuf.Timestamp create_time = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
Api.Builder |
|
clearDisplayName()
publicApi.BuilderclearDisplayName()Optional. Display name.
string display_name = 5 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
Api.Builder |
This builder for chaining. |
clearField(Descriptors.FieldDescriptor field)
publicApi.BuilderclearField(Descriptors.FieldDescriptorfield)| Parameter | |
|---|---|
| Name | Description |
field |
FieldDescriptor |
| Returns | |
|---|---|
| Type | Description |
Api.Builder |
|
clearLabels()
publicApi.BuilderclearLabels()| Returns | |
|---|---|
| Type | Description |
Api.Builder |
|
clearManagedService()
publicApi.BuilderclearManagedService()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 [(.google.api.field_behavior) = IMMUTABLE, (.google.api.field_behavior) = OPTIONAL, (.google.api.resource_reference) = { ... }
| Returns | |
|---|---|
| Type | Description |
Api.Builder |
This builder for chaining. |
clearName()
publicApi.BuilderclearName()Output only. Resource name of the API. Format: projects/{project}/locations/global/apis/{api}
string name = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
Api.Builder |
This builder for chaining. |
clearOneof(Descriptors.OneofDescriptor oneof)
publicApi.BuilderclearOneof(Descriptors.OneofDescriptoroneof)| Parameter | |
|---|---|
| Name | Description |
oneof |
OneofDescriptor |
| Returns | |
|---|---|
| Type | Description |
Api.Builder |
|
clearState()
publicApi.BuilderclearState()Output only. State of the API.
.google.cloud.apigateway.v1.Api.State state = 12 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
Api.Builder |
This builder for chaining. |
clearUpdateTime()
publicApi.BuilderclearUpdateTime()Output only. Updated time.
.google.protobuf.Timestamp update_time = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
Api.Builder |
|
clone()
publicApi.Builderclone()| Returns | |
|---|---|
| Type | Description |
Api.Builder |
|
containsLabels(String key)
publicbooleancontainsLabels(Stringkey)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 [(.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description |
key |
String |
| Returns | |
|---|---|
| Type | Description |
boolean |
|
getCreateTime()
publicTimestampgetCreateTime()Output only. Created time.
.google.protobuf.Timestamp create_time = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
Timestamp |
The createTime. |
getCreateTimeBuilder()
publicTimestamp.BuildergetCreateTimeBuilder()Output only. Created time.
.google.protobuf.Timestamp create_time = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
Builder |
|
getCreateTimeOrBuilder()
publicTimestampOrBuildergetCreateTimeOrBuilder()Output only. Created time.
.google.protobuf.Timestamp create_time = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
TimestampOrBuilder |
|
getDefaultInstanceForType()
publicApigetDefaultInstanceForType()| Returns | |
|---|---|
| Type | Description |
Api |
|
getDescriptorForType()
publicDescriptors.DescriptorgetDescriptorForType()| Returns | |
|---|---|
| Type | Description |
Descriptor |
|
getDisplayName()
publicStringgetDisplayName()Optional. Display name.
string display_name = 5 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
String |
The displayName. |
getDisplayNameBytes()
publicByteStringgetDisplayNameBytes()Optional. Display name.
string display_name = 5 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
ByteString |
The bytes for displayName. |
getLabels() (deprecated)
publicMap<String,String>getLabels()Use #getLabelsMap() instead.
| Returns | |
|---|---|
| Type | Description |
Map<String,String> |
|
getLabelsCount()
publicintgetLabelsCount()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 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
int |
|
getLabelsMap()
publicMap<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 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
Map<String,String> |
|
getLabelsOrDefault(String key, String defaultValue)
publicStringgetLabelsOrDefault(Stringkey,StringdefaultValue)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 [(.google.api.field_behavior) = OPTIONAL];
| Parameters | |
|---|---|
| Name | Description |
key |
String |
defaultValue |
String |
| Returns | |
|---|---|
| Type | Description |
String |
|
getLabelsOrThrow(String key)
publicStringgetLabelsOrThrow(Stringkey)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 [(.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description |
key |
String |
| Returns | |
|---|---|
| Type | Description |
String |
|
getManagedService()
publicStringgetManagedService()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 [(.google.api.field_behavior) = IMMUTABLE, (.google.api.field_behavior) = OPTIONAL, (.google.api.resource_reference) = { ... }
| Returns | |
|---|---|
| Type | Description |
String |
The managedService. |
getManagedServiceBytes()
publicByteStringgetManagedServiceBytes()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 [(.google.api.field_behavior) = IMMUTABLE, (.google.api.field_behavior) = OPTIONAL, (.google.api.resource_reference) = { ... }
| Returns | |
|---|---|
| Type | Description |
ByteString |
The bytes for managedService. |
getMutableLabels() (deprecated)
publicMap<String,String>getMutableLabels()Use alternate mutation accessors instead.
| Returns | |
|---|---|
| Type | Description |
Map<String,String> |
|
getName()
publicStringgetName()Output only. Resource name of the API. Format: projects/{project}/locations/global/apis/{api}
string name = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
String |
The name. |
getNameBytes()
publicByteStringgetNameBytes()Output only. Resource name of the API. Format: projects/{project}/locations/global/apis/{api}
string name = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
ByteString |
The bytes for name. |
getState()
publicApi.StategetState()Output only. State of the API.
.google.cloud.apigateway.v1.Api.State state = 12 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
Api.State |
The state. |
getStateValue()
publicintgetStateValue()Output only. State of the API.
.google.cloud.apigateway.v1.Api.State state = 12 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
int |
The enum numeric value on the wire for state. |
getUpdateTime()
publicTimestampgetUpdateTime()Output only. Updated time.
.google.protobuf.Timestamp update_time = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
Timestamp |
The updateTime. |
getUpdateTimeBuilder()
publicTimestamp.BuildergetUpdateTimeBuilder()Output only. Updated time.
.google.protobuf.Timestamp update_time = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
Builder |
|
getUpdateTimeOrBuilder()
publicTimestampOrBuildergetUpdateTimeOrBuilder()Output only. Updated time.
.google.protobuf.Timestamp update_time = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
TimestampOrBuilder |
|
hasCreateTime()
publicbooleanhasCreateTime()Output only. Created time.
.google.protobuf.Timestamp create_time = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
boolean |
Whether the createTime field is set. |
hasUpdateTime()
publicbooleanhasUpdateTime()Output only. Updated time.
.google.protobuf.Timestamp update_time = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
boolean |
Whether the updateTime field is set. |
internalGetFieldAccessorTable()
protectedGeneratedMessageV3.FieldAccessorTableinternalGetFieldAccessorTable()| Returns | |
|---|---|
| Type | Description |
FieldAccessorTable |
|
internalGetMapFieldReflection(int number)
protectedMapFieldReflectionAccessorinternalGetMapFieldReflection(intnumber)| Parameter | |
|---|---|
| Name | Description |
number |
int |
| Returns | |
|---|---|
| Type | Description |
com.google.protobuf.MapFieldReflectionAccessor |
|
internalGetMutableMapFieldReflection(int number)
protectedMapFieldReflectionAccessorinternalGetMutableMapFieldReflection(intnumber)| Parameter | |
|---|---|
| Name | Description |
number |
int |
| Returns | |
|---|---|
| Type | Description |
com.google.protobuf.MapFieldReflectionAccessor |
|
isInitialized()
publicfinalbooleanisInitialized()| Returns | |
|---|---|
| Type | Description |
boolean |
|
mergeCreateTime(Timestamp value)
publicApi.BuildermergeCreateTime(Timestampvalue)Output only. Created time.
.google.protobuf.Timestamp create_time = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Parameter | |
|---|---|
| Name | Description |
value |
Timestamp |
| Returns | |
|---|---|
| Type | Description |
Api.Builder |
|
mergeFrom(Api other)
publicApi.BuildermergeFrom(Apiother)| Parameter | |
|---|---|
| Name | Description |
other |
Api |
| Returns | |
|---|---|
| Type | Description |
Api.Builder |
|
mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
publicApi.BuildermergeFrom(CodedInputStreaminput,ExtensionRegistryLiteextensionRegistry)| Parameters | |
|---|---|
| Name | Description |
input |
CodedInputStream |
extensionRegistry |
ExtensionRegistryLite |
| Returns | |
|---|---|
| Type | Description |
Api.Builder |
|
| Exceptions | |
|---|---|
| Type | Description |
IOException |
|
mergeFrom(Message other)
publicApi.BuildermergeFrom(Messageother)| Parameter | |
|---|---|
| Name | Description |
other |
Message |
| Returns | |
|---|---|
| Type | Description |
Api.Builder |
|
mergeUnknownFields(UnknownFieldSet unknownFields)
publicfinalApi.BuildermergeUnknownFields(UnknownFieldSetunknownFields)| Parameter | |
|---|---|
| Name | Description |
unknownFields |
UnknownFieldSet |
| Returns | |
|---|---|
| Type | Description |
Api.Builder |
|
mergeUpdateTime(Timestamp value)
publicApi.BuildermergeUpdateTime(Timestampvalue)Output only. Updated time.
.google.protobuf.Timestamp update_time = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Parameter | |
|---|---|
| Name | Description |
value |
Timestamp |
| Returns | |
|---|---|
| Type | Description |
Api.Builder |
|
putAllLabels(Map<String,String> values)
publicApi.BuilderputAllLabels(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 [(.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description |
values |
Map<String,String> |
| Returns | |
|---|---|
| Type | Description |
Api.Builder |
|
putLabels(String key, String value)
publicApi.BuilderputLabels(Stringkey,Stringvalue)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 [(.google.api.field_behavior) = OPTIONAL];
| Parameters | |
|---|---|
| Name | Description |
key |
String |
value |
String |
| Returns | |
|---|---|
| Type | Description |
Api.Builder |
|
removeLabels(String key)
publicApi.BuilderremoveLabels(Stringkey)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 [(.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description |
key |
String |
| Returns | |
|---|---|
| Type | Description |
Api.Builder |
|
setCreateTime(Timestamp value)
publicApi.BuildersetCreateTime(Timestampvalue)Output only. Created time.
.google.protobuf.Timestamp create_time = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Parameter | |
|---|---|
| Name | Description |
value |
Timestamp |
| Returns | |
|---|---|
| Type | Description |
Api.Builder |
|
setCreateTime(Timestamp.Builder builderForValue)
publicApi.BuildersetCreateTime(Timestamp.BuilderbuilderForValue)Output only. Created time.
.google.protobuf.Timestamp create_time = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Parameter | |
|---|---|
| Name | Description |
builderForValue |
Builder |
| Returns | |
|---|---|
| Type | Description |
Api.Builder |
|
setDisplayName(String value)
publicApi.BuildersetDisplayName(Stringvalue)Optional. Display name.
string display_name = 5 [(.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description |
value |
String The displayName to set. |
| Returns | |
|---|---|
| Type | Description |
Api.Builder |
This builder for chaining. |
setDisplayNameBytes(ByteString value)
publicApi.BuildersetDisplayNameBytes(ByteStringvalue)Optional. Display name.
string display_name = 5 [(.google.api.field_behavior) = OPTIONAL];
| 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)
publicApi.BuildersetField(Descriptors.FieldDescriptorfield,Objectvalue)| Parameters | |
|---|---|
| Name | Description |
field |
FieldDescriptor |
value |
Object |
| Returns | |
|---|---|
| Type | Description |
Api.Builder |
|
setManagedService(String value)
publicApi.BuildersetManagedService(Stringvalue)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 [(.google.api.field_behavior) = IMMUTABLE, (.google.api.field_behavior) = OPTIONAL, (.google.api.resource_reference) = { ... }
| Parameter | |
|---|---|
| Name | Description |
value |
String The managedService to set. |
| Returns | |
|---|---|
| Type | Description |
Api.Builder |
This builder for chaining. |
setManagedServiceBytes(ByteString value)
publicApi.BuildersetManagedServiceBytes(ByteStringvalue)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 [(.google.api.field_behavior) = IMMUTABLE, (.google.api.field_behavior) = OPTIONAL, (.google.api.resource_reference) = { ... }
| Parameter | |
|---|---|
| Name | Description |
value |
ByteString The bytes for managedService to set. |
| Returns | |
|---|---|
| Type | Description |
Api.Builder |
This builder for chaining. |
setName(String value)
publicApi.BuildersetName(Stringvalue)Output only. Resource name of the API. Format: projects/{project}/locations/global/apis/{api}
string name = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Parameter | |
|---|---|
| Name | Description |
value |
String The name to set. |
| Returns | |
|---|---|
| Type | Description |
Api.Builder |
This builder for chaining. |
setNameBytes(ByteString value)
publicApi.BuildersetNameBytes(ByteStringvalue)Output only. Resource name of the API. Format: projects/{project}/locations/global/apis/{api}
string name = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];
| 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)
publicApi.BuildersetRepeatedField(Descriptors.FieldDescriptorfield,intindex,Objectvalue)| Parameters | |
|---|---|
| Name | Description |
field |
FieldDescriptor |
index |
int |
value |
Object |
| Returns | |
|---|---|
| Type | Description |
Api.Builder |
|
setState(Api.State value)
publicApi.BuildersetState(Api.Statevalue)Output only. State of the API.
.google.cloud.apigateway.v1.Api.State state = 12 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Parameter | |
|---|---|
| Name | Description |
value |
Api.State The state to set. |
| Returns | |
|---|---|
| Type | Description |
Api.Builder |
This builder for chaining. |
setStateValue(int value)
publicApi.BuildersetStateValue(intvalue)Output only. State of the API.
.google.cloud.apigateway.v1.Api.State state = 12 [(.google.api.field_behavior) = OUTPUT_ONLY];
| 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)
publicfinalApi.BuildersetUnknownFields(UnknownFieldSetunknownFields)| Parameter | |
|---|---|
| Name | Description |
unknownFields |
UnknownFieldSet |
| Returns | |
|---|---|
| Type | Description |
Api.Builder |
|
setUpdateTime(Timestamp value)
publicApi.BuildersetUpdateTime(Timestampvalue)Output only. Updated time.
.google.protobuf.Timestamp update_time = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Parameter | |
|---|---|
| Name | Description |
value |
Timestamp |
| Returns | |
|---|---|
| Type | Description |
Api.Builder |
|
setUpdateTime(Timestamp.Builder builderForValue)
publicApi.BuildersetUpdateTime(Timestamp.BuilderbuilderForValue)Output only. Updated time.
.google.protobuf.Timestamp update_time = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Parameter | |
|---|---|
| Name | Description |
builderForValue |
Builder |
| Returns | |
|---|---|
| Type | Description |
Api.Builder |
|