Class: Google::Cloud::ApiGateway::V1::ApiConfig

Inherits:
Object
  • Object
show all
Extended by:
Protobuf::MessageExts::ClassMethods
Includes:
Protobuf::MessageExts
Defined in:
proto_docs/google/cloud/apigateway/v1/apigateway.rb

Overview

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

Defined Under Namespace

Modules: State Classes: File, GrpcServiceDefinition, LabelsEntry, OpenApiDocument

Instance Attribute Summary collapse

Instance Attribute Details

#create_time ⇒ ::Google::Protobuf::Timestamp (readonly)

Returns Output only. Created time.

Returns:



145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
 
# File 'proto_docs/google/cloud/apigateway/v1/apigateway.rb', line 145

class ApiConfig
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # A lightweight description of a file.
  # @!attribute [rw] path
  #   @return [::String]
  #     The file path (full or relative path). This is typically the path of the
  #     file when it is uploaded.
  # @!attribute [rw] contents
  #   @return [::String]
  #     The bytes that constitute the file.
  class File
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # An OpenAPI Specification Document describing an API.
  # @!attribute [rw] document
  #   @return [::Google::Cloud::ApiGateway::V1::ApiConfig::File]
  #     The OpenAPI Specification document file.
  class OpenApiDocument
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # A gRPC service definition.
  # @!attribute [rw] file_descriptor_set
  #   @return [::Google::Cloud::ApiGateway::V1::ApiConfig::File]
  #     Input only. File descriptor set, generated by protoc.
  #
  #     To generate, use protoc with imports and source info included.
  #     For an example test.proto file, the following command would put the value
  #     in a new file named out.pb.
  #
  #     $ protoc --include_imports --include_source_info test.proto -o out.pb
  # @!attribute [rw] source
  #   @return [::Array<::Google::Cloud::ApiGateway::V1::ApiConfig::File>]
  #     Optional. Uncompiled proto files associated with the descriptor set, used for
  #     display purposes (server-side compilation is not supported). These
  #     should match the inputs to 'protoc' command used to generate
  #     file_descriptor_set.
  class GrpcServiceDefinition
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # All the possible API Config states.
  module State
    # API Config does not have a state yet.
    STATE_UNSPECIFIED = 0

    # API Config is being created and deployed to the API Controller.
    CREATING = 1

    # API Config is ready for use by Gateways.
    ACTIVE = 2

    # API Config creation failed.
    FAILED = 3

    # API Config is being deleted.
    DELETING = 4

    # API Config is being updated.
    UPDATING = 5

    # API Config settings are being activated in downstream systems.
    # API Configs in this state cannot be used by Gateways.
    ACTIVATING = 6
  end
end

#display_name ⇒ ::String

Returns Optional. Display name.

Returns:

  • (::String) —

    Optional. Display name.



145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
 
# File 'proto_docs/google/cloud/apigateway/v1/apigateway.rb', line 145

class ApiConfig
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # A lightweight description of a file.
  # @!attribute [rw] path
  #   @return [::String]
  #     The file path (full or relative path). This is typically the path of the
  #     file when it is uploaded.
  # @!attribute [rw] contents
  #   @return [::String]
  #     The bytes that constitute the file.
  class File
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # An OpenAPI Specification Document describing an API.
  # @!attribute [rw] document
  #   @return [::Google::Cloud::ApiGateway::V1::ApiConfig::File]
  #     The OpenAPI Specification document file.
  class OpenApiDocument
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # A gRPC service definition.
  # @!attribute [rw] file_descriptor_set
  #   @return [::Google::Cloud::ApiGateway::V1::ApiConfig::File]
  #     Input only. File descriptor set, generated by protoc.
  #
  #     To generate, use protoc with imports and source info included.
  #     For an example test.proto file, the following command would put the value
  #     in a new file named out.pb.
  #
  #     $ protoc --include_imports --include_source_info test.proto -o out.pb
  # @!attribute [rw] source
  #   @return [::Array<::Google::Cloud::ApiGateway::V1::ApiConfig::File>]
  #     Optional. Uncompiled proto files associated with the descriptor set, used for
  #     display purposes (server-side compilation is not supported). These
  #     should match the inputs to 'protoc' command used to generate
  #     file_descriptor_set.
  class GrpcServiceDefinition
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # All the possible API Config states.
  module State
    # API Config does not have a state yet.
    STATE_UNSPECIFIED = 0

    # API Config is being created and deployed to the API Controller.
    CREATING = 1

    # API Config is ready for use by Gateways.
    ACTIVE = 2

    # API Config creation failed.
    FAILED = 3

    # API Config is being deleted.
    DELETING = 4

    # API Config is being updated.
    UPDATING = 5

    # API Config settings are being activated in downstream systems.
    # API Configs in this state cannot be used by Gateways.
    ACTIVATING = 6
  end
