Class: Google::Cloud::DeviceStreaming::V1::DirectAccessService::Rest::Client

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

Overview

REST client for the DirectAccessService service.

A service for allocating Android devices and interacting with the live-allocated devices.

Each Session will wait for available capacity, at a higher priority over Test Execution. When allocated, the session will be exposed through a stream for integration.

DirectAccessService is currently available as a preview to select developers. You can register today on behalf of you and your team at https://developer.android.com/studio/preview/android-device-streaming

Defined Under Namespace

Classes: Configuration

Class Method Summary collapse

Instance Method Summary collapse

Methods included from Paths

#device_session_path, #project_path

Constructor Details

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

Create a new DirectAccessService REST client object.

Examples:


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

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

Yields:

  • (config) —

    Configure the DirectAccessService client.

Yield Parameters:



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
 
# File 'lib/google/cloud/device_streaming/v1/direct_access_service/rest/client.rb', line 154

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

  @direct_access_service_stub = ::Google::Cloud::DeviceStreaming::V1::DirectAccessService::Rest::ServiceStub.new(
    endpoint: @config.endpoint,
    endpoint_template: DEFAULT_ENDPOINT_TEMPLATE,
    universe_domain: @config.universe_domain,
    credentials: credentials,
    logger: @config.logger
  )

  @direct_access_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 DirectAccessService Client class.

See Configuration for a description of the configuration fields.

Examples:


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

Yields:

  • (config) —

    Configure the Client client.

Yield Parameters:

Returns:



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
 
# File 'lib/google/cloud/device_streaming/v1/direct_access_service/rest/client.rb', line 73

