Class: Google::Cloud::ServiceControl::V1::ServiceController::Client

Inherits:
Object
  • Object
show all
Defined in:
lib/google/cloud/service_control/v1/service_controller/client.rb

Overview

Client for the ServiceController service.

Google Service Control API

Lets clients check and report operations against a managed service.

Defined Under Namespace

Classes: Configuration

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize {|config| ... } ⇒ Client

Create a new ServiceController client object.

Examples:


# Create a client using the default configuration
client = ::Google::Cloud::ServiceControl::V1::ServiceController::Client.new

# Create a client using a custom configuration
client = ::Google::Cloud::ServiceControl::V1::ServiceController::Client.new do |config|
  config.timeout = 10.0
end

Yields:

  • (config) —

    Configure the ServiceController client.

Yield Parameters:



132
133
134
135
136
137
138
139
140
141
142
143
144
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
 
# File 'lib/google/cloud/service_control/v1/service_controller/client.rb', line 132

def initialize
  # These require statements are intentionally placed here to initialize
  # the gRPC module only when it's required.
  # See https://github.com/googleapis/toolkit/issues/446
  require "gapic/grpc"
  require "google/api/servicecontrol/v1/service_controller_services_pb"

  # Create the configuration object
  @config = Configuration.new Client.configure

  # Yield the configuration if needed
  yield @config if block_given?

  # Create credentials
  credentials = @config.credentials
  # Use self-signed JWT if the endpoint is unchanged from default,
  # but only if the default endpoint does not have a region prefix.
  enable_self_signed_jwt = @config.endpoint.nil? ||
                           (@config.endpoint == Configuration::DEFAULT_ENDPOINT &&
                           !@config.endpoint.split(".").first.include?("-"))
  credentials ||= Credentials.default scope: @config.scope,
                                      enable_self_signed_jwt: enable_self_signed_jwt
  if credentials.is_a?(::String) || credentials.is_a?(::Hash)
    credentials = Credentials.new credentials, scope: @config.scope
  end
  @quota_project_id = @config.quota_project
  @quota_project_id ||= credentials.quota_project_id if credentials.respond_to? :quota_project_id

  @service_controller_stub = ::Gapic::ServiceStub.new(
    ::Google::Cloud::ServiceControl::V1::ServiceController::Stub,
    credentials: credentials,
    endpoint: @config.endpoint,
    endpoint_template: DEFAULT_ENDPOINT_TEMPLATE,
    universe_domain: @config.universe_domain,
    channel_args: @config.channel_args,
    interceptors: @config.interceptors,
    channel_pool_config: @config.channel_pool
  )
end

Class Method Details

.configure {|config| ... } ⇒ Client::Configuration

Configure the ServiceController Client class.

See Configuration for a description of the configuration fields.

Examples:


# Modify the configuration for all ServiceController clients
::Google::Cloud::ServiceControl::V1::ServiceController::Client.configure do |config|
  config.timeout = 10.0
end

Yields:

  • (config) —

    Configure the Client client.

Yield Parameters:

Returns:



63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
 
# File 'lib/google/cloud/service_control/v1/service_controller/client.rb', line 63

def self.configure
  @configure ||= begin
    namespace = ["Google", "Cloud", "ServiceControl", "V1"]
    parent_config = while namespace.any?
                      parent_name = namespace.join "::"
                      parent_const = const_get parent_name
                      break parent_const.configure if parent_const.respond_to? :configure
                      namespace.pop
                    end
    default_config = Client::Configuration.new parent_config

    default_config.rpcs.check.timeout = 5.0
    default_config.rpcs.check.retry_policy = {
      initial_delay: 1.0, max_delay: 10.0, multiplier: 1.3, retry_codes: [14]
    }

    default_config.rpcs.report.timeout = 16.0

    default_config
  end
  yield @configure if block_given?
  @configure
end

Instance Method Details

#check(request, options = nil) ⇒ ::Google::Cloud::ServiceControl::V1::CheckResponse #check(service_name: nil, operation: nil, service_config_id: nil) ⇒ ::Google::Cloud::ServiceControl::V1::CheckResponse

