Class ApiConfig.Builder (0.16.0) 

public static final class ApiConfig.Builder extends GeneratedMessageV3.Builder<ApiConfig.Builder> implements ApiConfigOrBuilder

An API Configuration is a combination of settings for both the Managed Service and Gateways serving this API Config.

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

Inheritance

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

Implements

ApiConfigOrBuilder

Static Methods

getDescriptor()

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

Methods

addAllGrpcServices(Iterable<? extends ApiConfig.GrpcServiceDefinition> values)

public ApiConfig.Builder addAllGrpcServices(Iterable<? extends ApiConfig.GrpcServiceDefinition> values)

Optional. gRPC service definition files. If specified, openapi_documents must not be included.

repeated .google.events.cloud.apigateway.v1.ApiConfig.GrpcServiceDefinition grpc_services = 10;

Parameter
Name Description
values Iterable<? extends com.google.events.cloud.apigateway.v1.ApiConfig.GrpcServiceDefinition>
Returns
Type Description
ApiConfig.Builder

addAllManagedServiceConfigs(Iterable<? extends ApiConfig.File> values)

public ApiConfig.Builder addAllManagedServiceConfigs(Iterable<? extends ApiConfig.File> values)

Optional. Service Configuration files. At least one must be included when using gRPC service definitions. See https://cloud.google.com/endpoints/docs/grpc/grpc-service-config#service_configuration_overview for the expected file contents. If multiple files are specified, the files are merged with the following rules:

  • All singular scalar fields are merged using "last one wins" semantics in the order of the files uploaded.
  • Repeated fields are concatenated.
  • Singular embedded messages are merged using these rules for nested fields.

repeated .google.events.cloud.apigateway.v1.ApiConfig.File managed_service_configs = 11;

Parameter
Name Description
values Iterable<? extends com.google.events.cloud.apigateway.v1.ApiConfig.File>
Returns
Type Description
ApiConfig.Builder

addAllOpenapiDocuments(Iterable<? extends ApiConfig.OpenApiDocument> values)

public ApiConfig.Builder addAllOpenapiDocuments(Iterable<? extends ApiConfig.OpenApiDocument> values)

Optional. OpenAPI specification documents. If specified, grpc_services and managed_service_configs must not be included.

repeated .google.events.cloud.apigateway.v1.ApiConfig.OpenApiDocument openapi_documents = 9;

Parameter
Name Description
values Iterable<? extends com.google.events.cloud.apigateway.v1.ApiConfig.OpenApiDocument>
Returns
Type Description
ApiConfig.Builder

addGrpcServices(ApiConfig.GrpcServiceDefinition value)

public ApiConfig.Builder addGrpcServices(ApiConfig.GrpcServiceDefinition value)

Optional. gRPC service definition files. If specified, openapi_documents must not be included.

repeated .google.events.cloud.apigateway.v1.ApiConfig.GrpcServiceDefinition grpc_services = 10;

Parameter
Name Description
value ApiConfig.GrpcServiceDefinition
Returns
Type Description
ApiConfig.Builder

addGrpcServices(ApiConfig.GrpcServiceDefinition.Builder builderForValue)

public ApiConfig.Builder addGrpcServices(ApiConfig.GrpcServiceDefinition.Builder builderForValue)

Optional. gRPC service definition files. If specified, openapi_documents must not be included.

repeated .google.events.cloud.apigateway.v1.ApiConfig.GrpcServiceDefinition grpc_services = 10;

Parameter
Name Description
builderForValue ApiConfig.GrpcServiceDefinition.Builder
Returns
Type Description
ApiConfig.Builder

addGrpcServices(int index, ApiConfig.GrpcServiceDefinition value)

public ApiConfig.Builder addGrpcServices(int index, ApiConfig.GrpcServiceDefinition value)

Optional. gRPC service definition files. If specified, openapi_documents must not be included.

repeated .google.events.cloud.apigateway.v1.ApiConfig.GrpcServiceDefinition grpc_services = 10;

Parameters
Name Description
index int
value ApiConfig.GrpcServiceDefinition
Returns
Type Description
ApiConfig.Builder

addGrpcServices(int index, ApiConfig.GrpcServiceDefinition.Builder builderForValue)

public ApiConfig.Builder addGrpcServices(int index, ApiConfig.GrpcServiceDefinition.Builder builderForValue)

Optional. gRPC service definition files. If specified, openapi_documents must not be included.

repeated .google.events.cloud.apigateway.v1.ApiConfig.GrpcServiceDefinition grpc_services = 10;

Parameters
Name Description
index int
builderForValue ApiConfig.GrpcServiceDefinition.Builder
Returns
Type Description
ApiConfig.Builder

addGrpcServicesBuilder()

public ApiConfig.GrpcServiceDefinition.Builder addGrpcServicesBuilder()

Optional. gRPC service definition files. If specified, openapi_documents must not be included.

repeated .google.events.cloud.apigateway.v1.ApiConfig.GrpcServiceDefinition grpc_services = 10;

Returns
Type Description
ApiConfig.GrpcServiceDefinition.Builder

addGrpcServicesBuilder(int index)

public ApiConfig.GrpcServiceDefinition.Builder addGrpcServicesBuilder(int index)

