Class: Google::Apis::ApigatewayV1::ApigatewayGateway

Inherits:
Object
  • Object
show all
Includes:
Core::Hashable, Core::JsonObjectSupport
Defined in:
generated/google/apis/apigateway_v1/classes.rb,
generated/google/apis/apigateway_v1/representations.rb,
generated/google/apis/apigateway_v1/representations.rb

Overview

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.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ ApigatewayGateway

Returns a new instance of ApigatewayGateway.



516
517
518
 
# File 'generated/google/apis/apigateway_v1/classes.rb', line 516

def initialize(**args)
   update!(**args)
end

Instance Attribute Details

#api_config ⇒ String

Required. Resource name of the API Config for this Gateway. Format: projects/ project/locations/global/apis/api/configs/apiConfig Corresponds to the JSON property apiConfig

Returns:

  • (String) 


475
476
477
 
# File 'generated/google/apis/apigateway_v1/classes.rb', line 475

def api_config
  @api_config
end

#create_time ⇒ String

Output only. Created time. Corresponds to the JSON property createTime

Returns:

  • (String) 


480
481
482
 
# File 'generated/google/apis/apigateway_v1/classes.rb', line 480

def create_time
  @create_time
end

#default_hostname ⇒ String

Output only. The default API Gateway host name of the form `gateway_id-hash .region_code.gateway.dev. Corresponds to the JSON propertydefaultHostname`

Returns:

  • (String) 


486
487
488
 
# File 'generated/google/apis/apigateway_v1/classes.rb', line 486

def default_hostname
  @default_hostname
end

#display_name ⇒ String

Optional. Display name. Corresponds to the JSON property displayName

Returns:

  • (String) 


491
492
493
 
# File 'generated/google/apis/apigateway_v1/classes.rb', line 491

def display_name
  @display_name
end

#labels ⇒ Hash<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 Corresponds to the JSON property labels

Returns:

  • (Hash<String,String>) 


498
499
500
 
# File 'generated/google/apis/apigateway_v1/classes.rb', line 498

def labels
  @labels
end

#name ⇒ String

Output only. Resource name of the Gateway. Format: projects/project/ locations/location/gateways/gateway Corresponds to the JSON property name

Returns:

  • (String) 


504
505
506
 
# File 'generated/google/apis/apigateway_v1/classes.rb', line 504

def name
  @name
end

#state ⇒ String

Output only. The current state of the Gateway. Corresponds to the JSON property state

Returns:

  • (String) 


509
510
511
 
# File 'generated/google/apis/apigateway_v1/classes.rb', line 509

def state
  @state
end

#update_time ⇒ String

Output only. Updated time. Corresponds to the JSON property updateTime

Returns:

  • (String) 


514
515
516
 
# File 'generated/google/apis/apigateway_v1/classes.rb', line 514

def update_time
  @update_time
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



521
522
523
524
525
526
527
528
529
530
 
# File 'generated/google/apis/apigateway_v1/classes.rb', line 521

def update!(**args)
  @api_config = args[:api_config] if args.key?(:api_config)
  @create_time = args[:create_time] if args.key?(:create_time)
  @default_hostname = args[:default_hostname] if args.key?(:default_hostname)
  @display_name = args[:display_name] if args.key?(:display_name)
  @labels = args[:labels] if args.key?(:labels)
  @name = args[:name] if args.key?(:name)
  @state = args[:state] if args.key?(:state)
  @update_time = args[:update_time] if args.key?(:update_time)
end