Class: Google::Cloud::Ces::V1::ToolService::Rest::Client

Inherits:
Object
  • Object
show all
Includes:
Paths
Defined in:
lib/google/cloud/ces/v1/tool_service/rest/client.rb

Overview

REST client for the ToolService service.

Tool service provides APIs for interacting with CES tools.

Defined Under Namespace

Classes: Configuration

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Methods included from Paths

#app_path, #tool_path, #toolset_path

Constructor Details

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

Create a new ToolService REST client object.

Examples:


# Create a client using the default configuration
client = ::Google::Cloud::Ces::V1::ToolService::Rest::Client.new

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

Yields:

  • (config) —

    Configure the ToolService 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
171
172
173
174
175
176
177
178
179
180
181
 
# File 'lib/google/cloud/ces/v1/tool_service/rest/client.rb', line 132

def initialize
  # 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

  @tool_service_stub = ::Google::Cloud::Ces::V1::ToolService::Rest::ServiceStub.new(
    endpoint: @config.endpoint,
    endpoint_template: DEFAULT_ENDPOINT_TEMPLATE,
    universe_domain: @config.universe_domain,
    credentials: credentials,
    logger: @config.logger
  )

  @tool_service_stub.logger(stub: true)&.info do |entry|
    entry.set_system_name
    entry.set_service
    entry.message = "Created client for #{entry.service}"
    entry.set_credentials_fields credentials
    entry.set "customEndpoint", @config.endpoint if @config.endpoint
    entry.set "defaultTimeout", @config.timeout if @config.timeout
    entry.set "quotaProject", @quota_project_id if @quota_project_id
  end

  @location_client = Google::Cloud::Location::Locations::Rest::Client.new do |config|
    config.credentials = credentials
    config.quota_project = @quota_project_id
    config.endpoint = @tool_service_stub.endpoint
    config.universe_domain = @tool_service_stub.universe_domain
    config.bindings_override = @config.bindings_override
    config.logger = @tool_service_stub.logger if config.respond_to? :logger=
  end
end

Instance Attribute Details

#location_client ⇒ Google::Cloud::Location::Locations::Rest::Client (readonly)

Get the associated client for mix-in of the Locations.

Returns:

  • (Google::Cloud::Location::Locations::Rest::Client) 


188
189
190
 
# File 'lib/google/cloud/ces/v1/tool_service/rest/client.rb', line 188

def location_client
  @location_client
end

Class Method Details

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

Configure the ToolService Client class.

See Configuration for a description of the configuration fields.

Examples:


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

Yields:

  • (config) —

    Configure the Client client.

Yield Parameters:

Returns:



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/ces/v1/tool_service/rest/client.rb', line 65

