Class: Google::Cloud::Dataflow::V1beta3::TemplatesService::Rest::Client

Inherits:
Object
  • Object
show all
Defined in:
lib/google/cloud/dataflow/v1beta3/templates_service/rest/client.rb

Overview

REST client for the TemplatesService service.

Provides a method to create Cloud Dataflow jobs from templates.

Defined Under Namespace

Classes: Configuration

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

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

Create a new TemplatesService REST client object.

Examples:


# Create a client using the default configuration
client = ::Google::Cloud::Dataflow::V1beta3::TemplatesService::Rest::Client.new

# Create a client using a custom configuration
client = ::Google::Cloud::Dataflow::V1beta3::TemplatesService::Rest::Client.new do |config|
  config.timeout = 10.0
end

Yields:

  • (config) —

    Configure the TemplatesService client.

Yield Parameters:



126
127
128
129
130
131
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
 
# File 'lib/google/cloud/dataflow/v1beta3/templates_service/rest/client.rb', line 126

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

  @templates_service_stub = ::Google::Cloud::Dataflow::V1beta3::TemplatesService::Rest::ServiceStub.new(
    endpoint: @config.endpoint,
    endpoint_template: DEFAULT_ENDPOINT_TEMPLATE,
    universe_domain: @config.universe_domain,
    credentials: credentials,
    logger: @config.logger
  )

  @templates_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
end

Class Method Details

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

Configure the TemplatesService Client class.

See Configuration for a description of the configuration fields.

Examples:


# Modify the configuration for all TemplatesService clients
::Google::Cloud::Dataflow::V1beta3::TemplatesService::Rest::Client.configure do |config|
  config.timeout = 10.0
end

Yields:

  • (config) —

    Configure the Client client.

Yield Parameters:

Returns:



62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
 
# File 'lib/google/cloud/dataflow/v1beta3/templates_service/rest/client.rb', line 62

def self.configure
  @configure ||= begin
    namespace = ["Google", "Cloud", "Dataflow", "V1beta3"]
    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
  end
  yield @configure if block_given?
  @configure
end

Instance Method Details

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

Configure the TemplatesService 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:



96
97
98
99
 
# File 'lib/google/cloud/dataflow/v1beta3/templates_service/rest/client.rb', line 96

def configure
  yield @config if block_given?
  @config
end

#create_job_from_template(request, options = nil) ⇒ ::Google::Cloud::Dataflow::V1beta3::Job #create_job_from_template(project_id: nil, job_name: nil, gcs_path: nil, parameters: nil, environment: nil, location: nil) ⇒ ::Google::Cloud::Dataflow::V1beta3::Job

Creates a Cloud Dataflow job from a template. Do not enter confidential information when you supply string values using the API.

To create a job, we recommend using projects.locations.templates.create with a regional endpoint. Using projects.templates.create is not recommended, because your job will always start in us-central1.

Examples:

Basic example

require "google/cloud/dataflow/v1beta3"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::Dataflow::V1beta3::TemplatesService::Rest::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::Dataflow::V1beta3::CreateJobFromTemplateRequest.new

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

# The returned object is of type Google::Cloud::Dataflow::V1beta3::Job.
p result