def self.configure
  @configure ||= begin
    namespace = ["Google", "Cloud", "DeviceStreaming", "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.create_device_session.timeout = 20.0

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

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

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

    default_config.rpcs.update_device_session.timeout = 20.0

    default_config
  end
  yield @configure if block_given?
  @configure
end

Instance Method Details

#cancel_device_session(request, options = nil) ⇒ ::Google::Protobuf::Empty #cancel_device_session(name: nil) ⇒ ::Google::Protobuf::Empty

Cancel a DeviceSession. This RPC changes the DeviceSession to state FINISHED and terminates all connections. Canceled sessions are not deleted and can be retrieved or listed by the user until they expire based on the 28 day deletion policy.

Examples:

Basic example

require "google/cloud/device_streaming/v1"

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

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

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

# The returned object is of type Google::Protobuf::Empty.
p result

Overloads:

  • #cancel_device_session(request, options = nil) ⇒ ::Google::Protobuf::Empty

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

    Parameters:

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

  • #cancel_device_session(name: nil) ⇒ ::Google::Protobuf::Empty

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

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

      Required. Name of the DeviceSession, e.g. "projects/{project_id}/deviceSessions/{session_id}"

Yields:

  • (result, operation) —

    Access the result along with the TransportOperation object

Yield Parameters:

Returns:

Raises:

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

    if the REST call is aborted.



514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
 
# File 'lib/google/cloud/device_streaming/v1/direct_access_service/rest/client.rb', line 514

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

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::DeviceStreaming::V1::CancelDeviceSessionRequest

  # 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.cancel_device_session.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::DeviceStreaming::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.cancel_device_session.timeout,
                         metadata:     call_metadata,
                         retry_policy: @config.rpcs.cancel_device_session.retry_policy

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

  @direct_access_service_stub.cancel_device_session 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

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

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



124
125
126
127
 
# File 'lib/google/cloud/device_streaming/v1/direct_access_service/rest/client.rb', line 124

def configure
  yield @config if block_given?
  @config
end

#create_device_session(request, options = nil) ⇒ ::Google::Cloud::DeviceStreaming::V1::DeviceSession #create_device_session(parent: nil, device_session: nil, device_session_id: nil) ⇒ ::Google::Cloud::DeviceStreaming::V1::DeviceSession

Creates a DeviceSession.

Examples:

Basic example

require "google/cloud/device_streaming/v1"

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

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

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

# The returned object is of type Google::Cloud::DeviceStreaming::V1::DeviceSession.
p result

Overloads:

  • #create_device_session(request, options = nil) ⇒ ::Google::Cloud::DeviceStreaming::V1::DeviceSession

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

    Parameters:

    • request (::Google::Cloud::DeviceStreaming::V1::CreateDeviceSessionRequest, ::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_device_session(parent: nil, device_session: nil, device_session_id: nil) ⇒ ::Google::Cloud::DeviceStreaming::V1::DeviceSession

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

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

      Required. The Compute Engine project under which this device will be allocated. "projects/{project_id}"

    • device_session (::Google::Cloud::DeviceStreaming::V1::DeviceSession, ::Hash) (defaults to: nil) —

      Required. A DeviceSession to create.

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

      Optional. The ID to use for the DeviceSession, which will become the final component of the DeviceSession's resource name.

      This value should be 4-63 characters, and valid characters are /[a-z][0-9]-/.

Yields:

  • (result, operation) —

    Access the result along with the TransportOperation object

Yield Parameters:

Returns:

Raises:

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

    if the REST call is aborted.



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
 
# File 'lib/google/cloud/device_streaming/v1/direct_access_service/rest/client.rb', line 259

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

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::DeviceStreaming::V1::CreateDeviceSessionRequest

  # 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_device_session.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::DeviceStreaming::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.create_device_session.timeout,
                         metadata:     call_metadata,
                         retry_policy: @config.rpcs.create_device_session.retry_policy

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

  @direct_access_service_stub.create_device_session 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_device_session(request, options = nil) ⇒ ::Google::Cloud::DeviceStreaming::V1::DeviceSession #get_device_session(name: nil) ⇒ ::Google::Cloud::DeviceStreaming::V1::DeviceSession

Gets a DeviceSession, which documents the allocation status and whether the device is allocated. Clients making requests from this API must poll GetDeviceSession.

Examples:

Basic example

require "google/cloud/device_streaming/v1"

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

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

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

# The returned object is of type Google::Cloud::DeviceStreaming::V1::DeviceSession.
p result

Overloads:

  • #get_device_session(request, options = nil) ⇒ ::Google::Cloud::DeviceStreaming::V1::DeviceSession

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

    Parameters:

    • request (::Google::Cloud::DeviceStreaming::V1::GetDeviceSessionRequest, ::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_device_session(name: nil) ⇒ ::Google::Cloud::DeviceStreaming::V1::DeviceSession

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

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

      Required. Name of the DeviceSession, e.g. "projects/{project_id}/deviceSessions/{session_id}"

Yields:

  • (result, operation) —

    Access the result along with the TransportOperation object

Yield Parameters:

Returns:

Raises:

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

    if the REST call is aborted.



431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
 
# File 'lib/google/cloud/device_streaming/v1/direct_access_service/rest/client.rb', line 431

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

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::DeviceStreaming::V1::GetDeviceSessionRequest

  # 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_device_session.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::DeviceStreaming::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.get_device_session.timeout,
                         metadata:     call_metadata,
                         retry_policy: @config.rpcs.get_device_session.retry_policy

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

  @direct_access_service_stub.get_device_session 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

#list_device_sessions(request, options = nil) ⇒ ::Gapic::Rest::PagedEnumerable<::Google::Cloud::DeviceStreaming::V1::DeviceSession> #list_device_sessions(parent: nil, page_size: nil, page_token: nil, filter: nil) ⇒ ::Gapic::Rest::PagedEnumerable<::Google::Cloud::DeviceStreaming::V1::DeviceSession>

Lists DeviceSessions owned by the project user.

Examples:

Basic example

require "google/cloud/device_streaming/v1"

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

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

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

# The returned object is of type Gapic::PagedEnumerable. You can iterate
# over elements, and API calls will be issued to fetch pages as needed.
result.each do |item|
  # Each element is of type ::Google::Cloud::DeviceStreaming::V1::DeviceSession.
  p item
end

Overloads:

  • #list_device_sessions(request, options = nil) ⇒ ::Gapic::Rest::PagedEnumerable<::Google::Cloud::DeviceStreaming::V1::DeviceSession>

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

    Parameters:

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

  • #list_device_sessions(parent: nil, page_size: nil, page_token: nil, filter: nil) ⇒ ::Gapic::Rest::PagedEnumerable<::Google::Cloud::DeviceStreaming::V1::DeviceSession>

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

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

      Required. The name of the parent to request, e.g. "projects/{project_id}"

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

      Optional. The maximum number of DeviceSessions to return.

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

      Optional. A continuation token for paging.

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

      Optional. If specified, responses will be filtered by the given filter. Allowed fields are: session_state.

Yields:

  • (result, operation) —

    Access the result along with the TransportOperation object

Yield Parameters:

Returns:

Raises:

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

    if the REST call is aborted.



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
381
382
383
 
# File 'lib/google/cloud/device_streaming/v1/direct_access_service/rest/client.rb', line 348

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

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::DeviceStreaming::V1::ListDeviceSessionsRequest

  # 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.list_device_sessions.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::DeviceStreaming::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.list_device_sessions.timeout,
                         metadata:     call_metadata,
                         retry_policy: @config.rpcs.list_device_sessions.retry_policy

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

  @direct_access_service_stub.list_device_sessions request, options do |result, operation|
    result = ::Gapic::Rest::PagedEnumerable.new @direct_access_service_stub, :list_device_sessions, "device_sessions", request, result, options
    yield result, operation if block_given?
    throw :response, result
  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) 


201
202
203
 
# File 'lib/google/cloud/device_streaming/v1/direct_access_service/rest/client.rb', line 201

def logger
  @direct_access_service_stub.logger
end

#universe_domain ⇒ String

The effective universe domain

Returns:

  • (String) 


134
135
136
 
# File 'lib/google/cloud/device_streaming/v1/direct_access_service/rest/client.rb', line 134

def universe_domain
  @direct_access_service_stub.universe_domain
end

#update_device_session(request, options = nil) ⇒ ::Google::Cloud::DeviceStreaming::V1::DeviceSession #update_device_session(device_session: nil, update_mask: nil) ⇒ ::Google::Cloud::DeviceStreaming::V1::DeviceSession

Updates the current DeviceSession to the fields described by the update_mask.

Examples:

Basic example

require "google/cloud/device_streaming/v1"

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

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

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

# The returned object is of type Google::Cloud::DeviceStreaming::V1::DeviceSession.
p result

Overloads:

  • #update_device_session(request, options = nil) ⇒ ::Google::Cloud::DeviceStreaming::V1::DeviceSession

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

    Parameters:

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

  • #update_device_session(device_session: nil, update_mask: nil) ⇒ ::Google::Cloud::DeviceStreaming::V1::DeviceSession

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

Yields:

  • (result, operation) —

    Access the result along with the TransportOperation object

Yield Parameters:

Returns:

Raises:

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

    if the REST call is aborted.



597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
 
# File 'lib/google/cloud/device_streaming/v1/direct_access_service/rest/client.rb', line 597

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

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::DeviceStreaming::V1::UpdateDeviceSessionRequest

  # 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.update_device_session.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::DeviceStreaming::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.update_device_session.timeout,
                         metadata:     call_metadata,
                         retry_policy: @config.rpcs.update_device_session.retry_policy

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

  @direct_access_service_stub.update_device_session 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