Class: Google::Apis::ApigatewayV1beta::ApigatewayApiConfig

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

Overview

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ ApigatewayApiConfig

Returns a new instance of ApigatewayApiConfig.



168
169
170
 
# File 'generated/google/apis/apigateway_v1beta/classes.rb', line 168

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

Instance Attribute Details

#create_time ⇒ String

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

Returns:

  • (String) 


93
94
95
 
# File 'generated/google/apis/apigateway_v1beta/classes.rb', line 93

def create_time
  @create_time
end

#display_name ⇒ String

Optional. Display name. Corresponds to the JSON property displayName

Returns:

  • (String) 


98
99
100
 
# File 'generated/google/apis/apigateway_v1beta/classes.rb', line 98

def display_name
  @display_name
end

#gateway_config ⇒ Google::Apis::ApigatewayV1beta::ApigatewayGatewayConfig

Configuration settings for Gateways. Corresponds to the JSON property gatewayConfig

Returns:



103
104
105
 
# File 'generated/google/apis/apigateway_v1beta/classes.rb', line 103

def gateway_config
  @gateway_config
end

#gateway_service_account ⇒ 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. Corresponds to the JSON property gatewayServiceAccount

Returns:

  • (String) 


113
114
115
 
# File 'generated/google/apis/apigateway_v1beta/classes.rb', line 113

def 
  @gateway_service_account
end

#grpc_services ⇒ Array<Google::Apis::ApigatewayV1beta::ApigatewayApiConfigGrpcServiceDefinition>

Optional. gRPC service definition files. If specified, openapi_documents must not be included. Corresponds to the JSON property grpcServices

Returns:



119
120
121
 
# File 'generated/google/apis/apigateway_v1beta/classes.rb', line 119

def grpc_services
  @grpc_services
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>) 


126
127
128
 
# File 'generated/google/apis/apigateway_v1beta/classes.rb', line 126

def labels
  @labels
end

#managed_service_configs ⇒ Array<Google::Apis::ApigatewayV1beta::ApigatewayApiConfigFile>

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. Corresponds to the JSON property managedServiceConfigs

Returns:



138
139
140
 
# File 'generated/google/apis/apigateway_v1beta/classes.rb', line 138

def managed_service_configs
  @managed_service_configs
end

#name ⇒ String

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

Returns:

  • (String) 


144
145
146
 
# File 'generated/google/apis/apigateway_v1beta/classes.rb', line 144

def name
  @name
end

#openapi_documents ⇒ Array<Google::Apis::ApigatewayV1beta::ApigatewayApiConfigOpenApiDocument>

Optional. OpenAPI specification documents. If specified, grpc_services and managed_service_configs must not be included. Corresponds to the JSON property openapiDocuments

Returns:



150
151
152
 
# File 'generated/google/apis/apigateway_v1beta/classes.rb', line 150

def openapi_documents
  @openapi_documents
end

#service_config_id ⇒ String

Output only. The ID of the associated Service Config ( https://cloud.google. com/service-infrastructure/docs/glossary#config). Corresponds to the JSON property serviceConfigId

Returns:

  • (String) 


156
157
158
 
# File 'generated/google/apis/apigateway_v1beta/classes.rb', line 156

def service_config_id
  @service_config_id
end

#state ⇒ String

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

Returns:

  • (String) 


161
162
163
 
# File 'generated/google/apis/apigateway_v1beta/classes.rb', line 161

def state
  @state
end

#update_time ⇒ String

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

Returns:

  • (String) 


166
167
168
 
# File 'generated/google/apis/apigateway_v1beta/classes.rb', line 166

def update_time
  @update_time
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



173
174
175
176
177
178
179
180
181
182
183
184
185
186
 
# File 'generated/google/apis/apigateway_v1beta/classes.rb', line 173

def update!(**args)
  @create_time = args[:create_time] if args.key?(:create_time)
  @display_name = args[:display_name] if args.key?(:display_name)
  @gateway_config = args[:gateway_config] if args.key?(:gateway_config)
  @gateway_service_account = args[:gateway_service_account] if args.key?(:gateway_service_account)
  @grpc_services = args[:grpc_services] if args.key?(:grpc_services)
  @labels = args[:labels] if args.key?(:labels)
  @managed_service_configs = args[:managed_service_configs] if args.key?(:managed_service_configs)
  @name = args[:name] if args.key?(:name)
  @openapi_documents = args[:openapi_documents] if args.key?(:openapi_documents)
  @service_config_id = args[:service_config_id] if args.key?(:service_config_id)
  @state = args[:state] if args.key?(:state)
  @update_time = args[:update_time] if args.key?(:update_time)
end