Optional. gRPC service definition files. If specified, openapi_documents must not be included.

repeated .google.events.cloud.apigateway.v1.ApiConfig.GrpcServiceDefinition grpc_services = 10;

Parameter
Name Description
index int
Returns
Type Description
ApiConfig.GrpcServiceDefinition.Builder

addManagedServiceConfigs(ApiConfig.File value)

public ApiConfig.Builder addManagedServiceConfigs(ApiConfig.File value)

Optional. Service Configuration files. At least one must be included when using gRPC service definitions. See https://cloud.google.com/endpoints/docs/grpc/grpc-service-config#service_configuration_overview for the expected file contents. If multiple files are specified, the files are merged with the following rules:

  • All singular scalar fields are merged using "last one wins" semantics in the order of the files uploaded.
  • Repeated fields are concatenated.
  • Singular embedded messages are merged using these rules for nested fields.

repeated .google.events.cloud.apigateway.v1.ApiConfig.File managed_service_configs = 11;

Parameter
Name Description
value ApiConfig.File
Returns
Type Description
ApiConfig.Builder

addManagedServiceConfigs(ApiConfig.File.Builder builderForValue)

public ApiConfig.Builder addManagedServiceConfigs(ApiConfig.File.Builder builderForValue)

Optional. Service Configuration files. At least one must be included when using gRPC service definitions. See https://cloud.google.com/endpoints/docs/grpc/grpc-service-config#service_configuration_overview for the expected file contents. If multiple files are specified, the files are merged with the following rules:

  • All singular scalar fields are merged using "last one wins" semantics in the order of the files uploaded.
  • Repeated fields are concatenated.
  • Singular embedded messages are merged using these rules for nested fields.

repeated .google.events.cloud.apigateway.v1.ApiConfig.File managed_service_configs = 11;

Parameter
Name Description
builderForValue ApiConfig.File.Builder
Returns
Type Description
ApiConfig.Builder

addManagedServiceConfigs(int index, ApiConfig.File value)

public ApiConfig.Builder addManagedServiceConfigs(int index, ApiConfig.File value)

Optional. Service Configuration files. At least one must be included when using gRPC service definitions. See https://cloud.google.com/endpoints/docs/grpc/grpc-service-config#service_configuration_overview for the expected file contents. If multiple files are specified, the files are merged with the following rules:

  • All singular scalar fields are merged using "last one wins" semantics in the order of the files uploaded.
  • Repeated fields are concatenated.
  • Singular embedded messages are merged using these rules for nested fields.

repeated .google.events.cloud.apigateway.v1.ApiConfig.File managed_service_configs = 11;

Parameters
Name Description
index int
value ApiConfig.File
Returns
Type Description
ApiConfig.Builder

addManagedServiceConfigs(int index, ApiConfig.File.Builder builderForValue)

public ApiConfig.Builder addManagedServiceConfigs(int index, ApiConfig.File.Builder builderForValue)

Optional. Service Configuration files. At least one must be included when using gRPC service definitions. See https://cloud.google.com/endpoints/docs/grpc/grpc-service-config#service_configuration_overview for the expected file contents. If multiple files are specified, the files are merged with the following rules:

  • All singular scalar fields are merged using "last one wins" semantics in the order of the files uploaded.
  • Repeated fields are concatenated.
  • Singular embedded messages are merged using these rules for nested fields.

repeated .google.events.cloud.apigateway.v1.ApiConfig.File managed_service_configs = 11;

Parameters
Name Description
index int
builderForValue ApiConfig.File.Builder
Returns
Type Description
ApiConfig.Builder

addManagedServiceConfigsBuilder()

public ApiConfig.File.Builder addManagedServiceConfigsBuilder()

Optional. Service Configuration files. At least one must be included when using gRPC service definitions. See https://cloud.google.com/endpoints/docs/grpc/grpc-service-config#service_configuration_overview for the expected file contents. If multiple files are specified, the files are merged with the following rules:

  • All singular scalar fields are merged using "last one wins" semantics in the order of the files uploaded.
  • Repeated fields are concatenated.
  • Singular embedded messages are merged using these rules for nested fields.

repeated .google.events.cloud.apigateway.v1.ApiConfig.File managed_service_configs = 11;

Returns
Type Description
ApiConfig.File.Builder

addManagedServiceConfigsBuilder(int index)

public ApiConfig.File.Builder addManagedServiceConfigsBuilder(int index)

Optional. Service Configuration files. At least one must be included when using gRPC service definitions. See https://cloud.google.com/endpoints/docs/grpc/grpc-service-config#service_configuration_overview for the expected file contents. If multiple files are specified, the files are merged with the following rules:

  • All singular scalar fields are merged using "last one wins" semantics in the order of the files uploaded.
  • Repeated fields are concatenated.
  • Singular embedded messages are merged using these rules for nested fields.

repeated .google.events.cloud.apigateway.v1.ApiConfig.File managed_service_configs = 11;

Parameter
Name Description
index int
Returns
Type Description
ApiConfig.File.Builder

addOpenapiDocuments(ApiConfig.OpenApiDocument value)

public ApiConfig.Builder addOpenapiDocuments(ApiConfig.OpenApiDocument value)

