Class: Google::Cloud::AppEngine::V1::EndpointsApiService

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

Overview

Cloud Endpoints configuration. The Endpoints API Service provides tooling for serving Open API and gRPC endpoints via an NGINX proxy. Only valid for App Engine Flexible environment deployments.

The fields here refer to the name and configuration ID of a "service" resource in the Service Management API.

Defined Under Namespace

Modules: RolloutStrategy

Instance Attribute Summary collapse

Instance Attribute Details

#config_id ⇒ ::String

Returns Endpoints service configuration ID as specified by the Service Management API. For example "2016-09-19r1".

By default, the rollout strategy for Endpoints is RolloutStrategy.FIXED. This means that Endpoints starts up with a particular configuration ID. When a new configuration is rolled out, Endpoints must be given the new configuration ID. The config_id field is used to give the configuration ID and is required in this case.

Endpoints also has a rollout strategy called RolloutStrategy.MANAGED. When using this, Endpoints fetches the latest configuration and does not need the configuration ID. In this case, config_id must be omitted.

Returns:

  • (::String) —

    Endpoints service configuration ID as specified by the Service Management API. For example "2016-09-19r1".

    By default, the rollout strategy for Endpoints is RolloutStrategy.FIXED. This means that Endpoints starts up with a particular configuration ID. When a new configuration is rolled out, Endpoints must be given the new configuration ID. The config_id field is used to give the configuration ID and is required in this case.

    Endpoints also has a rollout strategy called RolloutStrategy.MANAGED. When using this, Endpoints fetches the latest configuration and does not need the configuration ID. In this case, config_id must be omitted.



284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
 
# File 'proto_docs/google/appengine/v1/version.rb', line 284

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

  # Available rollout strategies.
  module RolloutStrategy
    # Not specified. Defaults to `FIXED`.
    UNSPECIFIED_ROLLOUT_STRATEGY = 0

    # Endpoints service configuration ID will be fixed to the configuration ID
    # specified by `config_id`.
    FIXED = 1

    # Endpoints service configuration ID will be updated with each rollout.
    MANAGED = 2
  end
end

#disable_trace_sampling ⇒ ::Boolean

Returns Enable or disable trace sampling. By default, this is set to false for enabled.

Returns:

  • (::Boolean) —

    Enable or disable trace sampling. By default, this is set to false for enabled.



284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
 
# File 'proto_docs/google/appengine/v1/version.rb', line 284

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

  # Available rollout strategies.
  module RolloutStrategy
    # Not specified. Defaults to `FIXED`.
    UNSPECIFIED_ROLLOUT_STRATEGY = 0

    # Endpoints service configuration ID will be fixed to the configuration ID
    # specified by `config_id`.
    FIXED = 1

    # Endpoints service configuration ID will be updated with each rollout.
    MANAGED = 2
  end
end

#name ⇒ ::String

Returns Endpoints service name which is the name of the "service" resource in the Service Management API. For example "myapi.endpoints.myproject.cloud.goog".

Returns:

  • (::String) —

    Endpoints service name which is the name of the "service" resource in the Service Management API. For example "myapi.endpoints.myproject.cloud.goog"



284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
 
# File 'proto_docs/google/appengine/v1/version.rb', line 284

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

  # Available rollout strategies.
  module RolloutStrategy
    # Not specified. Defaults to `FIXED`.
    UNSPECIFIED_ROLLOUT_STRATEGY = 0

    # Endpoints service configuration ID will be fixed to the configuration ID
    # specified by `config_id`.
    FIXED = 1

    # Endpoints service configuration ID will be updated with each rollout.
    MANAGED = 2
  end
end

#rollout_strategy ⇒ ::Google::Cloud::AppEngine::V1::EndpointsApiService::RolloutStrategy

Returns Endpoints rollout strategy. If FIXED, config_id must be specified. If MANAGED, config_id must be omitted.

Returns:



284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
 
# File 'proto_docs/google/appengine/v1/version.rb', line 284

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

  # Available rollout strategies.
  module RolloutStrategy
    # Not specified. Defaults to `FIXED`.
    UNSPECIFIED_ROLLOUT_STRATEGY = 0

    # Endpoints service configuration ID will be fixed to the configuration ID
    # specified by `config_id`.
    FIXED = 1

    # Endpoints service configuration ID will be updated with each rollout.
    MANAGED = 2
  end
end