View Source GoogleApi.APIGateway.V1.Model.ApigatewayApiConfig (google_api_api_gateway v0.10.0)

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

Attributes

  • createTime (type: DateTime.t, default: nil) - Output only. Created time.
  • displayName (type: String.t, default: nil) - Optional. Display name.
  • gatewayServiceAccount (type: String.t, default: nil) - 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.
  • grpcServices (type: list(GoogleApi.APIGateway.V1.Model.ApigatewayApiConfigGrpcServiceDefinition.t), default: nil) - Optional. gRPC service definition files. If specified, openapi_documents must not be included.
  • labels (type: map(), default: nil) - 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
  • managedServiceConfigs (type: list(GoogleApi.APIGateway.V1.Model.ApigatewayApiConfigFile.t), default: nil) - 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.
  • name (type: String.t, default: nil) - Output only. Resource name of the API Config. Format: projects/{project}/locations/global/apis/{api}/configs/{api_config}
  • openapiDocuments (type: list(GoogleApi.APIGateway.V1.Model.ApigatewayApiConfigOpenApiDocument.t), default: nil) - Optional. OpenAPI specification documents. If specified, grpc_services and managed_service_configs must not be included.
  • serviceConfigId (type: String.t, default: nil) - Output only. The ID of the associated Service Config ( https://cloud.google.com/service-infrastructure/docs/glossary#config).
  • state (type: String.t, default: nil) - Output only. State of the API Config.
  • updateTime (type: DateTime.t, default: nil) - Output only. Updated time.

Summary

Functions

Unwrap a decoded JSON object into its complex fields.

Types

t()

@type t() :: %GoogleApi.APIGateway.V1.Model.ApigatewayApiConfig{
  createTime: DateTime.t() | nil,
  displayName: String.t() | nil,
  gatewayServiceAccount: String.t() | nil,
  grpcServices:
    [GoogleApi.APIGateway.V1.Model.ApigatewayApiConfigGrpcServiceDefinition.t()]
    | nil,
  labels: map() | nil,
  managedServiceConfigs:
    [GoogleApi.APIGateway.V1.Model.ApigatewayApiConfigFile.t()] | nil,
  name: String.t() | nil,
  openapiDocuments:
    [GoogleApi.APIGateway.V1.Model.ApigatewayApiConfigOpenApiDocument.t()] | nil,
  serviceConfigId: String.t() | nil,
  state: String.t() | nil,
  updateTime: DateTime.t() | nil
}

Functions

decode(value, options)

@spec decode(struct(), keyword()) :: struct()

Unwrap a decoded JSON object into its complex fields.