Optional. OpenAPI specification documents. If specified, grpc_services and managed_service_configs must not be included.

repeated .google.events.cloud.apigateway.v1.ApiConfig.OpenApiDocument openapi_documents = 9;

Parameter
Name Description
value ApiConfig.OpenApiDocument
Returns
Type Description
ApiConfig.Builder

addOpenapiDocuments(ApiConfig.OpenApiDocument.Builder builderForValue)

public ApiConfig.Builder addOpenapiDocuments(ApiConfig.OpenApiDocument.Builder builderForValue)

Optional. OpenAPI specification documents. If specified, grpc_services and managed_service_configs must not be included.

repeated .google.events.cloud.apigateway.v1.ApiConfig.OpenApiDocument openapi_documents = 9;

Parameter
Name Description
builderForValue ApiConfig.OpenApiDocument.Builder
Returns
Type Description
ApiConfig.Builder

addOpenapiDocuments(int index, ApiConfig.OpenApiDocument value)

public ApiConfig.Builder addOpenapiDocuments(int index, ApiConfig.OpenApiDocument value)

Optional. OpenAPI specification documents. If specified, grpc_services and managed_service_configs must not be included.

repeated .google.events.cloud.apigateway.v1.ApiConfig.OpenApiDocument openapi_documents = 9;

Parameters
Name Description
index int
value ApiConfig.OpenApiDocument
Returns
Type Description
ApiConfig.Builder

addOpenapiDocuments(int index, ApiConfig.OpenApiDocument.Builder builderForValue)

public ApiConfig.Builder addOpenapiDocuments(int index, ApiConfig.OpenApiDocument.Builder builderForValue)

Optional. OpenAPI specification documents. If specified, grpc_services and managed_service_configs must not be included.

repeated .google.events.cloud.apigateway.v1.ApiConfig.OpenApiDocument openapi_documents = 9;

Parameters
Name Description
index int
builderForValue ApiConfig.OpenApiDocument.Builder
Returns
Type Description
ApiConfig.Builder

addOpenapiDocumentsBuilder()

public ApiConfig.OpenApiDocument.Builder addOpenapiDocumentsBuilder()

Optional. OpenAPI specification documents. If specified, grpc_services and managed_service_configs must not be included.

repeated .google.events.cloud.apigateway.v1.ApiConfig.OpenApiDocument openapi_documents = 9;

Returns
Type Description
ApiConfig.OpenApiDocument.Builder

addOpenapiDocumentsBuilder(int index)

public ApiConfig.OpenApiDocument.Builder addOpenapiDocumentsBuilder(int index)

Optional. OpenAPI specification documents. If specified, grpc_services and managed_service_configs must not be included.

repeated .google.events.cloud.apigateway.v1.ApiConfig.OpenApiDocument openapi_documents = 9;

Parameter
Name Description
index int
Returns
Type Description
ApiConfig.OpenApiDocument.Builder

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

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

build()

public ApiConfig build()
Returns
Type Description
ApiConfig

buildPartial()

public ApiConfig buildPartial()
Returns
Type Description
ApiConfig

clear()

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

clearCreateTime()

public ApiConfig.Builder clearCreateTime()

Output only. Created time.

.google.protobuf.Timestamp create_time = 2;

Returns
Type Description
ApiConfig.Builder

clearDisplayName()

public ApiConfig.Builder clearDisplayName()

Optional. Display name.

string display_name = 5;

Returns
Type Description
ApiConfig.Builder

This builder for chaining.

clearField(Descriptors.FieldDescriptor field)

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

clearGatewayServiceAccount()

public ApiConfig.Builder clearGatewayServiceAccount()

Immutable. The Google Cloud IAM Service Account that Gateways serving this config should use to authenticate to other services. This may either be the Service Account's email ({ACCOUNT_ID}@{PROJECT}.iam.gserviceaccount.com) or its full resource name (projects/{PROJECT}/accounts/{UNIQUE_ID}). This is most often used when the service is a GCP resource such as a Cloud Run Service or an IAP-secured service.

string gateway_service_account = 14;

Returns
Type Description
ApiConfig.Builder

This builder for chaining.

clearGrpcServices()

public ApiConfig.Builder clearGrpcServices()

Optional. gRPC service definition files. If specified, openapi_documents must not be included.

repeated .google.events.cloud.apigateway.v1.ApiConfig.GrpcServiceDefinition grpc_services = 10;

Returns
Type Description
ApiConfig.Builder

clearLabels()

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

clearManagedServiceConfigs()

public ApiConfig.Builder clearManagedServiceConfigs()

Optional. Service Configuration files. At least one must be included when using gRPC service definitions. See https://cloud.google.com/endpoints/docs/grpc/grpc-service-config#service_configuration_overview for the expected file contents. If multiple files are specified, the files are merged with the following rules:

  • All singular scalar fields are merged using "last one wins" semantics in the order of the files uploaded.
  • Repeated fields are concatenated.
  • Singular embedded messages are merged using these rules for nested fields.

repeated .google.events.cloud.apigateway.v1.ApiConfig.File managed_service_configs = 11;

Returns
Type Description
ApiConfig.Builder

clearName()