end

#gateway_service_account ⇒ ::String

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



145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
 
# File 'proto_docs/google/cloud/apigateway/v1/apigateway.rb', line 145

class ApiConfig
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # A lightweight description of a file.
  # @!attribute [rw] path
  #   @return [::String]
  #     The file path (full or relative path). This is typically the path of the
  #     file when it is uploaded.
  # @!attribute [rw] contents
  #   @return [::String]
  #     The bytes that constitute the file.
  class File
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # An OpenAPI Specification Document describing an API.
  # @!attribute [rw] document
  #   @return [::Google::Cloud::ApiGateway::V1::ApiConfig::File]
  #     The OpenAPI Specification document file.
  class OpenApiDocument
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # A gRPC service definition.
  # @!attribute [rw] file_descriptor_set
  #   @return [::Google::Cloud::ApiGateway::V1::ApiConfig::File]
  #     Input only. File descriptor set, generated by protoc.
  #
  #     To generate, use protoc with imports and source info included.
  #     For an example test.proto file, the following command would put the value
  #     in a new file named out.pb.
  #
  #     $ protoc --include_imports --include_source_info test.proto -o out.pb
  # @!attribute [rw] source
  #   @return [::Array<::Google::Cloud::ApiGateway::V1::ApiConfig::File>]
  #     Optional. Uncompiled proto files associated with the descriptor set, used for
  #     display purposes (server-side compilation is not supported). These
  #     should match the inputs to 'protoc' command used to generate
  #     file_descriptor_set.
  class GrpcServiceDefinition
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # All the possible API Config states.
  module State
    # API Config does not have a state yet.
    STATE_UNSPECIFIED = 0

    # API Config is being created and deployed to the API Controller.
    CREATING = 1

    # API Config is ready for use by Gateways.
    ACTIVE = 2

    # API Config creation failed.
    FAILED = 3

    # API Config is being deleted.
    DELETING = 4

    # API Config is being updated.
    UPDATING = 5

    # API Config settings are being activated in downstream systems.
    # API Configs in this state cannot be used by Gateways.
    ACTIVATING = 6
  end
end

#grpc_services ⇒ ::Array<::Google::Cloud::ApiGateway::V1::ApiConfig::GrpcServiceDefinition>

Returns Optional. gRPC service definition files. If specified, openapi_documents must not be included.

Returns:



145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
 
# File 'proto_docs/google/cloud/apigateway/v1/apigateway.rb', line 145

