Class: Google::Cloud::ApiGateway::V1::Gateway

Inherits:
Object
  • Object
show all
Extended by:
Protobuf::MessageExts::ClassMethods
Includes:
Protobuf::MessageExts
Defined in:
proto_docs/google/cloud/apigateway/v1/apigateway.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.

Defined Under Namespace

Modules: State Classes: LabelsEntry

Instance Attribute Summary collapse

Instance Attribute Details

#api_config ⇒ ::String

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



259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
 
# File 'proto_docs/google/cloud/apigateway/v1/apigateway.rb', line 259

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

  # @!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 Gateway states.
  module State
    # Gateway does not have a state yet.
    STATE_UNSPECIFIED = 0

    # Gateway is being created.
    CREATING = 1

    # Gateway is running and ready for requests.
    ACTIVE = 2

    # Gateway creation failed.
    FAILED = 3

    # Gateway is being deleted.
    DELETING = 4

    # Gateway is being updated.
    UPDATING = 5
  end
end

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

Returns Output only. Created time.

Returns:



259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
 
# File 'proto_docs/google/cloud/apigateway/v1/apigateway.rb', line 259

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

  # @!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 Gateway states.
  module State
    # Gateway does not have a state yet.
    STATE_UNSPECIFIED = 0

    # Gateway is being created.
    CREATING = 1

    # Gateway is running and ready for requests.
    ACTIVE = 2

    # Gateway creation failed.
    FAILED = 3

    # Gateway is being deleted.
    DELETING = 4

    # Gateway is being updated.
    UPDATING = 5
  end
end

#default_hostname ⇒ ::String (readonly)

Returns Output only. The default API Gateway host name of the form {gateway_id}-{hash}.{region_code}.gateway.dev.

Returns:

  • (::String) —

    Output only. The default API Gateway host name of the form {gateway_id}-{hash}.{region_code}.gateway.dev.



259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
 
# File 'proto_docs/google/cloud/apigateway/v1/apigateway.rb', line 259

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

  # @!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 Gateway states.
  module State
    # Gateway does not have a state yet.
    STATE_UNSPECIFIED = 0

    # Gateway is being created.
    CREATING = 1

    # Gateway is running and ready for requests.
    ACTIVE = 2

    # Gateway creation failed.
    FAILED = 3

    # Gateway is being deleted.
    DELETING = 4

    # Gateway is being updated.
    UPDATING = 5
  end
end

#display_name ⇒ ::String

Returns Optional. Display name.

Returns:

  • (::String) —

    Optional. Display name.



259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
 
# File 'proto_docs/google/cloud/apigateway/v1/apigateway.rb', line 259

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

  # @!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 Gateway states.
  module State
    # Gateway does not have a state yet.
    STATE_UNSPECIFIED = 0

    # Gateway is being created.
    CREATING = 1

    # Gateway is running and ready for requests.
    ACTIVE = 2

    # Gateway creation failed.
    FAILED = 3

    # Gateway is being deleted.
    DELETING = 4

    # Gateway is being updated.
    UPDATING = 5
  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:



259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
 
# File 'proto_docs/google/cloud/apigateway/v1/apigateway.rb', line 259

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

  # @!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 Gateway states.
  module State
    # Gateway does not have a state yet.
    STATE_UNSPECIFIED = 0

    # Gateway is being created.
    CREATING = 1

    # Gateway is running and ready for requests.
    ACTIVE = 2

    # Gateway creation failed.
    FAILED = 3

    # Gateway is being deleted.
    DELETING = 4

    # Gateway is being updated.
    UPDATING = 5
  end
end

#name ⇒ ::String (readonly)

Returns Output only. Resource name of the Gateway. Format: projects/{project}/locations/{location}/gateways/{gateway}.

Returns:

  • (::String) —

    Output only. Resource name of the Gateway. Format: projects/{project}/locations/{location}/gateways/{gateway}



259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
 
# File 'proto_docs/google/cloud/apigateway/v1/apigateway.rb', line 259

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

  # @!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 Gateway states.
  module State
    # Gateway does not have a state yet.
    STATE_UNSPECIFIED = 0

    # Gateway is being created.
    CREATING = 1

    # Gateway is running and ready for requests.
    ACTIVE = 2

    # Gateway creation failed.
    FAILED = 3

    # Gateway is being deleted.
    DELETING = 4

    # Gateway is being updated.
    UPDATING = 5
  end
end

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

Returns Output only. The current state of the Gateway.

Returns:



259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
 
# File 'proto_docs/google/cloud/apigateway/v1/apigateway.rb', line 259

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

  # @!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 Gateway states.
  module State
    # Gateway does not have a state yet.
    STATE_UNSPECIFIED = 0

    # Gateway is being created.
    CREATING = 1

    # Gateway is running and ready for requests.
    ACTIVE = 2

    # Gateway creation failed.
    FAILED = 3

    # Gateway is being deleted.
    DELETING = 4

    # Gateway is being updated.
    UPDATING = 5
  end
end

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

Returns Output only. Updated time.

Returns:



259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
 
# File 'proto_docs/google/cloud/apigateway/v1/apigateway.rb', line 259

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

  # @!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 Gateway states.
  module State
    # Gateway does not have a state yet.
    STATE_UNSPECIFIED = 0

    # Gateway is being created.
    CREATING = 1

    # Gateway is running and ready for requests.
    ACTIVE = 2

    # Gateway creation failed.
    FAILED = 3

    # Gateway is being deleted.
    DELETING = 4

    # Gateway is being updated.
    UPDATING = 5
  end
end