API Gateway V1 API - Class Google::Cloud::ApiGateway::V1::Gateway (v1.1.0)

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

A Gateway is an API-aware HTTP proxy. It performs API-Method and/or API-Consumer specific actions based on an API Config such as authentication, policy enforcement, and backend selection.

Inherits

  • Object

Extended By

  • Google::Protobuf::MessageExts::ClassMethods

Includes

  • Google::Protobuf::MessageExts

Methods

#api_config

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

#api_config=

def api_config=(value) -> ::String
Parameter
  • value (::String) — Required. Resource name of the API Config for this Gateway. Format: projects/{project}/locations/global/apis/{api}/configs/{apiConfig}
Returns
  • (::String) — Required. Resource name of the API Config for this Gateway. Format: projects/{project}/locations/global/apis/{api}/configs/{apiConfig}

#create_time

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

#default_hostname

def default_hostname() -> ::String
Returns
  • (::String) — Output only. The default API Gateway host name of the form {gateway_id}-{hash}.{region_code}.gateway.dev.

#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.

#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

#name

def name() -> ::String
Returns
  • (::String) — Output only. Resource name of the Gateway. Format: projects/{project}/locations/{location}/gateways/{gateway}

#state

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

#update_time

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