class ApiConfig
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # A lightweight description of a file.
  # @!attribute [rw] path
  #   @return [::String]
  #     The file path (full or relative path). This is typically the path of the
  #     file when it is uploaded.
  # @!attribute [rw] contents
  #   @return [::String]
  #     The bytes that constitute the file.
  class File
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # An OpenAPI Specification Document describing an API.
  # @!attribute [rw] document
  #   @return [::Google::Cloud::ApiGateway::V1::ApiConfig::File]
  #     The OpenAPI Specification document file.
  class OpenApiDocument
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # A gRPC service definition.
  # @!attribute [rw] file_descriptor_set
  #   @return [::Google::Cloud::ApiGateway::V1::ApiConfig::File]
  #     Input only. File descriptor set, generated by protoc.
  #
  #     To generate, use protoc with imports and source info included.
  #     For an example test.proto file, the following command would put the value
  #     in a new file named out.pb.
  #
  #     $ protoc --include_imports --include_source_info test.proto -o out.pb
  # @!attribute [rw] source
  #   @return [::Array<::Google::Cloud::ApiGateway::V1::ApiConfig::File>]
  #     Optional. Uncompiled proto files associated with the descriptor set, used for
  #     display purposes (server-side compilation is not supported). These
  #     should match the inputs to 'protoc' command used to generate
  #     file_descriptor_set.
  class GrpcServiceDefinition
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # All the possible API Config states.
  module State
    # API Config does not have a state yet.
    STATE_UNSPECIFIED = 0

    # API Config is being created and deployed to the API Controller.
    CREATING = 1

    # API Config is ready for use by Gateways.
    ACTIVE = 2

    # API Config creation failed.
    FAILED = 3

    # API Config is being deleted.
    DELETING = 4

    # API Config is being updated.
    UPDATING = 5

    # API Config settings are being activated in downstream systems.
    # API Configs in this state cannot be used by Gateways.
    ACTIVATING = 6
  end
end

#labels ⇒ ::Google::Protobuf::Map{::String => ::String}

Returns 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:



145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
 
# File 'proto_docs/google/cloud/apigateway/v1/apigateway.rb', line 145

class ApiConfig
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # A lightweight description of a file.
  # @!attribute [rw] path
  #   @return [::String]
  #     The file path (full or relative path). This is typically the path of the
  #     file when it is uploaded.
  # @!attribute [rw] contents
  #   @return [::String]
  #     The bytes that constitute the file.
  class File
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # An OpenAPI Specification Document describing an API.
  # @!attribute [rw] document
  #   @return [::Google::Cloud::ApiGateway::V1::ApiConfig::File]
  #     The OpenAPI Specification document file.
  class OpenApiDocument
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # A gRPC service definition.
  # @!attribute [rw] file_descriptor_set
  #   @return [::Google::Cloud::ApiGateway::V1::ApiConfig::File]
  #     Input only. File descriptor set, generated by protoc.
  #
  #     To generate, use protoc with imports and source info included.
  #     For an example test.proto file, the following command would put the value
  #     in a new file named out.pb.
  #
  #     $ protoc --include_imports --include_source_info test.proto -o out.pb
  # @!attribute [rw] source
  #   @return [::Array<::Google::Cloud::ApiGateway::V1::ApiConfig::File>]
  #     Optional. Uncompiled proto files associated with the descriptor set, used for
  #     display purposes (server-side compilation is not supported). These
  #     should match the inputs to 'protoc' command used to generate
  #     file_descriptor_set.
  class GrpcServiceDefinition
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # All the possible API Config states.
  module State
    # API Config does not have a state yet.
    STATE_UNSPECIFIED = 0

    # API Config is being created and deployed to the API Controller.
    CREATING = 1

    # API Config is ready for use by Gateways.
    ACTIVE = 2

    # API Config creation failed.
    FAILED = 3

    # API Config is being deleted.
    DELETING = 4

    # API Config is being updated.
    UPDATING = 5

    # API Config settings are being activated in downstream systems.
    # API Configs in this state cannot be used by Gateways.
    ACTIVATING = 6
  end
end

#managed_service_configs ⇒ ::Array<::Google::Cloud::ApiGateway::V1::ApiConfig::File>

Returns 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:



145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
 
# File 'proto_docs/google/cloud/apigateway/v1/apigateway.rb', line 145