public ApiConfig.Builder clearName()

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

string name = 1;

Returns
Type Description
ApiConfig.Builder

This builder for chaining.

clearOneof(Descriptors.OneofDescriptor oneof)

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

clearOpenapiDocuments()

public ApiConfig.Builder clearOpenapiDocuments()

Optional. OpenAPI specification documents. If specified, grpc_services and managed_service_configs must not be included.

repeated .google.events.cloud.apigateway.v1.ApiConfig.OpenApiDocument openapi_documents = 9;

Returns
Type Description
ApiConfig.Builder

clearServiceConfigId()

public ApiConfig.Builder clearServiceConfigId()

Output only. The ID of the associated Service Config ( https://cloud.google.com/service-infrastructure/docs/glossary#config).

string service_config_id = 12;

Returns
Type Description
ApiConfig.Builder

This builder for chaining.

clearState()

public ApiConfig.Builder clearState()

Output only. State of the API Config.

.google.events.cloud.apigateway.v1.ApiConfig.State state = 8;

Returns
Type Description
ApiConfig.Builder

This builder for chaining.

clearUpdateTime()

public ApiConfig.Builder clearUpdateTime()

Output only. Updated time.

.google.protobuf.Timestamp update_time = 3;

Returns
Type Description
ApiConfig.Builder

clone()

public ApiConfig.Builder clone()
Returns
Type Description
ApiConfig.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 ApiConfig getDefaultInstanceForType()
Returns
Type Description
ApiConfig

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.

getGatewayServiceAccount()

public String getGatewayServiceAccount()

Immutable. The Google Cloud IAM Service Account that Gateways serving this config should use to authenticate to other services. This may either be the Service Account's email ({ACCOUNT_ID}@{PROJECT}.iam.gserviceaccount.com) or its full resource name (projects/{PROJECT}/accounts/{UNIQUE_ID}). This is most often used when the service is a GCP resource such as a Cloud Run Service or an IAP-secured service.

string gateway_service_account = 14;

Returns
Type Description
String

The gatewayServiceAccount.

getGatewayServiceAccountBytes()

public ByteString getGatewayServiceAccountBytes()

Immutable. The Google Cloud IAM Service Account that Gateways serving this config should use to authenticate to other services. This may either be the Service Account's email ({ACCOUNT_ID}@{PROJECT}.iam.gserviceaccount.com) or its full resource name (projects/{PROJECT}/accounts/{UNIQUE_ID}). This is most often used when the service is a GCP resource such as a Cloud Run Service or an IAP-secured service.

string gateway_service_account = 14;

Returns
Type Description
ByteString

The bytes for gatewayServiceAccount.

getGrpcServices(int index)

public ApiConfig.GrpcServiceDefinition getGrpcServices(int index)

Optional. gRPC service definition files. If specified, openapi_documents must not be included.

repeated .google.events.cloud.apigateway.v1.ApiConfig.GrpcServiceDefinition grpc_services = 10;

Parameter
Name Description
index int
Returns
Type Description
ApiConfig.GrpcServiceDefinition

getGrpcServicesBuilder(int index)

public ApiConfig.GrpcServiceDefinition.Builder getGrpcServicesBuilder(int index)

Optional. gRPC service definition files. If specified, openapi_documents must not be included.

repeated .google.events.cloud.apigateway.v1.ApiConfig.GrpcServiceDefinition grpc_services = 10;

Parameter
Name Description
index int
Returns
Type Description
ApiConfig.GrpcServiceDefinition.Builder

getGrpcServicesBuilderList()

public List<ApiConfig.GrpcServiceDefinition.Builder> getGrpcServicesBuilderList()

Optional. gRPC service definition files. If specified, openapi_documents must not be included.

repeated .google.events.cloud.apigateway.v1.ApiConfig.GrpcServiceDefinition grpc_services = 10;

Returns
Type Description
List<Builder>

getGrpcServicesCount()

public int getGrpcServicesCount()

Optional. gRPC service definition files. If specified, openapi_documents must not be included.

repeated .google.events.cloud.apigateway.v1.ApiConfig.GrpcServiceDefinition grpc_services = 10;

Returns
Type Description
int

getGrpcServicesList()

public List<ApiConfig.GrpcServiceDefinition> getGrpcServicesList()

Optional. gRPC service definition files. If specified, openapi_documents must not be included.

repeated .google.events.cloud.apigateway.v1.ApiConfig.GrpcServiceDefinition grpc_services = 10;

Returns
Type Description
List<GrpcServiceDefinition>

getGrpcServicesOrBuilder(int index)

public ApiConfig.GrpcServiceDefinitionOrBuilder getGrpcServicesOrBuilder(int index)

Optional. gRPC service definition files. If specified, openapi_documents must not be included.

repeated .google.events.cloud.apigateway.v1.ApiConfig.GrpcServiceDefinition grpc_services = 10;

Parameter
Name Description
index int
Returns
Type Description
ApiConfig.GrpcServiceDefinitionOrBuilder

getGrpcServicesOrBuilderList()

public List<? extends ApiConfig.GrpcServiceDefinitionOrBuilder> getGrpcServicesOrBuilderList()

Optional. gRPC service definition files. If specified, openapi_documents must not be included.

repeated .google.events.cloud.apigateway.v1.ApiConfig.GrpcServiceDefinition grpc_services = 10;

Returns
Type Description
List<? extends com.google.events.cloud.apigateway.v1.ApiConfig.GrpcServiceDefinitionOrBuilder>

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

getManagedServiceConfigs(int index)

public ApiConfig.File getManagedServiceConfigs(int index)

Optional. Service Configuration files. At least one must be included when using gRPC service definitions. See https://cloud.google.com/endpoints/docs/grpc/grpc-service-config#service_configuration_overview for the expected file contents. If multiple files are specified, the files are merged with the following rules:

  • All singular scalar fields are merged using "last one wins" semantics in the order of the files uploaded.
  • Repeated fields are concatenated.
  • Singular embedded messages are merged using these rules for nested fields.

repeated .google.events.cloud.apigateway.v1.ApiConfig.File managed_service_configs = 11;

Parameter
Name Description
index int
Returns
Type Description
ApiConfig.File

getManagedServiceConfigsBuilder(int index)

public ApiConfig.File.Builder getManagedServiceConfigsBuilder(int index)

Optional. Service Configuration files. At least one must be included when using gRPC service definitions. See https://cloud.google.com/endpoints/docs/grpc/grpc-service-config#service_configuration_overview for the expected file contents. If multiple files are specified, the files are merged with the following rules:

  • All singular scalar fields are merged using "last one wins" semantics in the order of the files uploaded.
  • Repeated fields are concatenated.
  • Singular embedded messages are merged using these rules for nested fields.

repeated .google.events.cloud.apigateway.v1.ApiConfig.File managed_service_configs = 11;

Parameter
Name Description
index int
Returns
Type Description
ApiConfig.File.Builder

getManagedServiceConfigsBuilderList()

public List<ApiConfig.File.Builder> getManagedServiceConfigsBuilderList()

Optional. Service Configuration files. At least one must be included when using gRPC service definitions. See https://cloud.google.com/endpoints/docs/grpc/grpc-service-config#service_configuration_overview for the expected file contents. If multiple files are specified, the files are merged with the following rules:

  • All singular scalar fields are merged using "last one wins" semantics in the order of the files uploaded.
  • Repeated fields are concatenated.
  • Singular embedded messages are merged using these rules for nested fields.

repeated .google.events.cloud.apigateway.v1.ApiConfig.File managed_service_configs = 11;

Returns
Type Description
List<Builder>

getManagedServiceConfigsCount()

public int getManagedServiceConfigsCount()

Optional. Service Configuration files. At least one must be included when using gRPC service definitions. See https://cloud.google.com/endpoints/docs/grpc/grpc-service-config#service_configuration_overview for the expected file contents. If multiple files are specified, the files are merged with the following rules:

  • All singular scalar fields are merged using "last one wins" semantics in the order of the files uploaded.
  • Repeated fields are concatenated.
  • Singular embedded messages are merged using these rules for nested fields.

repeated .google.events.cloud.apigateway.v1.ApiConfig.File managed_service_configs = 11;

Returns
Type Description
int

getManagedServiceConfigsList()

public List<ApiConfig.File> getManagedServiceConfigsList()

Optional. Service Configuration files. At least one must be included when using gRPC service definitions. See https://cloud.google.com/endpoints/docs/grpc/grpc-service-config#service_configuration_overview for the expected file contents. If multiple files are specified, the files are merged with the following rules:

  • All singular scalar fields are merged using "last one wins" semantics in the order of the files uploaded.
  • Repeated fields are concatenated.
  • Singular embedded messages are merged using these rules for nested fields.

repeated .google.events.cloud.apigateway.v1.ApiConfig.File managed_service_configs = 11;

Returns
Type Description
List<File>

getManagedServiceConfigsOrBuilder(int index)

public ApiConfig.FileOrBuilder getManagedServiceConfigsOrBuilder(int index)

Optional. Service Configuration files. At least one must be included when using gRPC service definitions. See https://cloud.google.com/endpoints/docs/grpc/grpc-service-config#service_configuration_overview for the expected file contents. If multiple files are specified, the files are merged with the following rules:

  • All singular scalar fields are merged using "last one wins" semantics in the order of the files uploaded.
  • Repeated fields are concatenated.
  • Singular embedded messages are merged using these rules for nested fields.

repeated .google.events.cloud.apigateway.v1.ApiConfig.File managed_service_configs = 11;

Parameter
Name Description
index int
Returns
Type Description
ApiConfig.FileOrBuilder

getManagedServiceConfigsOrBuilderList()

public List<? extends ApiConfig.FileOrBuilder> getManagedServiceConfigsOrBuilderList()

Optional. Service Configuration files. At least one must be included when using gRPC service definitions. See https://cloud.google.com/endpoints/docs/grpc/grpc-service-config#service_configuration_overview for the expected file contents. If multiple files are specified, the files are merged with the following rules:

  • All singular scalar fields are merged using "last one wins" semantics in the order of the files uploaded.
  • Repeated fields are concatenated.
  • Singular embedded messages are merged using these rules for nested fields.

repeated .google.events.cloud.apigateway.v1.ApiConfig.File managed_service_configs = 11;

Returns
Type Description
List<? extends com.google.events.cloud.apigateway.v1.ApiConfig.FileOrBuilder>

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 Config. Format: projects/{project}/locations/global/apis/{api}/configs/{api_config}

string name = 1;

Returns
Type Description
String

The name.

getNameBytes()

public ByteString getNameBytes()

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

string name = 1;

Returns
Type Description
ByteString

The bytes for name.

getOpenapiDocuments(int index)

public ApiConfig.OpenApiDocument getOpenapiDocuments(int index)

Optional. OpenAPI specification documents. If specified, grpc_services and managed_service_configs must not be included.

repeated .google.events.cloud.apigateway.v1.ApiConfig.OpenApiDocument openapi_documents = 9;

Parameter
Name Description
index int
Returns
Type Description
ApiConfig.OpenApiDocument

getOpenapiDocumentsBuilder(int index)

public ApiConfig.OpenApiDocument.Builder getOpenapiDocumentsBuilder(int index)

Optional. OpenAPI specification documents. If specified, grpc_services and managed_service_configs must not be included.

repeated .google.events.cloud.apigateway.v1.ApiConfig.OpenApiDocument openapi_documents = 9;

Parameter
Name Description
index int
Returns
Type Description
ApiConfig.OpenApiDocument.Builder

getOpenapiDocumentsBuilderList()

public List<ApiConfig.OpenApiDocument.Builder> getOpenapiDocumentsBuilderList()

Optional. OpenAPI specification documents. If specified, grpc_services and managed_service_configs must not be included.

repeated .google.events.cloud.apigateway.v1.ApiConfig.OpenApiDocument openapi_documents = 9;

Returns
Type Description
List<Builder>

getOpenapiDocumentsCount()

public int getOpenapiDocumentsCount()

Optional. OpenAPI specification documents. If specified, grpc_services and managed_service_configs must not be included.

repeated .google.events.cloud.apigateway.v1.ApiConfig.OpenApiDocument openapi_documents = 9;

Returns
Type Description
int

getOpenapiDocumentsList()

public List<ApiConfig.OpenApiDocument> getOpenapiDocumentsList()

Optional. OpenAPI specification documents. If specified, grpc_services and managed_service_configs must not be included.

repeated .google.events.cloud.apigateway.v1.ApiConfig.OpenApiDocument openapi_documents = 9;

Returns
Type Description
List<OpenApiDocument>

getOpenapiDocumentsOrBuilder(int index)

public ApiConfig.OpenApiDocumentOrBuilder getOpenapiDocumentsOrBuilder(int index)

Optional. OpenAPI specification documents. If specified, grpc_services and managed_service_configs must not be included.

repeated .google.events.cloud.apigateway.v1.ApiConfig.OpenApiDocument openapi_documents = 9;

Parameter
Name Description
index int
Returns
Type Description
ApiConfig.OpenApiDocumentOrBuilder

getOpenapiDocumentsOrBuilderList()

public List<? extends ApiConfig.OpenApiDocumentOrBuilder> getOpenapiDocumentsOrBuilderList()

Optional. OpenAPI specification documents. If specified, grpc_services and managed_service_configs must not be included.

repeated .google.events.cloud.apigateway.v1.ApiConfig.OpenApiDocument openapi_documents = 9;

Returns
Type Description
List<? extends com.google.events.cloud.apigateway.v1.ApiConfig.OpenApiDocumentOrBuilder>

getServiceConfigId()

public String getServiceConfigId()

Output only. The ID of the associated Service Config ( https://cloud.google.com/service-infrastructure/docs/glossary#config).

string service_config_id = 12;

Returns
Type Description
String

The serviceConfigId.

getServiceConfigIdBytes()

public ByteString getServiceConfigIdBytes()

Output only. The ID of the associated Service Config ( https://cloud.google.com/service-infrastructure/docs/glossary#config).

string service_config_id = 12;

Returns
Type Description
ByteString

The bytes for serviceConfigId.

getState()

public ApiConfig.State getState()

Output only. State of the API Config.

.google.events.cloud.apigateway.v1.ApiConfig.State state = 8;

Returns
Type Description
ApiConfig.State

The state.

getStateValue()

public int getStateValue()

Output only. State of the API Config.

.google.events.cloud.apigateway.v1.ApiConfig.State state = 8;

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 ApiConfig.Builder mergeCreateTime(Timestamp value)

Output only. Created time.

.google.protobuf.Timestamp create_time = 2;

Parameter
Name Description
value Timestamp
Returns
Type Description
ApiConfig.Builder

mergeFrom(ApiConfig other)

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

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

mergeFrom(Message other)

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

mergeUnknownFields(UnknownFieldSet unknownFields)

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

mergeUpdateTime(Timestamp value)

public ApiConfig.Builder mergeUpdateTime(Timestamp value)

Output only. Updated time.

.google.protobuf.Timestamp update_time = 3;

Parameter
Name Description
value Timestamp
Returns
Type Description
ApiConfig.Builder

putAllLabels(Map<String,String> values)

public ApiConfig.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
ApiConfig.Builder

putLabels(String key, String value)

public ApiConfig.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
ApiConfig.Builder

removeGrpcServices(int index)

public ApiConfig.Builder removeGrpcServices(int index)

Optional. gRPC service definition files. If specified, openapi_documents must not be included.

repeated .google.events.cloud.apigateway.v1.ApiConfig.GrpcServiceDefinition grpc_services = 10;

Parameter
Name Description
index int
Returns
Type Description
ApiConfig.Builder

removeLabels(String key)

public ApiConfig.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
ApiConfig.Builder

removeManagedServiceConfigs(int index)

public ApiConfig.Builder removeManagedServiceConfigs(int index)

Optional. Service Configuration files. At least one must be included when using gRPC service definitions. See https://cloud.google.com/endpoints/docs/grpc/grpc-service-config#service_configuration_overview for the expected file contents. If multiple files are specified, the files are merged with the following rules:

  • All singular scalar fields are merged using "last one wins" semantics in the order of the files uploaded.
  • Repeated fields are concatenated.
  • Singular embedded messages are merged using these rules for nested fields.

repeated .google.events.cloud.apigateway.v1.ApiConfig.File managed_service_configs = 11;

Parameter
Name Description
index int
Returns
Type Description
ApiConfig.Builder

removeOpenapiDocuments(int index)

public ApiConfig.Builder removeOpenapiDocuments(int index)

Optional. OpenAPI specification documents. If specified, grpc_services and managed_service_configs must not be included.

repeated .google.events.cloud.apigateway.v1.ApiConfig.OpenApiDocument openapi_documents = 9;

Parameter
Name Description
index int
Returns
Type Description
ApiConfig.Builder

setCreateTime(Timestamp value)

public ApiConfig.Builder setCreateTime(Timestamp value)

Output only. Created time.

.google.protobuf.Timestamp create_time = 2;

Parameter
Name Description
value Timestamp
Returns
Type Description
ApiConfig.Builder

setCreateTime(Timestamp.Builder builderForValue)

public ApiConfig.Builder setCreateTime(Timestamp.Builder builderForValue)

Output only. Created time.

.google.protobuf.Timestamp create_time = 2;

Parameter
Name Description
builderForValue Builder
Returns
Type Description
ApiConfig.Builder

setDisplayName(String value)

public ApiConfig.Builder setDisplayName(String value)

Optional. Display name.

string display_name = 5;

Parameter
Name Description
value String

The displayName to set.
Returns
Type Description
ApiConfig.Builder

This builder for chaining.

setDisplayNameBytes(ByteString value)

public ApiConfig.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
ApiConfig.Builder

This builder for chaining.

setField(Descriptors.FieldDescriptor field, Object value)

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

setGatewayServiceAccount(String value)

public ApiConfig.Builder setGatewayServiceAccount(String value)

Immutable. The Google Cloud IAM Service Account that Gateways serving this config should use to authenticate to other services. This may either be the Service Account's email ({ACCOUNT_ID}@{PROJECT}.iam.gserviceaccount.com) or its full resource name (projects/{PROJECT}/accounts/{UNIQUE_ID}). This is most often used when the service is a GCP resource such as a Cloud Run Service or an IAP-secured service.

string gateway_service_account = 14;

Parameter
Name Description
value String

The gatewayServiceAccount to set.
Returns
Type Description
ApiConfig.Builder

This builder for chaining.

setGatewayServiceAccountBytes(ByteString value)

public ApiConfig.Builder setGatewayServiceAccountBytes(ByteString value)

Immutable. The Google Cloud IAM Service Account that Gateways serving this config should use to authenticate to other services. This may either be the Service Account's email ({ACCOUNT_ID}@{PROJECT}.iam.gserviceaccount.com) or its full resource name (projects/{PROJECT}/accounts/{UNIQUE_ID}). This is most often used when the service is a GCP resource such as a Cloud Run Service or an IAP-secured service.

string gateway_service_account = 14;

Parameter
Name Description
value ByteString

The bytes for gatewayServiceAccount to set.
Returns
Type Description
ApiConfig.Builder

This builder for chaining.

setGrpcServices(int index, ApiConfig.GrpcServiceDefinition value)

public ApiConfig.Builder setGrpcServices(int index, ApiConfig.GrpcServiceDefinition value)

Optional. gRPC service definition files. If specified, openapi_documents must not be included.

repeated .google.events.cloud.apigateway.v1.ApiConfig.GrpcServiceDefinition grpc_services = 10;

Parameters
Name Description
index int
value ApiConfig.GrpcServiceDefinition
Returns
Type Description
ApiConfig.Builder

setGrpcServices(int index, ApiConfig.GrpcServiceDefinition.Builder builderForValue)

public ApiConfig.Builder setGrpcServices(int index, ApiConfig.GrpcServiceDefinition.Builder builderForValue)

Optional. gRPC service definition files. If specified, openapi_documents must not be included.

repeated .google.events.cloud.apigateway.v1.ApiConfig.GrpcServiceDefinition grpc_services = 10;

Parameters
Name Description
index int
builderForValue ApiConfig.GrpcServiceDefinition.Builder
Returns
Type Description
ApiConfig.Builder

setManagedServiceConfigs(int index, ApiConfig.File value)

public ApiConfig.Builder setManagedServiceConfigs(int index, ApiConfig.File value)

Optional. Service Configuration files. At least one must be included when using gRPC service definitions. See https://cloud.google.com/endpoints/docs/grpc/grpc-service-config#service_configuration_overview for the expected file contents. If multiple files are specified, the files are merged with the following rules:

  • All singular scalar fields are merged using "last one wins" semantics in the order of the files uploaded.
  • Repeated fields are concatenated.
  • Singular embedded messages are merged using these rules for nested fields.

repeated .google.events.cloud.apigateway.v1.ApiConfig.File managed_service_configs = 11;

Parameters
Name Description
index int
value ApiConfig.File
Returns
Type Description
ApiConfig.Builder

setManagedServiceConfigs(int index, ApiConfig.File.Builder builderForValue)

public ApiConfig.Builder setManagedServiceConfigs(int index, ApiConfig.File.Builder builderForValue)

Optional. Service Configuration files. At least one must be included when using gRPC service definitions. See https://cloud.google.com/endpoints/docs/grpc/grpc-service-config#service_configuration_overview for the expected file contents. If multiple files are specified, the files are merged with the following rules:

  • All singular scalar fields are merged using "last one wins" semantics in the order of the files uploaded.
  • Repeated fields are concatenated.
  • Singular embedded messages are merged using these rules for nested fields.

repeated .google.events.cloud.apigateway.v1.ApiConfig.File managed_service_configs = 11;

Parameters
Name Description
index int
builderForValue ApiConfig.File.Builder
Returns
Type Description
ApiConfig.Builder

setName(String value)

public ApiConfig.Builder setName(String value)

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

string name = 1;

Parameter
Name Description
value String

The name to set.
Returns
Type Description
ApiConfig.Builder

This builder for chaining.

setNameBytes(ByteString value)

public ApiConfig.Builder setNameBytes(ByteString value)

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

string name = 1;

Parameter
Name Description
value ByteString

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

This builder for chaining.

setOpenapiDocuments(int index, ApiConfig.OpenApiDocument value)

public ApiConfig.Builder setOpenapiDocuments(int index, ApiConfig.OpenApiDocument value)

Optional. OpenAPI specification documents. If specified, grpc_services and managed_service_configs must not be included.

repeated .google.events.cloud.apigateway.v1.ApiConfig.OpenApiDocument openapi_documents = 9;

Parameters
Name Description
index int
value ApiConfig.OpenApiDocument
Returns
Type Description
ApiConfig.Builder

setOpenapiDocuments(int index, ApiConfig.OpenApiDocument.Builder builderForValue)

public ApiConfig.Builder setOpenapiDocuments(int index, ApiConfig.OpenApiDocument.Builder builderForValue)

Optional. OpenAPI specification documents. If specified, grpc_services and managed_service_configs must not be included.

repeated .google.events.cloud.apigateway.v1.ApiConfig.OpenApiDocument openapi_documents = 9;

Parameters
Name Description
index int
builderForValue ApiConfig.OpenApiDocument.Builder
Returns
Type Description
ApiConfig.Builder

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

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

setServiceConfigId(String value)

public ApiConfig.Builder setServiceConfigId(String value)

Output only. The ID of the associated Service Config ( https://cloud.google.com/service-infrastructure/docs/glossary#config).

string service_config_id = 12;

Parameter
Name Description
value String

The serviceConfigId to set.
Returns
Type Description
ApiConfig.Builder

This builder for chaining.

setServiceConfigIdBytes(ByteString value)

public ApiConfig.Builder setServiceConfigIdBytes(ByteString value)

Output only. The ID of the associated Service Config ( https://cloud.google.com/service-infrastructure/docs/glossary#config).

string service_config_id = 12;

Parameter
Name Description
value ByteString

The bytes for serviceConfigId to set.
Returns
Type Description
ApiConfig.Builder

This builder for chaining.

setState(ApiConfig.State value)

public ApiConfig.Builder setState(ApiConfig.State value)

Output only. State of the API Config.

.google.events.cloud.apigateway.v1.ApiConfig.State state = 8;

Parameter
Name Description
value ApiConfig.State

The state to set.
Returns
Type Description
ApiConfig.Builder

This builder for chaining.

setStateValue(int value)

public ApiConfig.Builder setStateValue(int value)

Output only. State of the API Config.

.google.events.cloud.apigateway.v1.ApiConfig.State state = 8;

Parameter
Name Description
value int

The enum numeric value on the wire for state to set.
Returns
Type Description
ApiConfig.Builder

This builder for chaining.

setUnknownFields(UnknownFieldSet unknownFields)

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

setUpdateTime(Timestamp value)

public ApiConfig.Builder setUpdateTime(Timestamp value)

Output only. Updated time.

.google.protobuf.Timestamp update_time = 3;

Parameter
Name Description
value Timestamp
Returns
Type Description
ApiConfig.Builder

setUpdateTime(Timestamp.Builder builderForValue)

public ApiConfig.Builder setUpdateTime(Timestamp.Builder builderForValue)

Output only. Updated time.

.google.protobuf.Timestamp update_time = 3;

Parameter
Name Description
builderForValue Builder
Returns
Type Description
ApiConfig.Builder