public static final class Api.Builder extends com.google.protobuf.GeneratedMessageV3.Builder<Api.Builder> implements ApiOrBuilder
An API that can be served by one or more Gateways.Protobuf type
google.cloud.apigateway.v1.Api| Modifier and Type | Method and Description |
|---|---|
Api.Builder |
addRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field,
Object value) |
Api |
build() |
Api |
buildPartial() |
Api.Builder |
clear() |
Api.Builder |
clearCreateTime()
Output only.
|
Api.Builder |
clearDisplayName()
Optional.
|
Api.Builder |
clearField(com.google.protobuf.Descriptors.FieldDescriptor field) |
Api.Builder |
clearLabels() |
Api.Builder |
clearManagedService()
Optional.
|
Api.Builder |
clearName()
Output only.
|
Api.Builder |
clearOneof(com.google.protobuf.Descriptors.OneofDescriptor oneof) |
Api.Builder |
clearState()
Output only.
|
Api.Builder |
clearUpdateTime()
Output only.
|
Api.Builder |
clone() |
boolean |
containsLabels(String key)
Optional.
|
com.google.protobuf.Timestamp |
getCreateTime()
Output only.
|
com.google.protobuf.Timestamp.Builder |
getCreateTimeBuilder()
Output only.
|
com.google.protobuf.TimestampOrBuilder |
getCreateTimeOrBuilder()
Output only.
|
Api |
getDefaultInstanceForType() |
static com.google.protobuf.Descriptors.Descriptor |
getDescriptor() |
com.google.protobuf.Descriptors.Descriptor |
getDescriptorForType() |
String |
getDisplayName()
Optional.
|
com.google.protobuf.ByteString |
getDisplayNameBytes()
Optional.
|
Map<String,String> |
getLabels()
Deprecated.
|
int |
getLabelsCount()
Optional.
|
Map<String,String> |
getLabelsMap()
Optional.
|
String |
getLabelsOrDefault(String key,
String defaultValue)
Optional.
|
String |
getLabelsOrThrow(String key)
Optional.
|
String |
getManagedService()
Optional.
|
com.google.protobuf.ByteString |
getManagedServiceBytes()
Optional.
|
Map<String,String> |
getMutableLabels()
Deprecated.
|
String |
getName()
Output only.
|
com.google.protobuf.ByteString |
getNameBytes()
Output only.
|
Api.State |
getState()
Output only.
|
int |
getStateValue()
Output only.
|
com.google.protobuf.Timestamp |
getUpdateTime()
Output only.
|
com.google.protobuf.Timestamp.Builder |
getUpdateTimeBuilder()
Output only.
|
com.google.protobuf.TimestampOrBuilder |
getUpdateTimeOrBuilder()
Output only.
|
boolean |
hasCreateTime()
Output only.
|
boolean |
hasUpdateTime()
Output only.
|
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable |
internalGetFieldAccessorTable() |
protected com.google.protobuf.MapField |
internalGetMapField(int number) |
protected com.google.protobuf.MapField |
internalGetMutableMapField(int number) |
boolean |
isInitialized() |
Api.Builder |
mergeCreateTime(com.google.protobuf.Timestamp value)
Output only.
|
Api.Builder |
mergeFrom(Api other) |
Api.Builder |
mergeFrom(com.google.protobuf.CodedInputStream input,
com.google.protobuf.ExtensionRegistryLite extensionRegistry) |
Api.Builder |
mergeFrom(com.google.protobuf.Message other) |
Api.Builder |
mergeUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields) |
Api.Builder |
mergeUpdateTime(com.google.protobuf.Timestamp value)
Output only.
|
Api.Builder |
putAllLabels(Map<String,String> values)
Optional.
|
Api.Builder |
putLabels(String key,
String value)
Optional.
|
Api.Builder |
removeLabels(String key)
Optional.
|
Api.Builder |
setCreateTime(com.google.protobuf.Timestamp.Builder builderForValue)
Output only.
|
Api.Builder |
setCreateTime(com.google.protobuf.Timestamp value)
Output only.
|
Api.Builder |
setDisplayName(String value)
Optional.
|
Api.Builder |
setDisplayNameBytes(com.google.protobuf.ByteString value)
Optional.
|
Api.Builder |
setField(com.google.protobuf.Descriptors.FieldDescriptor field,
Object value) |
Api.Builder |
setManagedService(String value)
Optional.
|
Api.Builder |
setManagedServiceBytes(com.google.protobuf.ByteString value)
Optional.
|
Api.Builder |
setName(String value)
Output only.
|
Api.Builder |
setNameBytes(com.google.protobuf.ByteString value)
Output only.
|
Api.Builder |
setRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field,
int index,
Object value) |
Api.Builder |
setState(Api.State value)
Output only.
|
Api.Builder |
setStateValue(int value)
Output only.
|
Api.Builder |
setUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields) |
Api.Builder |
setUpdateTime(com.google.protobuf.Timestamp.Builder builderForValue)
Output only.
|
Api.Builder |
setUpdateTime(com.google.protobuf.Timestamp value)
Output only.
|
getAllFields, getField, getFieldBuilder, getOneofFieldDescriptor, getParentForChildren, getRepeatedField, getRepeatedFieldBuilder, getRepeatedFieldCount, getUnknownFields, getUnknownFieldSetBuilder, hasField, hasOneof, isClean, markClean, mergeUnknownLengthDelimitedField, mergeUnknownVarintField, newBuilderForField, onBuilt, onChanged, parseUnknownField, setUnknownFieldSetBuilder, setUnknownFieldsProto3findInitializationErrors, getInitializationErrorString, internalMergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, newUninitializedMessageException, toStringaddAll, addAll, mergeDelimitedFrom, mergeDelimitedFrom, mergeFrom, newUninitializedMessageExceptionequals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, waitfindInitializationErrors, getAllFields, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneofpublic static final com.google.protobuf.Descriptors.Descriptor getDescriptor()
protected com.google.protobuf.MapField internalGetMapField(int number)
internalGetMapField in class com.google.protobuf.GeneratedMessageV3.Builder<Api.Builder>protected com.google.protobuf.MapField internalGetMutableMapField(int number)
internalGetMutableMapField in class com.google.protobuf.GeneratedMessageV3.Builder<Api.Builder>protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3.Builder<Api.Builder>public Api.Builder clear()
clear in interface com.google.protobuf.Message.Builderclear in interface com.google.protobuf.MessageLite.Builderclear in class com.google.protobuf.GeneratedMessageV3.Builder<Api.Builder>public com.google.protobuf.Descriptors.Descriptor getDescriptorForType()
getDescriptorForType in interface com.google.protobuf.Message.BuildergetDescriptorForType in interface com.google.protobuf.MessageOrBuildergetDescriptorForType in class com.google.protobuf.GeneratedMessageV3.Builder<Api.Builder>public Api getDefaultInstanceForType()
getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuildergetDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilderpublic Api build()
build in interface com.google.protobuf.Message.Builderbuild in interface com.google.protobuf.MessageLite.Builderpublic Api buildPartial()
buildPartial in interface com.google.protobuf.Message.BuilderbuildPartial in interface com.google.protobuf.MessageLite.Builderpublic Api.Builder clone()
clone in interface com.google.protobuf.Message.Builderclone in interface com.google.protobuf.MessageLite.Builderclone in class com.google.protobuf.GeneratedMessageV3.Builder<Api.Builder>public Api.Builder setField(com.google.protobuf.Descriptors.FieldDescriptor field, Object value)
setField in interface com.google.protobuf.Message.BuildersetField in class com.google.protobuf.GeneratedMessageV3.Builder<Api.Builder>public Api.Builder clearField(com.google.protobuf.Descriptors.FieldDescriptor field)
clearField in interface com.google.protobuf.Message.BuilderclearField in class com.google.protobuf.GeneratedMessageV3.Builder<Api.Builder>public Api.Builder clearOneof(com.google.protobuf.Descriptors.OneofDescriptor oneof)
clearOneof in interface com.google.protobuf.Message.BuilderclearOneof in class com.google.protobuf.GeneratedMessageV3.Builder<Api.Builder>public Api.Builder setRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, int index, Object value)
setRepeatedField in interface com.google.protobuf.Message.BuildersetRepeatedField in class com.google.protobuf.GeneratedMessageV3.Builder<Api.Builder>public Api.Builder addRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, Object value)
addRepeatedField in interface com.google.protobuf.Message.BuilderaddRepeatedField in class com.google.protobuf.GeneratedMessageV3.Builder<Api.Builder>public Api.Builder mergeFrom(com.google.protobuf.Message other)
mergeFrom in interface com.google.protobuf.Message.BuildermergeFrom in class com.google.protobuf.AbstractMessage.Builder<Api.Builder>public Api.Builder mergeFrom(Api other)
public final boolean isInitialized()
isInitialized in interface com.google.protobuf.MessageLiteOrBuilderisInitialized in class com.google.protobuf.GeneratedMessageV3.Builder<Api.Builder>public Api.Builder mergeFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
mergeFrom in interface com.google.protobuf.Message.BuildermergeFrom in interface com.google.protobuf.MessageLite.BuildermergeFrom in class com.google.protobuf.AbstractMessage.Builder<Api.Builder>IOExceptionpublic String getName()
Output only. Resource name of the API.
Format: projects/{project}/locations/global/apis/{api}
string name = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];getName in interface ApiOrBuilderpublic com.google.protobuf.ByteString getNameBytes()
Output only. Resource name of the API.
Format: projects/{project}/locations/global/apis/{api}
string name = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];getNameBytes in interface ApiOrBuilderpublic Api.Builder setName(String value)
Output only. Resource name of the API.
Format: projects/{project}/locations/global/apis/{api}
string name = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];value - The name to set.public Api.Builder clearName()
Output only. Resource name of the API.
Format: projects/{project}/locations/global/apis/{api}
string name = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];public Api.Builder setNameBytes(com.google.protobuf.ByteString value)
Output only. Resource name of the API.
Format: projects/{project}/locations/global/apis/{api}
string name = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];value - The bytes for name to set.public boolean hasCreateTime()
Output only. Created time.
.google.protobuf.Timestamp create_time = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];
hasCreateTime in interface ApiOrBuilderpublic com.google.protobuf.Timestamp getCreateTime()
Output only. Created time.
.google.protobuf.Timestamp create_time = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];
getCreateTime in interface ApiOrBuilderpublic Api.Builder setCreateTime(com.google.protobuf.Timestamp value)
Output only. Created time.
.google.protobuf.Timestamp create_time = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];
public Api.Builder setCreateTime(com.google.protobuf.Timestamp.Builder builderForValue)
Output only. Created time.
.google.protobuf.Timestamp create_time = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];
public Api.Builder mergeCreateTime(com.google.protobuf.Timestamp value)
Output only. Created time.
.google.protobuf.Timestamp create_time = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];
public Api.Builder clearCreateTime()
Output only. Created time.
.google.protobuf.Timestamp create_time = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];
public com.google.protobuf.Timestamp.Builder getCreateTimeBuilder()
Output only. Created time.
.google.protobuf.Timestamp create_time = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];
public com.google.protobuf.TimestampOrBuilder getCreateTimeOrBuilder()
Output only. Created time.
.google.protobuf.Timestamp create_time = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];
getCreateTimeOrBuilder in interface ApiOrBuilderpublic boolean hasUpdateTime()
Output only. Updated time.
.google.protobuf.Timestamp update_time = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];
hasUpdateTime in interface ApiOrBuilderpublic com.google.protobuf.Timestamp getUpdateTime()
Output only. Updated time.
.google.protobuf.Timestamp update_time = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];
getUpdateTime in interface ApiOrBuilderpublic Api.Builder setUpdateTime(com.google.protobuf.Timestamp value)
Output only. Updated time.
.google.protobuf.Timestamp update_time = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];
public Api.Builder setUpdateTime(com.google.protobuf.Timestamp.Builder builderForValue)
Output only. Updated time.
.google.protobuf.Timestamp update_time = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];
public Api.Builder mergeUpdateTime(com.google.protobuf.Timestamp value)
Output only. Updated time.
.google.protobuf.Timestamp update_time = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];
public Api.Builder clearUpdateTime()
Output only. Updated time.
.google.protobuf.Timestamp update_time = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];
public com.google.protobuf.Timestamp.Builder getUpdateTimeBuilder()
Output only. Updated time.
.google.protobuf.Timestamp update_time = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];
public com.google.protobuf.TimestampOrBuilder getUpdateTimeOrBuilder()
Output only. Updated time.
.google.protobuf.Timestamp update_time = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];
getUpdateTimeOrBuilder in interface ApiOrBuilderpublic int getLabelsCount()
ApiOrBuilderOptional. 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];getLabelsCount in interface ApiOrBuilderpublic 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 [(.google.api.field_behavior) = OPTIONAL];containsLabels in interface ApiOrBuilder@Deprecated public Map<String,String> getLabels()
getLabelsMap() instead.getLabels in interface ApiOrBuilderpublic 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 [(.google.api.field_behavior) = OPTIONAL];getLabelsMap in interface ApiOrBuilderpublic 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 [(.google.api.field_behavior) = OPTIONAL];getLabelsOrDefault in interface ApiOrBuilderpublic 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 [(.google.api.field_behavior) = OPTIONAL];getLabelsOrThrow in interface ApiOrBuilderpublic Api.Builder clearLabels()
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 [(.google.api.field_behavior) = OPTIONAL];@Deprecated public Map<String,String> getMutableLabels()
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 [(.google.api.field_behavior) = OPTIONAL];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 [(.google.api.field_behavior) = OPTIONAL];public String getDisplayName()
Optional. Display name.
string display_name = 5 [(.google.api.field_behavior) = OPTIONAL];getDisplayName in interface ApiOrBuilderpublic com.google.protobuf.ByteString getDisplayNameBytes()
Optional. Display name.
string display_name = 5 [(.google.api.field_behavior) = OPTIONAL];getDisplayNameBytes in interface ApiOrBuilderpublic Api.Builder setDisplayName(String value)
Optional. Display name.
string display_name = 5 [(.google.api.field_behavior) = OPTIONAL];value - The displayName to set.public Api.Builder clearDisplayName()
Optional. Display name.
string display_name = 5 [(.google.api.field_behavior) = OPTIONAL];public Api.Builder setDisplayNameBytes(com.google.protobuf.ByteString value)
Optional. Display name.
string display_name = 5 [(.google.api.field_behavior) = OPTIONAL];value - The bytes for displayName to set.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 [(.google.api.field_behavior) = IMMUTABLE, (.google.api.field_behavior) = OPTIONAL, (.google.api.resource_reference) = { ... }
getManagedService in interface ApiOrBuilderpublic com.google.protobuf.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 [(.google.api.field_behavior) = IMMUTABLE, (.google.api.field_behavior) = OPTIONAL, (.google.api.resource_reference) = { ... }
getManagedServiceBytes in interface ApiOrBuilderpublic 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 [(.google.api.field_behavior) = IMMUTABLE, (.google.api.field_behavior) = OPTIONAL, (.google.api.resource_reference) = { ... }
value - The managedService to set.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 [(.google.api.field_behavior) = IMMUTABLE, (.google.api.field_behavior) = OPTIONAL, (.google.api.resource_reference) = { ... }
public Api.Builder setManagedServiceBytes(com.google.protobuf.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 [(.google.api.field_behavior) = IMMUTABLE, (.google.api.field_behavior) = OPTIONAL, (.google.api.resource_reference) = { ... }
value - The bytes for managedService to set.public int getStateValue()
Output only. State of the API.
.google.cloud.apigateway.v1.Api.State state = 12 [(.google.api.field_behavior) = OUTPUT_ONLY];
getStateValue in interface ApiOrBuilderpublic Api.Builder setStateValue(int value)
Output only. State of the API.
.google.cloud.apigateway.v1.Api.State state = 12 [(.google.api.field_behavior) = OUTPUT_ONLY];
value - The enum numeric value on the wire for state to set.public Api.State getState()
Output only. State of the API.
.google.cloud.apigateway.v1.Api.State state = 12 [(.google.api.field_behavior) = OUTPUT_ONLY];
getState in interface ApiOrBuilderpublic Api.Builder setState(Api.State value)
Output only. State of the API.
.google.cloud.apigateway.v1.Api.State state = 12 [(.google.api.field_behavior) = OUTPUT_ONLY];
value - The state to set.public Api.Builder clearState()
Output only. State of the API.
.google.cloud.apigateway.v1.Api.State state = 12 [(.google.api.field_behavior) = OUTPUT_ONLY];
public final Api.Builder setUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)
setUnknownFields in interface com.google.protobuf.Message.BuildersetUnknownFields in class com.google.protobuf.GeneratedMessageV3.Builder<Api.Builder>public final Api.Builder mergeUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)
mergeUnknownFields in interface com.google.protobuf.Message.BuildermergeUnknownFields in class com.google.protobuf.GeneratedMessageV3.Builder<Api.Builder>Copyright © 2022 Google LLC. All rights reserved.