class ApiConfig
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # A lightweight description of a file.
  # @!attribute [rw] path
  #   @return [::String]
  #     The file path (full or relative path). This is typically the path of the
  #     file when it is uploaded.
  # @!attribute [rw] contents
  #   @return [::String]
  #     The bytes that constitute the file.
  class File
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # An OpenAPI Specification Document describing an API.
  # @!attribute [rw] document
  #   @return [::Google::Cloud::ApiGateway::V1::ApiConfig::File]
  #     The OpenAPI Specification document file.
  class OpenApiDocument
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # A gRPC service definition.
  # @!attribute [rw] file_descriptor_set
  #   @return [::Google::Cloud::ApiGateway::V1::ApiConfig::File]
  #     Input only. File descriptor set, generated by protoc.
  #
  #     To generate, use protoc with imports and source info included.
  #     For an example test.proto file, the following command would put the value
  #     in a new file named out.pb.
  #
  #     $ protoc --include_imports --include_source_info test.proto -o out.pb
  # @!attribute [rw] source
  #   @return [::Array<::Google::Cloud::ApiGateway::V1::ApiConfig::File>]
  #     Optional. Uncompiled proto files associated with the descriptor set, used for
  #     display purposes (server-side compilation is not supported). These
  #     should match the inputs to 'protoc' command used to generate
  #     file_descriptor_set.
  class GrpcServiceDefinition
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # All the possible API Config states.
  module State
    # API Config does not have a state yet.
    STATE_UNSPECIFIED = 0

    # API Config is being created and deployed to the API Controller.
    CREATING = 1

    # API Config is ready for use by Gateways.
    ACTIVE = 2

    # API Config creation failed.
    FAILED = 3

    # API Config is being deleted.
    DELETING = 4

    # API Config is being updated.
    UPDATING = 5

    # API Config settings are being activated in downstream systems.
    # API Configs in this state cannot be used by Gateways.
    ACTIVATING = 6
  end
end

#name ⇒ ::String (readonly)

Returns Output only. Resource name of the API Config. Format: projects/{project}/locations/global/apis/{api}/configs/{api_config}.

Returns:

  • (::String) —

    Output only. Resource name of the API Config. Format: projects/{project}/locations/global/apis/{api}/configs/{api_config}



145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
 
# File 'proto_docs/google/cloud/apigateway/v1/apigateway.rb', line 145

class ApiConfig
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # A lightweight description of a file.
  # @!attribute [rw] path
  #   @return [::String]
  #     The file path (full or relative path). This is typically the path of the
  #     file when it is uploaded.
  # @!attribute [rw] contents
  #   @return [::String]
  #     The bytes that constitute the file.
  class File
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # An OpenAPI Specification Document describing an API.
  # @!attribute [rw] document
  #   @return [::Google::Cloud::ApiGateway::V1::ApiConfig::File]
  #     The OpenAPI Specification document file.
  class OpenApiDocument
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # A gRPC service definition.
  # @!attribute [rw] file_descriptor_set
  #   @return [::Google::Cloud::ApiGateway::V1::ApiConfig::File]
  #     Input only. File descriptor set, generated by protoc.
  #
  #     To generate, use protoc with imports and source info included.
  #     For an example test.proto file, the following command would put the value
  #     in a new file named out.pb.
  #
  #     $ protoc --include_imports --include_source_info test.proto -o out.pb
  # @!attribute [rw] source
  #   @return [::Array<::Google::Cloud::ApiGateway::V1::ApiConfig::File>]
  #     Optional. Uncompiled proto files associated with the descriptor set, used for
  #     display purposes (server-side compilation is not supported). These
  #     should match the inputs to 'protoc' command used to generate
  #     file_descriptor_set.
  class GrpcServiceDefinition
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # All the possible API Config states.
  module State
    # API Config does not have a state yet.
    STATE_UNSPECIFIED = 0

    # API Config is being created and deployed to the API Controller.
    CREATING = 1

    # API Config is ready for use by Gateways.
    ACTIVE = 2

    # API Config creation failed.
    FAILED = 3

    # API Config is being deleted.
    DELETING = 4

    # API Config is being updated.
    UPDATING = 5

    # API Config settings are being activated in downstream systems.
    # API Configs in this state cannot be used by Gateways.
    ACTIVATING = 6
  end
end

#openapi_documents ⇒ ::Array<::Google::Cloud::ApiGateway::V1::ApiConfig::OpenApiDocument>

Returns Optional. OpenAPI specification documents. If specified, grpc_services and managed_service_configs must not be included.

Returns:



145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
 
# File 'proto_docs/google/cloud/apigateway/v1/apigateway.rb', line 145

