Class: Google::Apis::ApigatewayV1::ApigatewayApi

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

An API that can be served by one or more Gateways.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ ApigatewayApi

Returns a new instance of ApigatewayApi.



69
70
71
 
# File 'generated/google/apis/apigateway_v1/classes.rb', line 69

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

Instance Attribute Details

#create_time ⇒ String

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

Returns:

  • (String) 


32
33
34
 
# File 'generated/google/apis/apigateway_v1/classes.rb', line 32

def create_time
  @create_time
end

#display_name ⇒ String

Optional. Display name. Corresponds to the JSON property displayName

Returns:

  • (String) 


37
38
39
 
# File 'generated/google/apis/apigateway_v1/classes.rb', line 37

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>) 


44
45
46
 
# File 'generated/google/apis/apigateway_v1/classes.rb', line 44

def labels
  @labels
end

#managed_service ⇒ String

Optional. Immutable. The name of a Google Managed Service ( https://cloud. google.com/service-infrastructure/docs/glossary#managed). If not specified, a new Service will automatically be created in the same project as this API. Corresponds to the JSON property managedService

Returns:

  • (String) 


51
52
53
 
# File 'generated/google/apis/apigateway_v1/classes.rb', line 51

def managed_service
  @managed_service
end

#name ⇒ String

Output only. Resource name of the API. Format: projects/project/locations/ global/apis/api Corresponds to the JSON property name

Returns:

  • (String) 


57
58
59
 
# File 'generated/google/apis/apigateway_v1/classes.rb', line 57

def name
  @name
end

#state ⇒ String

Output only. State of the API. Corresponds to the JSON property state

Returns:

  • (String) 


62
63
64
 
# File 'generated/google/apis/apigateway_v1/classes.rb', line 62

def state
  @state
end

#update_time ⇒ String

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

Returns:

  • (String) 


67
68
69
 
# File 'generated/google/apis/apigateway_v1/classes.rb', line 67

def update_time
  @update_time
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



74
75
76
77
78
79
80
81
82
 
# File 'generated/google/apis/apigateway_v1/classes.rb', line 74

def update!(**args)
  @create_time = args[:create_time] if args.key?(:create_time)
  @display_name = args[:display_name] if args.key?(:display_name)
  @labels = args[:labels] if args.key?(:labels)
  @managed_service = args[:managed_service] if args.key?(:managed_service)
  @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