Overloads:

  • #create_job_from_template(request, options = nil) ⇒ ::Google::Cloud::Dataflow::V1beta3::Job

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

    Parameters:

    • request (::Google::Cloud::Dataflow::V1beta3::CreateJobFromTemplateRequest, ::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.

  • #create_job_from_template(project_id: nil, job_name: nil, gcs_path: nil, parameters: nil, environment: nil, location: nil) ⇒ ::Google::Cloud::Dataflow::V1beta3::Job

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

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

      Required. The ID of the Cloud Platform project that the job belongs to.

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

      Required. The job name to use for the created job.

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

      Required. A Cloud Storage path to the template from which to create the job. Must be a valid Cloud Storage URL, beginning with gs://.

    • parameters (::Hash{::String => ::String}) (defaults to: nil) —

      The runtime parameters to pass to the job.

    • environment (::Google::Cloud::Dataflow::V1beta3::RuntimeEnvironment, ::Hash) (defaults to: nil) —

      The runtime environment for the job.

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

      The regional endpoint to which to direct the request.

Yields:

  • (result, operation) —

    Access the result along with the TransportOperation object

Yield Parameters:

Returns:

Raises:

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

    if the REST call is aborted.



243
244
245
246
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
 
# File 'lib/google/cloud/dataflow/v1beta3/templates_service/rest/client.rb', line 243

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

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Dataflow::V1beta3::CreateJobFromTemplateRequest

  # 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.create_job_from_template.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::Dataflow::V1beta3::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.create_job_from_template.timeout,
                         metadata:     call_metadata,
                         retry_policy: @config.rpcs.create_job_from_template.retry_policy

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

  @templates_service_stub.create_job_from_template 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

#get_template(request, options = nil) ⇒ ::Google::Cloud::Dataflow::V1beta3::GetTemplateResponse #get_template(project_id: nil, gcs_path: nil, view: nil, location: nil) ⇒ ::Google::Cloud::Dataflow::V1beta3::GetTemplateResponse

Get the template associated with a template.

To get the template, we recommend using projects.locations.templates.get with a regional endpoint. Using projects.templates.get is not recommended, because only templates that are running in us-central1 are retrieved.

Examples:

Basic example

require "google/cloud/dataflow/v1beta3"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::Dataflow::V1beta3::TemplatesService::Rest::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::Dataflow::V1beta3::GetTemplateRequest.new

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

# The returned object is of type Google::Cloud::Dataflow::V1beta3::GetTemplateResponse.
p result

Overloads:

  • #get_template(request, options = nil) ⇒ ::Google::Cloud::Dataflow::V1beta3::GetTemplateResponse

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

    Parameters:

    • request (::Google::Cloud::Dataflow::V1beta3::GetTemplateRequest, ::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.

  • #get_template(project_id: nil, gcs_path: nil, view: nil, location: nil) ⇒ ::Google::Cloud::Dataflow::V1beta3::GetTemplateResponse

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

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

      Required. The ID of the Cloud Platform project that the job belongs to.

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

      Required. A Cloud Storage path to the template from which to create the job. Must be valid Cloud Storage URL, beginning with 'gs://'.

    • view (::Google::Cloud::Dataflow::V1beta3::GetTemplateRequest::TemplateView) (defaults to: nil) —

      The view to retrieve. Defaults to METADATA_ONLY.

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

      The regional endpoint to which to direct the request.

Yields:

  • (result, operation) —

    Access the result along with the TransportOperation object

Yield Parameters:

Returns:

Raises:

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

    if the REST call is aborted.



441
442
443
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
 
# File 'lib/google/cloud/dataflow/v1beta3/templates_service/rest/client.rb', line 441

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

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Dataflow::V1beta3::GetTemplateRequest

  # 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.get_template.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::Dataflow::V1beta3::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.get_template.timeout,
                         metadata:     call_metadata,
                         retry_policy: @config.rpcs.get_template.retry_policy

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

  @templates_service_stub.get_template 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

#launch_template(request, options = nil) ⇒ ::Google::Cloud::Dataflow::V1beta3::LaunchTemplateResponse #launch_template(project_id: nil, validate_only: nil, gcs_path: nil, dynamic_template: nil, launch_parameters: nil, location: nil) ⇒ ::Google::Cloud::Dataflow::V1beta3::LaunchTemplateResponse

Launches a template.

To launch a template, we recommend using projects.locations.templates.launch with a regional endpoint. Using projects.templates.launch is not recommended, because jobs launched from the template will always start in us-central1.

Examples:

Basic example

require "google/cloud/dataflow/v1beta3"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::Dataflow::V1beta3::TemplatesService::Rest::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::Dataflow::V1beta3::LaunchTemplateRequest.new

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

# The returned object is of type Google::Cloud::Dataflow::V1beta3::LaunchTemplateResponse.
p result

Overloads:

  • #launch_template(request, options = nil) ⇒ ::Google::Cloud::Dataflow::V1beta3::LaunchTemplateResponse

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

    Parameters:

    • request (::Google::Cloud::Dataflow::V1beta3::LaunchTemplateRequest, ::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.

  • #launch_template(project_id: nil, validate_only: nil, gcs_path: nil, dynamic_template: nil, launch_parameters: nil, location: nil) ⇒ ::Google::Cloud::Dataflow::V1beta3::LaunchTemplateResponse

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

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

      Required. The ID of the Cloud Platform project that the job belongs to.

    • validate_only (::Boolean) (defaults to: nil) —

      If true, the request is validated but not actually executed. Defaults to false.

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

      A Cloud Storage path to the template to use to create the job. Must be valid Cloud Storage URL, beginning with gs://.

      Note: The following parameters are mutually exclusive: gcs_path, dynamic_template. 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.

    • dynamic_template (::Google::Cloud::Dataflow::V1beta3::DynamicTemplateLaunchParams, ::Hash) (defaults to: nil) —

      Parameters for launching a dynamic template.

      Note: The following parameters are mutually exclusive: dynamic_template, gcs_path. 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.

    • launch_parameters (::Google::Cloud::Dataflow::V1beta3::LaunchTemplateParameters, ::Hash) (defaults to: nil) —

      The parameters of the template to launch. Part of the body of the POST request.

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

      The regional endpoint to which to direct the request.

Yields:

  • (result, operation) —

    Access the result along with the TransportOperation object

Yield Parameters:

Returns:

Raises:

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

    if the REST call is aborted.



347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
 
# File 'lib/google/cloud/dataflow/v1beta3/templates_service/rest/client.rb', line 347

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

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Dataflow::V1beta3::LaunchTemplateRequest

  # 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.launch_template.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::Dataflow::V1beta3::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.launch_template.timeout,
                         metadata:     call_metadata,
                         retry_policy: @config.rpcs.launch_template.retry_policy

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

  @templates_service_stub.launch_template 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) 


173
174
175
 
# File 'lib/google/cloud/dataflow/v1beta3/templates_service/rest/client.rb', line 173

def logger
  @templates_service_stub.logger
end

#universe_domain ⇒ String

The effective universe domain

Returns:

  • (String) 


106
107
108
 
# File 'lib/google/cloud/dataflow/v1beta3/templates_service/rest/client.rb', line 106

def universe_domain
  @templates_service_stub.universe_domain
end