class ApiConfig
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # A lightweight description of a file.
  # @!attribute [rw] path
  #   @return [::String]
  #     The file path (full or relative path). This is typically the path of the
  #     file when it is uploaded.
  # @!attribute [rw] contents
  #   @return [::String]
  #     The bytes that constitute the file.
  class File
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # An OpenAPI Specification Document describing an API.
  # @!attribute [rw] document
  #   @return [::Google::Cloud::ApiGateway::V1::ApiConfig::File]
  #     The OpenAPI Specification document file.
  class OpenApiDocument
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # A gRPC service definition.
  # @!attribute [rw] file_descriptor_set
  #   @return [::Google::Cloud::ApiGateway::V1::ApiConfig::File]
  #     Input only. File descriptor set, generated by protoc.
  #
  #     To generate, use protoc with imports and source info included.
  #     For an example test.proto file, the following command would put the value
  #     in a new file named out.pb.
  #
  #     $ protoc --include_imports --include_source_info test.proto -o out.pb
  # @!attribute [rw] source
  #   @return [::Array<::Google::Cloud::ApiGateway::V1::ApiConfig::File>]
  #     Optional. Uncompiled proto files associated with the descriptor set, used for
  #     display purposes (server-side compilation is not supported). These
  #     should match the inputs to 'protoc' command used to generate
  #     file_descriptor_set.
  class GrpcServiceDefinition
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # All the possible API Config states.
  module State
    # API Config does not have a state yet.
    STATE_UNSPECIFIED = 0

    # API Config is being created and deployed to the API Controller.
    CREATING = 1

    # API Config is ready for use by Gateways.
    ACTIVE = 2

    # API Config creation failed.
    FAILED = 3

    # API Config is being deleted.
    DELETING = 4

    # API Config is being updated.
    UPDATING = 5

    # API Config settings are being activated in downstream systems.
    # API Configs in this state cannot be used by Gateways.
    ACTIVATING = 6
  end
end

#service_config_id ⇒ ::String (readonly)

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

Returns:



145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
 
# File 'proto_docs/google/cloud/apigateway/v1/apigateway.rb', line 145

class ApiConfig
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # A lightweight description of a file.
  # @!attribute [rw] path
  #   @return [::String]
  #     The file path (full or relative path). This is typically the path of the
  #     file when it is uploaded.
  # @!attribute [rw] contents
  #   @return [::String]
  #     The bytes that constitute the file.
  class File
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # An OpenAPI Specification Document describing an API.
  # @!attribute [rw] document
  #   @return [::Google::Cloud::ApiGateway::V1::ApiConfig::File]
  #     The OpenAPI Specification document file.
  class OpenApiDocument
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # A gRPC service definition.
  # @!attribute [rw] file_descriptor_set
  #   @return [::Google::Cloud::ApiGateway::V1::ApiConfig::File]
  #     Input only. File descriptor set, generated by protoc.
  #
  #     To generate, use protoc with imports and source info included.
  #     For an example test.proto file, the following command would put the value
  #     in a new file named out.pb.
  #
  #     $ protoc --include_imports --include_source_info test.proto -o out.pb
  # @!attribute [rw] source
  #   @return [::Array<::Google::Cloud::ApiGateway::V1::ApiConfig::File>]
  #     Optional. Uncompiled proto files associated with the descriptor set, used for
  #     display purposes (server-side compilation is not supported). These
  #     should match the inputs to 'protoc' command used to generate
  #     file_descriptor_set.
  class GrpcServiceDefinition
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # All the possible API Config states.
  module State
    # API Config does not have a state yet.
    STATE_UNSPECIFIED = 0

    # API Config is being created and deployed to the API Controller.
    CREATING = 1

    # API Config is ready for use by Gateways.
    ACTIVE = 2

    # API Config creation failed.
    FAILED = 3

    # API Config is being deleted.
    DELETING = 4

    # API Config is being updated.
    UPDATING = 5

    # API Config settings are being activated in downstream systems.
    # API Configs in this state cannot be used by Gateways.
    ACTIVATING = 6
  end
end

#state ⇒ ::Google::Cloud::ApiGateway::V1::ApiConfig::State (readonly)

Returns Output only. State of the API Config.

Returns:



145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
 
# File 'proto_docs/google/cloud/apigateway/v1/apigateway.rb', line 145