Checks whether an operation on a service should be allowed to proceed based on the configuration of the service and related policies. It must be called before the operation is executed.

If feasible, the client should cache the check results and reuse them for 60 seconds. In case of any server errors, the client should rely on the cached results for much longer time to avoid outage. WARNING: There is general 60s delay for the configuration and policy propagation, therefore callers MUST NOT depend on the Check method having the latest policy information.

NOTE: the CheckRequest has the size limit (wire-format byte size) of 1MB.

This method requires the servicemanagement.services.check permission on the specified service. For more information, see Cloud IAM.

Examples:

Basic example

require "google/cloud/service_control/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::ServiceControl::V1::ServiceController::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::ServiceControl::V1::CheckRequest.new

# Call the check method.
result = client.check request

# The returned object is of type Google::Cloud::ServiceControl::V1::CheckResponse.
p result

Overloads:

  • #check(request, options = nil) ⇒ ::Google::Cloud::ServiceControl::V1::CheckResponse

    Pass arguments to check via a request object, either of type CheckRequest or an equivalent Hash.

    Parameters:

    • request (::Google::Cloud::ServiceControl::V1::CheckRequest, ::Hash) —

      A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.

    • options (::Gapic::CallOptions, ::Hash) (defaults to: nil) —

      Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.

  • #check(service_name: nil, operation: nil, service_config_id: nil) ⇒ ::Google::Cloud::ServiceControl::V1::CheckResponse

    Pass arguments to check via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).

    Parameters:

    • service_name (::String) (defaults to: nil) —

      The service name as specified in its service configuration. For example, "pubsub.googleapis.com".

      See google.api.Service for the definition of a service name.

    • operation (::Google::Cloud::ServiceControl::V1::Operation, ::Hash) (defaults to: nil) —

      The operation to be checked.

    • service_config_id (::String) (defaults to: nil) —

      Specifies which version of service configuration should be used to process the request.

      If unspecified or no matching version can be found, the latest one will be used.

Yields:

  • (response, operation) —

    Access the result along with the RPC operation

Yield Parameters:

Returns:

Raises:

  • (::Google::Cloud::Error) —

    if the RPC is aborted.



247
248
249
250
251
252
253
254
255
256
257
258
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
 
# File 'lib/google/cloud/service_control/v1/service_controller/client.rb', line 247

def check request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::ServiceControl::V1::CheckRequest

  # Converts hash and nil to an options object
  options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h

  # Customize the options with defaults
  metadata = @config.rpcs.check.metadata.to_h

  # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
  metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
    lib_name: @config.lib_name, lib_version: @config.lib_version,
    gapic_version: ::Google::Cloud::ServiceControl::V1::VERSION
  metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  header_params = {}
  if request.service_name
    header_params["service_name"] = request.service_name
  end

  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
  metadata[:"x-goog-request-params"] ||= request_params_header

  options.apply_defaults timeout:      @config.rpcs.check.timeout,
                         metadata:     metadata,
                         retry_policy: @config.rpcs.check.retry_policy

  options.apply_defaults timeout:      @config.timeout,
                         metadata:     @config.metadata,
                         retry_policy: @config.retry_policy

  @service_controller_stub.call_rpc :check, request, options: options do |response, operation|
    yield response, operation if block_given?
    return response
  end
rescue ::GRPC::BadStatus => e
  raise ::Google::Cloud::Error.from_error(e)
end

#configure {|config| ... } ⇒ Client::Configuration

Configure the ServiceController Client instance.

The configuration is set to the derived mode, meaning that values can be changed, but structural changes (adding new fields, etc.) are not allowed. Structural changes should be made on configure.

See Configuration for a description of the configuration fields.

Yields:

  • (config) —

    Configure the Client client.

Yield Parameters:

Returns:



102
103
104
105
 
# File 'lib/google/cloud/service_control/v1/service_controller/client.rb', line 102

def configure
  yield @config if block_given?
  @config
end

