API Gateway V1 API - Class Google::Cloud::ApiGateway::V1::ApiConfig (v0.5.0)

Reference documentation and code samples for the API Gateway V1 API class Google::Cloud::ApiGateway::V1::ApiConfig.

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

Inherits

  • Object

Extended By

  • Google::Protobuf::MessageExts::ClassMethods

Includes

  • Google::Protobuf::MessageExts

Methods

#create_time

def create_time() -> ::Google::Protobuf::Timestamp
Returns

#display_name

def display_name() -> ::String
Returns
  • (::String) — Optional. Display name.

#display_name=

def display_name=(value) -> ::String
Parameter
  • value (::String) — Optional. Display name.
Returns
  • (::String) — Optional. Display name.

#gateway_service_account

def gateway_service_account() -> ::String
Returns
  • (::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.

#gateway_service_account=

def gateway_service_account=(value) -> ::String
Parameter
  • value (::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.
Returns
  • (::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.

#grpc_services

def grpc_services() -> ::Array<::Google::Cloud::ApiGateway::V1::ApiConfig::GrpcServiceDefinition>
Returns

#grpc_services=

def grpc_services=(value) -> ::Array<::Google::Cloud::ApiGateway::V1::ApiConfig::GrpcServiceDefinition>
Parameter
Returns

#labels

def labels() -> ::Google::Protobuf::Map{::String => ::String}
Returns
  • (::Google::Protobuf::Map{::String => ::String}) — 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

#labels=

def labels=(value) -> ::Google::Protobuf::Map{::String => ::String}
Parameter
  • value (::Google::Protobuf::Map{::String => ::String}) — 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
  • (::Google::Protobuf::Map{::String => ::String}) — 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

#managed_service_configs

def managed_service_configs() -> ::Array<::Google::Cloud::ApiGateway::V1::ApiConfig::File>
Returns
  • (::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.

#managed_service_configs=

def managed_service_configs=(value) -> ::Array<::Google::Cloud::ApiGateway::V1::ApiConfig::File>
Parameter
  • value (::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.
Returns
  • (::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.

#name

def name() -> ::String
Returns
  • (::String) — Output only. Resource name of the API Config. Format: projects/{project}/locations/global/apis/{api}/configs/{api_config}

#openapi_documents

def openapi_documents() -> ::Array<::Google::Cloud::ApiGateway::V1::ApiConfig::OpenApiDocument>
Returns

#openapi_documents=

def openapi_documents=(value) -> ::Array<::Google::Cloud::ApiGateway::V1::ApiConfig::OpenApiDocument>
Parameter
Returns

#service_config_id

def service_config_id() -> ::String
Returns
  • (::String) — Output only. The ID of the associated Service Config ( https://cloud.google.com/service-infrastructure/docs/glossary#config).

#state

def state() -> ::Google::Cloud::ApiGateway::V1::ApiConfig::State
Returns

#update_time

def update_time() -> ::Google::Protobuf::Timestamp
Returns