Google Cloud Api Gateway V1 Client - Class ApiConfig (2.1.1)

Reference documentation and code samples for the Google Cloud Api Gateway V1 Client class ApiConfig.

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

Generated from protobuf message google.cloud.apigateway.v1.ApiConfig

Namespace

Google \ Cloud \ ApiGateway \ V1

Methods

__construct

Constructor.

Parameters
Name Description
data array

Optional. Data for populating the Message object.
↳ name string

Output only. Resource name of the API Config. Format: projects/{project}/locations/global/apis/{api}/configs/{api_config}
↳ create_time Google\Protobuf\Timestamp

Output only. Created time.
↳ update_time Google\Protobuf\Timestamp

Output only. Updated time.
↳ labels array|Google\Protobuf\Internal\MapField

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

↳ display_name string

Optional. Display name.
↳ gateway_service_account string

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.
↳ service_config_id string

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

Output only. State of the API Config.
↳ openapi_documents array<ApiConfig\OpenApiDocument>

Optional. OpenAPI specification documents. If specified, grpc_services and managed_service_configs must not be included.
↳ grpc_services array<ApiConfig\GrpcServiceDefinition>

Optional. gRPC service definition files. If specified, openapi_documents must not be included.
↳ managed_service_configs array<ApiConfig\File>

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.

getName

Output only. Resource name of the API Config.

Format: projects/{project}/locations/global/apis/{api}/configs/{api_config}

Returns
Type Description
string

setName

Output only. Resource name of the API Config.

Format: projects/{project}/locations/global/apis/{api}/configs/{api_config}

Parameter
Name Description
var string
Returns
Type Description
$this

getCreateTime

Output only. Created time.

Returns
Type Description
Google\Protobuf\Timestamp|null

hasCreateTime

clearCreateTime

setCreateTime

Output only. Created time.

Parameter
Name Description
var Google\Protobuf\Timestamp
Returns
Type Description
$this

getUpdateTime

Output only. Updated time.

Returns
Type Description
Google\Protobuf\Timestamp|null

hasUpdateTime

clearUpdateTime

setUpdateTime

Output only. Updated time.

Parameter
Name Description
var Google\Protobuf\Timestamp
Returns
Type Description
$this

getLabels

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

Returns
Type Description
Google\Protobuf\Internal\MapField

setLabels

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

Parameter
Name Description
var array|Google\Protobuf\Internal\MapField
Returns
Type Description
$this

getDisplayName

Optional. Display name.

Returns
Type Description
string

setDisplayName

Optional. Display name.

Parameter
Name Description
var string
Returns
Type Description
$this

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.

Returns
Type Description
string

setGatewayServiceAccount

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.

Parameter
Name Description
var string
Returns
Type Description
$this

getServiceConfigId

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

Returns
Type Description
string

setServiceConfigId

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

Parameter
Name Description
var string
Returns
Type Description
$this

getState

Output only. State of the API Config.

Returns
Type Description
int Enum of type State.

setState

Output only. State of the API Config.

Parameter
Name Description
var int

Enum of type State.

Returns
Type Description
$this

getOpenapiDocuments

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

Returns
Type Description
Google\Protobuf\Internal\RepeatedField

setOpenapiDocuments

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

Parameter
Name Description
var array<ApiConfig\OpenApiDocument>
Returns
Type Description
$this

getGrpcServices

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

Returns
Type Description
Google\Protobuf\Internal\RepeatedField

setGrpcServices

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

Parameter
Name Description
var array<ApiConfig\GrpcServiceDefinition>
Returns
Type Description
$this

getManagedServiceConfigs

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.
Returns
Type Description
Google\Protobuf\Internal\RepeatedField

setManagedServiceConfigs

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.
Parameter
Name Description
var array<ApiConfig\File>
Returns
Type Description
$this

Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License, and code samples are licensed under the Apache 2.0 License. For details, see the Google Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.

Last updated 2025年10月30日 UTC.