#report(request, options = nil) ⇒ ::Google::Cloud::ServiceControl::V1::ReportResponse #report(service_name: nil, operations: nil, service_config_id: nil) ⇒ ::Google::Cloud::ServiceControl::V1::ReportResponse

Reports operation results to Google Service Control, such as logs and metrics. It should be called after an operation is completed.

If feasible, the client should aggregate reporting data for up to 5 seconds to reduce API traffic. Limiting aggregation to 5 seconds is to reduce data loss during client crashes. Clients should carefully choose the aggregation time window to avoid data loss risk more than 0.01% for business and compliance reasons.

NOTE: the ReportRequest has the size limit (wire-format byte size) of 1MB.

This method requires the servicemanagement.services.report permission on the specified service. For more information, see Google Cloud IAM.

Examples:

Basic example

require "google/cloud/service_control/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::ServiceControl::V1::ServiceController::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::ServiceControl::V1::ReportRequest.new

# Call the report method.
result = client.report request

# The returned object is of type Google::Cloud::ServiceControl::V1::ReportResponse.
p result

Overloads:

  • #report(request, options = nil) ⇒ ::Google::Cloud::ServiceControl::V1::ReportResponse

    Pass arguments to report via a request object, either of type ReportRequest or an equivalent Hash.

    Parameters:

    • request (::Google::Cloud::ServiceControl::V1::ReportRequest, ::Hash) —

      A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.

    • options (::Gapic::CallOptions, ::Hash) (defaults to: nil) —

      Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.

  • #report(service_name: nil, operations: nil, service_config_id: nil) ⇒ ::Google::Cloud::ServiceControl::V1::ReportResponse

    Pass arguments to report via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).

    Parameters:

    • service_name (::String) (defaults to: nil) —

      The service name as specified in its service configuration. For example, "pubsub.googleapis.com".

      See google.api.Service for the definition of a service name.

    • operations (::Array<::Google::Cloud::ServiceControl::V1::Operation, ::Hash>) (defaults to: nil) —

      Operations to be reported.

      Typically the service should report one operation per request. Putting multiple operations into a single request is allowed, but should be used only when multiple operations are natually available at the time of the report.

      There is no limit on the number of operations in the same ReportRequest, however the ReportRequest size should be no larger than 1MB. See ReportResponse.report_errors for partial failure behavior.

    • service_config_id (::String) (defaults to: nil) —

      Specifies which version of service config should be used to process the request.

      If unspecified or no matching version can be found, the latest one will be used.

Yields:

  • (response, operation) —

    Access the result along with the RPC operation

Yield Parameters:

Returns:

Raises:

  • (::Google::Cloud::Error) —

    if the RPC is aborted.



370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
 
# File 'lib/google/cloud/service_control/v1/service_controller/client.rb', line 370

def report request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::ServiceControl::V1::ReportRequest

  # Converts hash and nil to an options object
  options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h

  # Customize the options with defaults
  metadata = @config.rpcs.report.metadata.to_h

  # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
  metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
    lib_name: @config.lib_name, lib_version: @config.lib_version,
    gapic_version: ::Google::Cloud::ServiceControl::V1::VERSION
  metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  header_params = {}
  if request.service_name
    header_params["service_name"] = request.service_name
  end

  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
  metadata[:"x-goog-request-params"] ||= request_params_header

  options.apply_defaults timeout:      @config.rpcs.report.timeout,
                         metadata:     metadata,
                         retry_policy: @config.rpcs.report.retry_policy

  options.apply_defaults timeout:      @config.timeout,
                         metadata:     @config.metadata,
                         retry_policy: @config.retry_policy

  @service_controller_stub.call_rpc :report, request, options: options do |response, operation|
    yield response, operation if block_given?
    return response
  end
rescue ::GRPC::BadStatus => e
  raise ::Google::Cloud::Error.from_error(e)
end

#universe_domain ⇒ String

The effective universe domain

Returns:

  • (String) 


112
113
114
 
# File 'lib/google/cloud/service_control/v1/service_controller/client.rb', line 112

def universe_domain
  @service_controller_stub.universe_domain
end