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 \ V1Methods
__construct
Constructor.
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
↳ update_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< Google\Cloud\ApiGateway\V1\ApiConfig\OpenApiDocument
>
Optional. OpenAPI specification documents. If specified, grpc_services and managed_service_configs must not be included.
↳ grpc_services
array< Google\Cloud\ApiGateway\V1\ApiConfig\GrpcServiceDefinition
>
Optional. gRPC service definition files. If specified, openapi_documents must not be included.
↳ managed_service_configs
array< Google\Cloud\ApiGateway\V1\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}
string
setName
Output only. Resource name of the API Config.
Format: projects/{project}/locations/global/apis/{api}/configs/{api_config}
var
string
$this
getCreateTime
Output only. Created time.
hasCreateTime
clearCreateTime
setCreateTime
Output only. Created time.
$this
getUpdateTime
Output only. Updated time.
hasUpdateTime
clearUpdateTime
setUpdateTime
Output only. Updated time.
$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
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
$this
getDisplayName
Optional. Display name.
string
setDisplayName
Optional. Display name.
var
string
$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.
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.
var
string
$this
getServiceConfigId
Output only. The ID of the associated Service Config ( https://cloud.google.com/service-infrastructure/docs/glossary#config ).
string
setServiceConfigId
Output only. The ID of the associated Service Config ( https://cloud.google.com/service-infrastructure/docs/glossary#config ).
var
string
$this
getState
Output only. State of the API Config.
int
setState
Output only. State of the API Config.
var
int
$this
getOpenapiDocuments
Optional. OpenAPI specification documents. If specified, grpc_services and managed_service_configs must not be included.
setOpenapiDocuments
Optional. OpenAPI specification documents. If specified, grpc_services and managed_service_configs must not be included.
$this
getGrpcServices
Optional. gRPC service definition files. If specified, openapi_documents must not be included.
setGrpcServices
Optional. gRPC service definition files. If specified, openapi_documents must not be included.
$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.
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.
$this
