Class: Google::Apis::AppengineV1::EndpointsApiService

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

Overview

Cloud Endpoints (https://cloud.google.com/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 (https://cloud.google.com/service-management/ overview).

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods included from Core::JsonObjectSupport

#to_json

Methods included from Core::Hashable

process_value, #to_h

Constructor Details

#initialize(**args) ⇒ EndpointsApiService

Returns a new instance of EndpointsApiService.


858
859
860
# File 'generated/google/apis/appengine_v1/classes.rb', line 858

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

Instance Attribute Details

#config_idString

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

Returns:

  • (String)

838
839
840
# File 'generated/google/apis/appengine_v1/classes.rb', line 838

def config_id
  @config_id
end

#disable_trace_samplingBoolean Also known as: disable_trace_sampling?

Enable or disable trace sampling. By default, this is set to false for enabled. Corresponds to the JSON property disableTraceSampling

Returns:

  • (Boolean)

843
844
845
# File 'generated/google/apis/appengine_v1/classes.rb', line 843

def disable_trace_sampling
  @disable_trace_sampling
end

#nameString

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

Returns:

  • (String)

850
851
852
# File 'generated/google/apis/appengine_v1/classes.rb', line 850

def name
  @name
end

#rollout_strategyString

Endpoints rollout strategy. If FIXED, config_id must be specified. If MANAGED, config_id must be omitted. Corresponds to the JSON property rolloutStrategy

Returns:

  • (String)

856
857
858
# File 'generated/google/apis/appengine_v1/classes.rb', line 856

def rollout_strategy
  @rollout_strategy
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object


863
864
865
866
867
868
# File 'generated/google/apis/appengine_v1/classes.rb', line 863

def update!(**args)
  @config_id = args[:config_id] if args.key?(:config_id)
  @disable_trace_sampling = args[:disable_trace_sampling] if args.key?(:disable_trace_sampling)
  @name = args[:name] if args.key?(:name)
  @rollout_strategy = args[:rollout_strategy] if args.key?(:rollout_strategy)
end