def self.configure
  @configure ||= begin
    namespace = ["Google", "Cloud", "Ces", "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.timeout = 60.0
    default_config.retry_policy = {
      initial_delay: 0.1, max_delay: 60.0, multiplier: 1.3, retry_codes: [4, 14]
    }

    default_config
  end
  yield @configure if block_given?
  @configure
end

Instance Method Details

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

Configure the ToolService 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/ces/v1/tool_service/rest/client.rb', line 102

def configure
  yield @config if block_given?
  @config
end

#execute_tool(request, options = nil) ⇒ ::Google::Cloud::Ces::V1::ExecuteToolResponse #execute_tool(tool: nil, toolset_tool: nil, variables: nil, context: nil, parent: nil, args: nil) ⇒ ::Google::Cloud::Ces::V1::ExecuteToolResponse

Executes the given tool with the given arguments.

Examples:

Basic example

require "google/cloud/ces/v1"

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

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

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

# The returned object is of type Google::Cloud::Ces::V1::ExecuteToolResponse.
p result

Overloads:

  • #execute_tool(request, options = nil) ⇒ ::Google::Cloud::Ces::V1::ExecuteToolResponse

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

    Parameters:

    • request (::Google::Cloud::Ces::V1::ExecuteToolRequest, ::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.

  • #execute_tool(tool: nil, toolset_tool: nil, variables: nil, context: nil, parent: nil, args: nil) ⇒ ::Google::Cloud::Ces::V1::ExecuteToolResponse

    Pass arguments to execute_tool 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:

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

      Optional. The name of the tool to execute. Format: projects/{project}/locations/{location}/apps/{app}/tools/{tool}

      Note: The following parameters are mutually exclusive: tool, toolset_tool. At most one of these parameters can be set. If more than one is set, only one will be used, and it is not defined which one.

    • toolset_tool (::Google::Cloud::Ces::V1::ToolsetTool, ::Hash) (defaults to: nil) —

      Optional. The toolset tool to execute. Only one tool should match the predicate from the toolset. Otherwise, an error will be returned.

      Note: The following parameters are mutually exclusive: toolset_tool, tool. At most one of these parameters can be set. If more than one is set, only one will be used, and it is not defined which one.

    • variables (::Google::Protobuf::Struct, ::Hash) (defaults to: nil) —

      Optional. The variables that are available for the tool execution.

      Note: The following parameters are mutually exclusive: variables, context. At most one of these parameters can be set. If more than one is set, only one will be used, and it is not defined which one.

    • context (::Google::Protobuf::Struct, ::Hash) (defaults to: nil) —

      Optional. The ToolCallContext to be passed to the Python tool.

      Note: The following parameters are mutually exclusive: context, variables. At most one of these parameters can be set. If more than one is set, only one will be used, and it is not defined which one.

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

      Required. The resource name of the app which the tool/toolset belongs to. Format: projects/{project}/locations/{location}/apps/{app}

    • args (::Google::Protobuf::Struct, ::Hash) (defaults to: nil) —

      Optional. The input parameters and values for the tool in JSON object format.

Yields:

  • (result, operation) —

    Access the result along with the TransportOperation object

Yield Parameters:

Returns:

Raises:

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

    if the REST call is aborted.



269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
 
# File 'lib/google/cloud/ces/v1/tool_service/rest/client.rb', line 269

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

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Ces::V1::ExecuteToolRequest

  # 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
  call_metadata = @config.rpcs.execute_tool.metadata.to_h

  # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
  call_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::Ces::V1::VERSION,
    transports_version_send: [:rest]

  call_metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
  call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  options.apply_defaults timeout:      @config.rpcs.execute_tool.timeout,
                         metadata:     call_metadata,
                         retry_policy: @config.rpcs.execute_tool.retry_policy

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

  @tool_service_stub.execute_tool request, options do |result, operation|
    yield result, operation if block_given?
  end
rescue ::Gapic::Rest::Error => e
  raise ::Google::Cloud::Error.from_error(e)
end

#logger ⇒ Logger

The logger used for request/response debug logging.

Returns:

  • (Logger) 


195
196
197
 
# File 'lib/google/cloud/ces/v1/tool_service/rest/client.rb', line 195

def logger
  @tool_service_stub.logger
end

#retrieve_tool_schema(request, options = nil) ⇒ ::Google::Cloud::Ces::V1::RetrieveToolSchemaResponse #retrieve_tool_schema(tool: nil, toolset_tool: nil, parent: nil) ⇒ ::Google::Cloud::Ces::V1::RetrieveToolSchemaResponse

Retrieve the schema of the given tool. The schema is computed on the fly for the given instance of the tool.

Examples:

Basic example

require "google/cloud/ces/v1"

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

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

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

# The returned object is of type Google::Cloud::Ces::V1::RetrieveToolSchemaResponse.
p result

Overloads:

  • #retrieve_tool_schema(request, options = nil) ⇒ ::Google::Cloud::Ces::V1::RetrieveToolSchemaResponse

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

    Parameters:

    • request (::Google::Cloud::Ces::V1::RetrieveToolSchemaRequest, ::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.

  • #retrieve_tool_schema(tool: nil, toolset_tool: nil, parent: nil) ⇒ ::Google::Cloud::Ces::V1::RetrieveToolSchemaResponse

    Pass arguments to retrieve_tool_schema 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:

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

      Optional. The name of the tool to retrieve the schema for. Format: projects/{project}/locations/{location}/apps/{app}/tools/{tool}

      Note: The following parameters are mutually exclusive: tool, toolset_tool. At most one of these parameters can be set. If more than one is set, only one will be used, and it is not defined which one.

    • toolset_tool (::Google::Cloud::Ces::V1::ToolsetTool, ::Hash) (defaults to: nil) —

      Optional. The toolset tool to retrieve the schema for. Only one tool should match the predicate from the toolset. Otherwise, an error will be returned.

      Note: The following parameters are mutually exclusive: toolset_tool, tool. At most one of these parameters can be set. If more than one is set, only one will be used, and it is not defined which one.

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

      Required. The resource name of the app which the tool/toolset belongs to. Format: projects/{project}/locations/{location}/apps/{app}

Yields:

  • (result, operation) —

    Access the result along with the TransportOperation object

Yield Parameters:

Returns:

Raises:

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

    if the REST call is aborted.



361
362
363
364
365
366
367
368
369
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
 
# File 'lib/google/cloud/ces/v1/tool_service/rest/client.rb', line 361

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

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Ces::V1::RetrieveToolSchemaRequest

  # 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
  call_metadata = @config.rpcs.retrieve_tool_schema.metadata.to_h

  # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
  call_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::Ces::V1::VERSION,
    transports_version_send: [:rest]

  call_metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
  call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  options.apply_defaults timeout:      @config.rpcs.retrieve_tool_schema.timeout,
                         metadata:     call_metadata,
                         retry_policy: @config.rpcs.retrieve_tool_schema.retry_policy

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

  @tool_service_stub.retrieve_tool_schema request, options do |result, operation|
    yield result, operation if block_given?
  end
rescue ::Gapic::Rest::Error => e
  raise ::Google::Cloud::Error.from_error(e)
end

#retrieve_tools(request, options = nil) ⇒ ::Google::Cloud::Ces::V1::RetrieveToolsResponse #retrieve_tools(toolset: nil, tool_ids: nil) ⇒ ::Google::Cloud::Ces::V1::RetrieveToolsResponse

Retrieve the list of tools included in the specified toolset.

Examples:

Basic example

require "google/cloud/ces/v1"

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

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

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

# The returned object is of type Google::Cloud::Ces::V1::RetrieveToolsResponse.
p result

Overloads:

  • #retrieve_tools(request, options = nil) ⇒ ::Google::Cloud::Ces::V1::RetrieveToolsResponse

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

    Parameters:

    • request (::Google::Cloud::Ces::V1::RetrieveToolsRequest, ::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.

  • #retrieve_tools(toolset: nil, tool_ids: nil) ⇒ ::Google::Cloud::Ces::V1::RetrieveToolsResponse

    Pass arguments to retrieve_tools 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:

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

      Required. The name of the toolset to retrieve the tools for. Format: projects/{project}/locations/{location}/apps/{app}/toolsets/{toolset}

    • tool_ids (::Array<::String>) (defaults to: nil) —

      Optional. The identifiers of the tools to retrieve from the toolset. If empty, all tools in the toolset will be returned.

Yields:

  • (result, operation) —

    Access the result along with the TransportOperation object

Yield Parameters:

Returns:

Raises:

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

    if the REST call is aborted.



444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
 
# File 'lib/google/cloud/ces/v1/tool_service/rest/client.rb', line 444

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

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Ces::V1::RetrieveToolsRequest

  # 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
  call_metadata = @config.rpcs.retrieve_tools.metadata.to_h

  # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
  call_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::Ces::V1::VERSION,
    transports_version_send: [:rest]

  call_metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
  call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  options.apply_defaults timeout:      @config.rpcs.retrieve_tools.timeout,
                         metadata:     call_metadata,
                         retry_policy: @config.rpcs.retrieve_tools.retry_policy

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

  @tool_service_stub.retrieve_tools request, options do |result, operation|
    yield result, operation if block_given?
  end
rescue ::Gapic::Rest::Error => 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/ces/v1/tool_service/rest/client.rb', line 112

def universe_domain
  @tool_service_stub.universe_domain
end