Class ApiConfig (1.0.4)

ApiConfig(mapping=None, *, ignore_unknown_fields=False, **kwargs)

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

Attributes

Name	Description
`name`	`str` Output only. Resource name of the API Config. Format: projects/{project}/locations/global/apis/{api}/configs/{api_config}
`create_time`	`google.protobuf.timestamp_pb2.Timestamp` Output only. Created time.
`update_time`	`google.protobuf.timestamp_pb2.Timestamp` Output only. Updated time.
`labels`	`Sequence[google.cloud.apigateway_v1.types.ApiConfig.LabelsEntry]` Optional. Resource labels to represent user- rovided metadata. Refer to cloud documentation on labels for more details. https://cloud.google.com/compute/docs/labeling- resources
`display_name`	`str` Optional. Display name.
`gateway_service_account`	`str` 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`	`str` Output only. The ID of the associated Service Config ( https://cloud.google.com/service- infrastructure/docs/glossary#config).
`state`	`google.cloud.apigateway_v1.types.ApiConfig.State` Output only. State of the API Config.
`openapi_documents`	`Sequence[google.cloud.apigateway_v1.types.ApiConfig.OpenApiDocument]` Optional. OpenAPI specification documents. If specified, grpc_services and managed_service_configs must not be included.
`grpc_services`	`Sequence[google.cloud.apigateway_v1.types.ApiConfig.GrpcServiceDefinition]` Optional. gRPC service definition files. If specified, openapi_documents must not be included.
`managed_service_configs`	`Sequence[google.cloud.apigateway_v1.types.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.

Classes

File

File(mapping=None, *, ignore_unknown_fields=False, **kwargs)

A lightweight description of a file. .. attribute:: path

The file path (full or relative path). This is typically the path of the file when it is uploaded.

:type: str

GrpcServiceDefinition

GrpcServiceDefinition(mapping=None, *, ignore_unknown_fields=False, **kwargs)

A gRPC service definition. .. attribute:: file_descriptor_set

Input only. File descriptor set, generated by protoc.

To generate, use protoc with imports and source info included. For an example test.proto file, the following command would put the value in a new file named out.pb.

$ protoc --include_imports --include_source_info test.proto -o out.pb

:type: google.cloud.apigateway_v1.types.ApiConfig.File

LabelsEntry

LabelsEntry(mapping=None, *, ignore_unknown_fields=False, **kwargs)

The abstract base class for a message.

Parameters

Name	Description
`kwargs`	`dict` Keys and values corresponding to the fields of the message.
`mapping`	`Union[dict, .Message]` A dictionary or message to be used to determine the values for this message.
`ignore_unknown_fields`	`Optional(bool)` If True, do not raise errors for unknown fields. Only applied if `mapping` is a mapping type or there are keyword parameters.

OpenApiDocument

OpenApiDocument(mapping=None, *, ignore_unknown_fields=False, **kwargs)

An OpenAPI Specification Document describing an API. .. attribute:: document

The OpenAPI Specification document file.

:type: google.cloud.apigateway_v1.types.ApiConfig.File

State

State(value)

All the possible API Config states.