class ApiConfig
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # A lightweight description of a file.
  # @!attribute [rw] path
  #   @return [::String]
  #     The file path (full or relative path). This is typically the path of the
  #     file when it is uploaded.
  # @!attribute [rw] contents
  #   @return [::String]
  #     The bytes that constitute the file.
  class File
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # An OpenAPI Specification Document describing an API.
  # @!attribute [rw] document
  #   @return [::Google::Cloud::ApiGateway::V1::ApiConfig::File]
  #     The OpenAPI Specification document file.
  class OpenApiDocument
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # A gRPC service definition.
  # @!attribute [rw] file_descriptor_set
  #   @return [::Google::Cloud::ApiGateway::V1::ApiConfig::File]
  #     Input only. File descriptor set, generated by protoc.
  #
  #     To generate, use protoc with imports and source info included.
  #     For an example test.proto file, the following command would put the value
  #     in a new file named out.pb.
  #
  #     $ protoc --include_imports --include_source_info test.proto -o out.pb
  # @!attribute [rw] source
  #   @return [::Array<::Google::Cloud::ApiGateway::V1::ApiConfig::File>]
  #     Optional. Uncompiled proto files associated with the descriptor set, used for
  #     display purposes (server-side compilation is not supported). These
  #     should match the inputs to 'protoc' command used to generate
  #     file_descriptor_set.
  class GrpcServiceDefinition
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # All the possible API Config states.
  module State
    # API Config does not have a state yet.
    STATE_UNSPECIFIED = 0

    # API Config is being created and deployed to the API Controller.
    CREATING = 1

    # API Config is ready for use by Gateways.
    ACTIVE = 2

    # API Config creation failed.
    FAILED = 3

    # API Config is being deleted.
    DELETING = 4

    # API Config is being updated.
    UPDATING = 5

    # API Config settings are being activated in downstream systems.
    # API Configs in this state cannot be used by Gateways.
    ACTIVATING = 6
  end
end

#update_time ⇒ ::Google::Protobuf::Timestamp (readonly)

Returns Output only. Updated time.

Returns:



145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
 
# File 'proto_docs/google/cloud/apigateway/v1/apigateway.rb', line 145

class ApiConfig
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # A lightweight description of a file.
  # @!attribute [rw] path
  #   @return [::String]
  #     The file path (full or relative path). This is typically the path of the
  #     file when it is uploaded.
  # @!attribute [rw] contents
  #   @return [::String]
  #     The bytes that constitute the file.
  class File
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # An OpenAPI Specification Document describing an API.
  # @!attribute [rw] document
  #   @return [::Google::Cloud::ApiGateway::V1::ApiConfig::File]
  #     The OpenAPI Specification document file.
  class OpenApiDocument
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # A gRPC service definition.
  # @!attribute [rw] file_descriptor_set
  #   @return [::Google::Cloud::ApiGateway::V1::ApiConfig::File]
  #     Input only. File descriptor set, generated by protoc.
  #
  #     To generate, use protoc with imports and source info included.
  #     For an example test.proto file, the following command would put the value
  #     in a new file named out.pb.
  #
  #     $ protoc --include_imports --include_source_info test.proto -o out.pb
  # @!attribute [rw] source
  #   @return [::Array<::Google::Cloud::ApiGateway::V1::ApiConfig::File>]
  #     Optional. Uncompiled proto files associated with the descriptor set, used for
  #     display purposes (server-side compilation is not supported). These
  #     should match the inputs to 'protoc' command used to generate
  #     file_descriptor_set.
  class GrpcServiceDefinition
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # All the possible API Config states.
  module State
    # API Config does not have a state yet.
    STATE_UNSPECIFIED = 0

    # API Config is being created and deployed to the API Controller.
    CREATING = 1

    # API Config is ready for use by Gateways.
    ACTIVE = 2

    # API Config creation failed.
    FAILED = 3

    # API Config is being deleted.
    DELETING = 4

    # API Config is being updated.
    UPDATING = 5

    # API Config settings are being activated in downstream systems.
    # API Configs in this state cannot be used by Gateways.
    ACTIVATING = 6
  end
end