Class: Google::Longrunning::OperationsClient

Inherits:
Object
  • Object
show all
Defined in:
lib/google/longrunning/operations_client.rb

Overview

Manages long-running operations with an API service.

When an API method normally takes long time to complete, it can be designed to return Operation to the client, and the client can use this interface to receive the real response asynchronously by polling the operation resource, or pass the operation resource to another API (such as Google Cloud Pub/Sub API) to receive the response. Any API service that returns long-running operations should implement the Operations interface so developers can have a consistent client experience.

Constant Summary collapse

SERVICE_ADDRESS =

The default address of the service.

"longrunning.googleapis.com".freeze
DEFAULT_SERVICE_PORT =

The default port of the service.

443
DEFAULT_TIMEOUT = 
30
ALL_SCOPES =

The scopes needed to make gRPC calls to all of the methods defined in this service.

[
].freeze

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(credentials: nil, scopes: ALL_SCOPES, client_config: {}, timeout: DEFAULT_TIMEOUT, lib_name: nil, lib_version: "", service_address: nil, service_port: nil, metadata: nil) ⇒ OperationsClient

Returns a new instance of OperationsClient.

Parameters:

  • credentials (Google::Auth::Credentials, String, Hash, GRPC::Core::Channel, GRPC::Core::ChannelCredentials, Proc) (defaults to: nil) —

    Provides the means for authenticating requests made by the client. This parameter can be many types. A ‘Google::Auth::Credentials` uses a the properties of its represented keyfile for authenticating requests made by this client. A `String` will be treated as the path to the keyfile to be used for the construction of credentials for this client. A `Hash` will be treated as the contents of a keyfile to be used for the construction of credentials for this client. A `GRPC::Core::Channel` will be used to make calls through. A `GRPC::Core::ChannelCredentials` for the setting up the RPC client. The channel credentials should already be composed with a `GRPC::Core::CallCredentials` object. A `Proc` will be used as an updater_proc for the Grpc channel. The proc transforms the metadata for requests, generally, to give OAuth credentials.

  • scopes (Array<String>) (defaults to: ALL_SCOPES) —

    The OAuth scopes for this service. This parameter is ignored if an updater_proc is supplied.

  • client_config (Hash) (defaults to: {}) —

    A Hash for call options for each method. See Google::Gax#construct_settings for the structure of this data. Falls back to the default config if not specified or the specified config is missing data points.

  • timeout (Numeric) (defaults to: DEFAULT_TIMEOUT) —

    The default timeout, in seconds, for calls made through this client.

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

    The hostname of the backend service. Defaults to SERVICE_ADDRESS.

  • service_port (Integer) (defaults to: nil) —

    The port of the backend service. Defaults to DEFAULT_SERVICE_PORT.

  • metadata (Hash) (defaults to: nil) —

    The request metadata headers.



118
119
120
121
122
123
124
125
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
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
 
# File 'lib/google/longrunning/operations_client.rb', line 118

def initialize \
    credentials: nil,
    scopes: ALL_SCOPES,
    client_config: {},
    timeout: DEFAULT_TIMEOUT,
    lib_name: nil,
    lib_version: "",
    service_address: nil,
    service_port: nil,
    metadata: nil
  # 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 "google/gax/grpc"
  require "google/longrunning/operations_services_pb"

  credentials ||= Google::Auth::Credentials.default(scope: scopes)

  if credentials.is_a?(String) || credentials.is_a?(Hash)
    updater_proc = Google::Auth::Credentials.new(credentials, scope: scopes).updater_proc
  end
  if credentials.is_a?(GRPC::Core::Channel)
    channel = credentials
  end
  if credentials.is_a?(GRPC::Core::ChannelCredentials)
    chan_creds = credentials
  end
  if credentials.is_a?(Proc)
    updater_proc = credentials
  end
  if credentials.is_a?(Google::Auth::Credentials)
    updater_proc = credentials.updater_proc
  end

  metadata ||= {}
  metadata[:"x-goog-api-client"] ||= begin
    google_api_client = ["gl-ruby/#{RUBY_VERSION}"]
    google_api_client << "#{lib_name}/#{lib_version}" if lib_name
    google_api_client << "gax/#{Google::Gax::VERSION}"
    google_api_client << "grpc/#{GRPC::VERSION}"
    google_api_client.join(' ').freeze
  end

  client_config_file = Pathname.new(__dir__).join(
    "operations_client_config.json"
  )

  defaults = client_config_file.open do |f|
    Google::Gax.construct_settings(
      "google.longrunning.Operations",
      JSON.parse(f.read),
      client_config,
      Google::Gax::Grpc::STATUS_CODE_NAMES,
      timeout,
      page_descriptors: PAGE_DESCRIPTORS,
      errors: Google::Gax::Grpc::API_ERRORS,
      metadata: metadata
    )
  end

  # Allow overriding the service path/port in subclasses.
  service_path = service_address || self.class::SERVICE_ADDRESS
  port = service_port || self.class::DEFAULT_SERVICE_PORT
  @operations_stub = Google::Gax::Grpc.create_stub(
    service_path,
    port,
    chan_creds: chan_creds,
    channel: channel,
    updater_proc: updater_proc,
    scopes: scopes,
    &Google::Longrunning::Operations::Stub.method(:new)
  )

  @get_operation = Google::Gax.create_api_call(
    @operations_stub.method(:get_operation),
    defaults["get_operation"]
  )
  @list_operations = Google::Gax.create_api_call(
    @operations_stub.method(:list_operations),
    defaults["list_operations"]
  )
  @cancel_operation = Google::Gax.create_api_call(
    @operations_stub.method(:cancel_operation),
    defaults["cancel_operation"]
  )
  @delete_operation = Google::Gax.create_api_call(
    @operations_stub.method(:delete_operation),
    defaults["delete_operation"]
  )
end

Instance Attribute Details

#operations_stub ⇒ Google::Longrunning::Operations::Stub (readonly)

Returns:

  • (Google::Longrunning::Operations::Stub) 


62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
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
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
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
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
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
 
# File 'lib/google/longrunning/operations_client.rb', line 62

class OperationsClient
  attr_reader :operations_stub

  # The default address of the service.
  SERVICE_ADDRESS = "longrunning.googleapis.com".freeze

  # The default port of the service.
  DEFAULT_SERVICE_PORT = 443

  DEFAULT_TIMEOUT = 30

  PAGE_DESCRIPTORS = {
    "list_operations" => Google::Gax::PageDescriptor.new(
      "page_token",
      "next_page_token",
      "operations")
  }.freeze

  private_constant :PAGE_DESCRIPTORS

  # The scopes needed to make gRPC calls to all of the methods defined in
  # this service.
  ALL_SCOPES = [
  ].freeze


  # @param credentials [Google::Auth::Credentials, String, Hash, GRPC::Core::Channel, GRPC::Core::ChannelCredentials, Proc]
  #   Provides the means for authenticating requests made by the client. This parameter can
  #   be many types.
  #   A `Google::Auth::Credentials` uses a the properties of its represented keyfile for
  #   authenticating requests made by this client.
  #   A `String` will be treated as the path to the keyfile to be used for the construction of
  #   credentials for this client.
  #   A `Hash` will be treated as the contents of a keyfile to be used for the construction of
  #   credentials for this client.
  #   A `GRPC::Core::Channel` will be used to make calls through.
  #   A `GRPC::Core::ChannelCredentials` for the setting up the RPC client. The channel credentials
  #   should already be composed with a `GRPC::Core::CallCredentials` object.
  #   A `Proc` will be used as an updater_proc for the Grpc channel. The proc transforms the
  #   metadata for requests, generally, to give OAuth credentials.
  # @param scopes [Array<String>]
  #   The OAuth scopes for this service. This parameter is ignored if
  #   an updater_proc is supplied.
  # @param client_config [Hash]
  #   A Hash for call options for each method. See
  #   Google::Gax#construct_settings for the structure of
  #   this data. Falls back to the default config if not specified
  #   or the specified config is missing data points.
  # @param timeout [Numeric]
  #   The default timeout, in seconds, for calls made through this client.
  # @param service_address [String]
  #   The hostname of the backend service. Defaults to {SERVICE_ADDRESS}.
  # @param service_port [Integer]
  #   The port of the backend service. Defaults to {DEFAULT_SERVICE_PORT}.
  # @param metadata [Hash]
  #   The request metadata headers.
  def initialize \
      credentials: nil,
      scopes: ALL_SCOPES,
      client_config: {},
      timeout: DEFAULT_TIMEOUT,
      lib_name: nil,
      lib_version: "",
      service_address: nil,
      service_port: nil,
      metadata: nil
    # 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 "google/gax/grpc"
    require "google/longrunning/operations_services_pb"

    credentials ||= Google::Auth::Credentials.default(scope: scopes)

    if credentials.is_a?(String) || credentials.is_a?(Hash)
      updater_proc = Google::Auth::Credentials.new(credentials, scope: scopes).updater_proc
    end
    if credentials.is_a?(GRPC::Core::Channel)
      channel = credentials
    end
    if credentials.is_a?(GRPC::Core::ChannelCredentials)
      chan_creds = credentials
    end
    if credentials.is_a?(Proc)
      updater_proc = credentials
    end
    if credentials.is_a?(Google::Auth::Credentials)
      updater_proc = credentials.updater_proc
    end

    metadata ||= {}
    metadata[:"x-goog-api-client"] ||= begin
      google_api_client = ["gl-ruby/#{RUBY_VERSION}"]
      google_api_client << "#{lib_name}/#{lib_version}" if lib_name
      google_api_client << "gax/#{Google::Gax::VERSION}"
      google_api_client << "grpc/#{GRPC::VERSION}"
      google_api_client.join(' ').freeze
    end

    client_config_file = Pathname.new(__dir__).join(
      "operations_client_config.json"
    )

    defaults = client_config_file.open do |f|
      Google::Gax.construct_settings(
        "google.longrunning.Operations",
        JSON.parse(f.read),
        client_config,
        Google::Gax::Grpc::STATUS_CODE_NAMES,
        timeout,
        page_descriptors: PAGE_DESCRIPTORS,
        errors: Google::Gax::Grpc::API_ERRORS,
        metadata: metadata
      )
    end

    # Allow overriding the service path/port in subclasses.
    service_path = service_address || self.class::SERVICE_ADDRESS
    port = service_port || self.class::DEFAULT_SERVICE_PORT
    @operations_stub = Google::Gax::Grpc.create_stub(
      service_path,
      port,
      chan_creds: chan_creds,
      channel: channel,
      updater_proc: updater_proc,
      scopes: scopes,
      &Google::Longrunning::Operations::Stub.method(:new)
    )

    @get_operation = Google::Gax.create_api_call(
      @operations_stub.method(:get_operation),
      defaults["get_operation"]
    )
    @list_operations = Google::Gax.create_api_call(
      @operations_stub.method(:list_operations),
      defaults["list_operations"]
    )
    @cancel_operation = Google::Gax.create_api_call(
      @operations_stub.method(:cancel_operation),
      defaults["cancel_operation"]
    )
    @delete_operation = Google::Gax.create_api_call(
      @operations_stub.method(:delete_operation),
      defaults["delete_operation"]
    )
  end

  # Service calls

  # Gets the latest state of a long-running operation.  Clients can use this
  # method to poll the operation result at intervals as recommended by the API
  # service.
  #
  # @param name [String]
  #   The name of the operation resource.
  # @param options [Google::Gax::CallOptions]
  #   Overrides the default settings for this call, e.g, timeout,
  #   retries, etc.
  # @return [Google::Longrunning::Operation]
  # @raise [Google::Gax::GaxError] if the RPC is aborted.
  # @example
  #   require "google/longrunning"
  #
  #   operations_client = Google::Longrunning.new
  #   name = ''
  #   response = operations_client.get_operation(name)

  def get_operation \
      name,
      options: nil
    req = {
      name: name
    }.delete_if { |_, v| v.nil? }
    req = Google::Gax::to_proto(req, Google::Longrunning::GetOperationRequest)
    @get_operation.call(req, options)
  end

  # Lists operations that match the specified filter in the request. If the
  # server doesn't support this method, it returns +UNIMPLEMENTED+.
  #
  # NOTE: the +name+ binding below allows API services to override the binding
  # to use different resource name schemes, such as +users/*/operations+.
  #
  # @param name [String]
  #   The name of the operation collection.
  # @param filter [String]
  #   The standard list filter.
  # @param page_size [Integer]
  #   The maximum number of resources contained in the underlying API
  #   response. If page streaming is performed per-resource, this
  #   parameter does not affect the return value. If page streaming is
  #   performed per-page, this determines the maximum number of
  #   resources in a page.
  # @param options [Google::Gax::CallOptions]
  #   Overrides the default settings for this call, e.g, timeout,
  #   retries, etc.
  # @return [Google::Gax::PagedEnumerable<Google::Longrunning::Operation>]
  #   An enumerable of Google::Longrunning::Operation instances.
  #   See Google::Gax::PagedEnumerable documentation for other
  #   operations such as per-page iteration or access to the response
  #   object.
  # @raise [Google::Gax::GaxError] if the RPC is aborted.
  # @example
  #   require "google/longrunning"
  #
  #   operations_client = Google::Longrunning.new
  #   name = ''
  #   filter = ''
  #
  #   # Iterate over all results.
  #   operations_client.list_operations(name, filter).each do |element|
  #     # Process element.
  #   end
  #
  #   # Or iterate over results one page at a time.
  #   operations_client.list_operations(name, filter).each_page do |page|
  #     # Process each page at a time.
  #     page.each do |element|
  #       # Process element.
  #     end
  #   end

  def list_operations \
      name,
      filter,
      page_size: nil,
      options: nil
    req = {
      name: name,
      filter: filter,
      page_size: page_size
    }.delete_if { |_, v| v.nil? }
    req = Google::Gax::to_proto(req, Google::Longrunning::ListOperationsRequest)
    @list_operations.call(req, options)
  end

  # Starts asynchronous cancellation on a long-running operation.  The server
  # makes a best effort to cancel the operation, but success is not
  # guaranteed.  If the server doesn't support this method, it returns
  # +google.rpc.Code.UNIMPLEMENTED+.  Clients can use
  # {Google::Longrunning::Operations::GetOperation Operations::GetOperation} or
  # other methods to check whether the cancellation succeeded or whether the
  # operation completed despite cancellation. On successful cancellation,
  # the operation is not deleted; instead, it becomes an operation with
  # an {Google::Longrunning::Operation#error Operation#error} value with a {Google::Rpc::Status#code} of 1,
  # corresponding to +Code.CANCELLED+.
  #
  # @param name [String]
  #   The name of the operation resource to be cancelled.
  # @param options [Google::Gax::CallOptions]
  #   Overrides the default settings for this call, e.g, timeout,
  #   retries, etc.
  # @raise [Google::Gax::GaxError] if the RPC is aborted.
  # @example
  #   require "google/longrunning"
  #
  #   operations_client = Google::Longrunning.new
  #   name = ''
  #   operations_client.cancel_operation(name)

  def cancel_operation \
      name,
      options: nil
    req = {
      name: name
    }.delete_if { |_, v| v.nil? }
    req = Google::Gax::to_proto(req, Google::Longrunning::CancelOperationRequest)
    @cancel_operation.call(req, options)
    nil
  end

  # Deletes a long-running operation. This method indicates that the client is
  # no longer interested in the operation result. It does not cancel the
  # operation. If the server doesn't support this method, it returns
  # +google.rpc.Code.UNIMPLEMENTED+.
  #
  # @param name [String]
  #   The name of the operation resource to be deleted.
  # @param options [Google::Gax::CallOptions]
  #   Overrides the default settings for this call, e.g, timeout,
  #   retries, etc.
  # @raise [Google::Gax::GaxError] if the RPC is aborted.
  # @example
  #   require "google/longrunning"
  #
  #   operations_client = Google::Longrunning.new
  #   name = ''
  #   operations_client.delete_operation(name)

  def delete_operation \
      name,
      options: nil
    req = {
      name: name
    }.delete_if { |_, v| v.nil? }
    req = Google::Gax::to_proto(req, Google::Longrunning::DeleteOperationRequest)
    @delete_operation.call(req, options)
    nil
  end
end

Instance Method Details

#cancel_operation(name, options: nil) ⇒ Object

Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn’t support this method, it returns google.rpc.Code.UNIMPLEMENTED. Clients can use Operations::GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation#error value with a Rpc::Status#code of 1, corresponding to Code.CANCELLED.

Examples:

require "google/longrunning"

operations_client = Google::Longrunning.new
name = ''
operations_client.cancel_operation(name)

Parameters:

  • name (String) —

    The name of the operation resource to be cancelled.

  • options (Google::Gax::CallOptions) (defaults to: nil) —

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

Raises:



322
323
324
325
326
327
328
329
330
331
 
# File 'lib/google/longrunning/operations_client.rb', line 322

def cancel_operation \
    name,
    options: nil
  req = {
    name: name
  }.delete_if { |_, v| v.nil? }
  req = Google::Gax::to_proto(req, Google::Longrunning::CancelOperationRequest)
  @cancel_operation.call(req, options)
  nil
end

#delete_operation(name, options: nil) ⇒ Object

Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn’t support this method, it returns google.rpc.Code.UNIMPLEMENTED.

Examples:

require "google/longrunning"

operations_client = Google::Longrunning.new
name = ''
operations_client.delete_operation(name)

Parameters:

  • name (String) —

    The name of the operation resource to be deleted.

  • options (Google::Gax::CallOptions) (defaults to: nil) —

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

Raises:



351
352
353
354
355
356
357
358
359
360
 
# File 'lib/google/longrunning/operations_client.rb', line 351

def delete_operation \
    name,
    options: nil
  req = {
    name: name
  }.delete_if { |_, v| v.nil? }
  req = Google::Gax::to_proto(req, Google::Longrunning::DeleteOperationRequest)
  @delete_operation.call(req, options)
  nil
end

#get_operation(name, options: nil) ⇒ Google::Longrunning::Operation

Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.

Examples:

require "google/longrunning"

operations_client = Google::Longrunning.new
name = ''
response = operations_client.get_operation(name)

Parameters:

  • name (String) —

    The name of the operation resource.

  • options (Google::Gax::CallOptions) (defaults to: nil) —

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

Returns:

  • (Google::Longrunning::Operation)

Raises:



229
230
231
232
233
234
235
236
237
 
# File 'lib/google/longrunning/operations_client.rb', line 229

def get_operation \
    name,
    options: nil
  req = {
    name: name
  }.delete_if { |_, v| v.nil? }
  req = Google::Gax::to_proto(req, Google::Longrunning::GetOperationRequest)
  @get_operation.call(req, options)
end

#list_operations(name, filter, page_size: nil, options: nil) ⇒ Google::Gax::PagedEnumerable<Google::Longrunning::Operation>

Lists operations that match the specified filter in the request. If the server doesn’t support this method, it returns UNIMPLEMENTED.

NOTE: the name binding below allows API services to override the binding to use different resource name schemes, such as users/*/operations.

Examples:

require "google/longrunning"

operations_client = Google::Longrunning.new
name = ''
filter = ''

# Iterate over all results.
operations_client.list_operations(name, filter).each do |element|
  # Process element.
end

# Or iterate over results one page at a time.
operations_client.list_operations(name, filter).each_page do |page|
  # Process each page at a time.
  page.each do |element|
    # Process element.
  end
end

Parameters:

  • name (String) —

    The name of the operation collection.

  • filter (String) —

    The standard list filter.

  • page_size (Integer) (defaults to: nil) —

    The maximum number of resources contained in the underlying API response. If page streaming is performed per-resource, this parameter does not affect the return value. If page streaming is performed per-page, this determines the maximum number of resources in a page.

  • options (Google::Gax::CallOptions) (defaults to: nil) —

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

Returns:

  • (Google::Gax::PagedEnumerable<Google::Longrunning::Operation>) —

    An enumerable of Google::Longrunning::Operation instances. See Google::Gax::PagedEnumerable documentation for other operations such as per-page iteration or access to the response object.

Raises:



284
285
286
287
288
289
290
291
292
293
294
295
296
 
# File 'lib/google/longrunning/operations_client.rb', line 284

def list_operations \
    name,
    filter,
    page_size: nil,
    options: nil
  req = {
    name: name,
    filter: filter,
    page_size: page_size
  }.delete_if { |_, v| v.nil? }
  req = Google::Gax::to_proto(req, Google::Longrunning::ListOperationsRequest)
  @list_operations.call(req, options)
end