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

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

Overview

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 client object.

Examples:


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

# Create a client using a custom configuration
client = ::Google::Cloud::DeviceStreaming::V1::DirectAccessService::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
195
196
197
198
199
200
201
202
203
 
# File 'lib/google/cloud/device_streaming/v1/direct_access_service/client.rb', line 154

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

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

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

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

  @direct_access_service_stub = ::Gapic::ServiceStub.new(
    ::Google::Cloud::DeviceStreaming::V1::DirectAccessService::Stub,
    credentials: credentials,
    endpoint: @config.endpoint,
    endpoint_template: DEFAULT_ENDPOINT_TEMPLATE,
    universe_domain: @config.universe_domain,
    channel_args: @config.channel_args,
    interceptors: @config.interceptors,
    channel_pool_config: @config.channel_pool,
    logger: @config.logger
  )

  @direct_access_service_stub.stub_logger&.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::Client.configure do |config|
  config.timeout = 10.0
end

Yields:

  • (config) —

    Configure the Client client.

Yield Parameters:

Returns:



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

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.rpcs.adb_connect.timeout = 1800.0

    default_config
  end
  yield @configure if block_given?
  @configure
end

Instance Method Details

#adb_connect(request, options = nil) {|response, operation| ... } ⇒ ::Enumerable<::Google::Cloud::DeviceStreaming::V1::DeviceMessage>

Exposes an ADB connection if the device supports ADB. gRPC headers are used to authenticate the Connect RPC, as well as associate to a particular DeviceSession. In particular, the user must specify the "X-Omnilab-Session-Name" header.

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::Client.new

# Create an input stream.
input = Gapic::StreamInput.new

# Call the adb_connect method to start streaming.
output = client.adb_connect input

# Send requests on the stream. For each request object, set fields by
# passing keyword arguments. Be sure to close the stream when done.
input << Google::Cloud::DeviceStreaming::V1::AdbMessage.new
input << Google::Cloud::DeviceStreaming::V1::AdbMessage.new
input.close

# The returned object is a streamed enumerable yielding elements of type
# ::Google::Cloud::DeviceStreaming::V1::DeviceMessage
output.each do |current_response|
  p current_response
end

Parameters:

  • request (::Gapic::StreamInput, ::Enumerable<::Google::Cloud::DeviceStreaming::V1::AdbMessage, ::Hash>) —

    An enumerable of AdbMessage instances.

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

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

Yields:

  • (response, operation) —

    Access the result along with the RPC operation

Yield Parameters:

Returns:

Raises:

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

    if the RPC is aborted.



719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
 
# File 'lib/google/cloud/device_streaming/v1/direct_access_service/client.rb', line 719

def adb_connect request, options = nil
  unless request.is_a? ::Enumerable
    raise ::ArgumentError, "request must be an Enumerable" unless request.respond_to? :to_enum
    request = request.to_enum
  end

  request = request.lazy.map do |req|
    ::Gapic::Protobuf.coerce req, to: ::Google::Cloud::DeviceStreaming::V1::AdbMessage
  end

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

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

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

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

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

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

#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::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:

  • (response, operation) —

    Access the result along with the RPC operation

Yield Parameters:

Returns:

Raises:

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

    if the RPC is aborted.



545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
 
# File 'lib/google/cloud/device_streaming/v1/direct_access_service/client.rb', line 545

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
  metadata = @config.rpcs.cancel_device_session.metadata.to_h

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

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

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

  options.apply_defaults timeout:      @config.rpcs.cancel_device_session.timeout,
                         metadata:     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.call_rpc :cancel_device_session, request, options: options do |response, operation|
    yield response, operation if block_given?
  end
rescue ::GRPC::BadStatus => 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/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::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:

  • (response, operation) —

    Access the result along with the RPC operation

Yield Parameters:

Returns:

Raises:

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

    if the RPC 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
303
304
305
306
307
308
 
# File 'lib/google/cloud/device_streaming/v1/direct_access_service/client.rb', line 269

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
  metadata = @config.rpcs.create_device_session.metadata.to_h

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

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

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

  options.apply_defaults timeout:      @config.rpcs.create_device_session.timeout,
                         metadata:     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.call_rpc :create_device_session, request, options: options do |response, operation|
    yield response, operation if block_given?
  end
rescue ::GRPC::BadStatus => 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::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:

  • (response, operation) —

    Access the result along with the RPC operation

Yield Parameters:

Returns:

Raises:

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

    if the RPC is aborted.



455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
 
# File 'lib/google/cloud/device_streaming/v1/direct_access_service/client.rb', line 455

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
  metadata = @config.rpcs.get_device_session.metadata.to_h

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

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

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

  options.apply_defaults timeout:      @config.rpcs.get_device_session.timeout,
                         metadata:     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.call_rpc :get_device_session, request, options: options do |response, operation|
    yield response, operation if block_given?
  end
rescue ::GRPC::BadStatus => e
  raise ::Google::Cloud::Error.from_error(e)
end

#list_device_sessions(request, options = nil) ⇒ ::Gapic::PagedEnumerable<::Google::Cloud::DeviceStreaming::V1::DeviceSession> #list_device_sessions(parent: nil, page_size: nil, page_token: nil, filter: nil) ⇒ ::Gapic::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::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::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::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:

  • (response, operation) —

    Access the result along with the RPC operation

Yield Parameters:

Returns:

Raises:

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

    if the RPC is aborted.



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
395
396
397
398
399
400
401
402
403
404
405
406
 
# File 'lib/google/cloud/device_streaming/v1/direct_access_service/client.rb', line 365

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
  metadata = @config.rpcs.list_device_sessions.metadata.to_h

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

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

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

  options.apply_defaults timeout:      @config.rpcs.list_device_sessions.timeout,
                         metadata:     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.call_rpc :list_device_sessions, request, options: options do |response, operation|
    response = ::Gapic::PagedEnumerable.new @direct_access_service_stub, :list_device_sessions, request, response, operation, options
    yield response, operation if block_given?
    throw :response, response
  end
rescue ::GRPC::BadStatus => e
  raise ::Google::Cloud::Error.from_error(e)
end

#logger ⇒ Logger

The logger used for request/response debug logging.

Returns:

  • (Logger) 


210
211
212
 
# File 'lib/google/cloud/device_streaming/v1/direct_access_service/client.rb', line 210

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/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::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:

  • (response, operation) —

    Access the result along with the RPC operation

Yield Parameters:

Returns:

Raises:

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

    if the RPC is aborted.



635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
 
# File 'lib/google/cloud/device_streaming/v1/direct_access_service/client.rb', line 635

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
  metadata = @config.rpcs.update_device_session.metadata.to_h

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

  header_params = {}
  if request.device_session&.name
    header_params["device_session.name"] = request.device_session.name
  end

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

  options.apply_defaults timeout:      @config.rpcs.update_device_session.timeout,
                         metadata:     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.call_rpc :update_device_session, request, options: options do |response, operation|
    yield response, operation if block_given?
  end
rescue ::GRPC::BadStatus => e
  raise ::Google::Cloud::Error.from_error(e)
end