Device Streaming API - Module Google::Cloud::DeviceStreaming (v0.1.0)
Stay organized with collections
Save and categorize content based on your preferences.
Reference documentation and code samples for the Device Streaming API module Google::Cloud::DeviceStreaming.
Methods
.configure
defself.configure()->::Google::Cloud::Config
Configure the google-cloud-device_streaming library.
The following configuration parameters are supported:
credentials (type:String, Hash, Google::Auth::Credentials) -
The path to the keyfile as a String, the contents of the keyfile as a
Hash, or a Google::Auth::Credentials object.
lib_name (type:String) -
The library name as recorded in instrumentation and logging.
lib_version (type:String) -
The library version as recorded in instrumentation and logging.
interceptors (type:Array<GRPC::ClientInterceptor>) -
An array of interceptors that are run before calls are executed.
timeout (type:Numeric) -
Default timeout in seconds.
metadata (type:Hash{Symbol=>String}) -
Additional headers to be sent with the call.
retry_policy (type:Hash) -
The retry policy. The value is a hash with the following keys:
:initial_delay (type:Numeric) - The initial delay in seconds.
:max_delay (type:Numeric) - The max delay in seconds.
:multiplier (type:Numeric) - The incremental backoff multiplier.
:retry_codes (type:Array<String>) -
The error codes that should trigger a retry.
Yields
(::Google::Cloud.configure.device_streaming)
Returns
(::Google::Cloud::Config) — The default configuration used by this library
Create a new client object for DirectAccessService.
By default, this returns an instance of
Google::Cloud::DeviceStreaming::V1::DirectAccessService::Client
for a gRPC client for version V1 of the API.
However, you can specify a different API version by passing it in the
version parameter. If the DirectAccessService service is
supported by that API version, and the corresponding gem is available, the
appropriate versioned client will be returned.
You can also specify a different transport by passing :rest or :grpc in
the transport parameter.
Raises an exception if the currently installed versioned client gem for the
given API version does not support the given transport of the DirectAccessService service.
You can determine whether the method will succeed by calling
DeviceStreaming.direct_access_service_available?.
About DirectAccessService
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.
Determines whether the DirectAccessService service is supported by the current client.
If true, you can retrieve a client object by calling DeviceStreaming.direct_access_service.
If false, that method will raise an exception. This could happen if the given
API version does not exist or does not support the DirectAccessService service,
or if the versioned client gem needs an update to support the DirectAccessService service.
Parameters
version (::String, ::Symbol) (defaults to: :v1) — The API version to connect to. Optional.
Defaults to :v1.
transport (:grpc, :rest) (defaults to: :grpc) — The transport to use. Defaults to :grpc.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Hard to understand","hardToUnderstand","thumb-down"],["Incorrect information or sample code","incorrectInformationOrSampleCode","thumb-down"],["Missing the information/samples I need","missingTheInformationSamplesINeed","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-09-09 UTC."],[],[],null,["# Device Streaming API - Module Google::Cloud::DeviceStreaming (v0.1.0)\n\nReference documentation and code samples for the Device Streaming API module Google::Cloud::DeviceStreaming.\n\nMethods\n-------\n\n### .configure\n\n def self.configure() -\u003e ::Google::Cloud::Config\n\nConfigure the google-cloud-device_streaming library.\n\nThe following configuration parameters are supported:\n\n- `credentials` (*type:* `String, Hash, Google::Auth::Credentials`) - The path to the keyfile as a String, the contents of the keyfile as a Hash, or a Google::Auth::Credentials object.\n- `lib_name` (*type:* `String`) - The library name as recorded in instrumentation and logging.\n- `lib_version` (*type:* `String`) - The library version as recorded in instrumentation and logging.\n- `interceptors` (*type:* `Array\u003cGRPC::ClientInterceptor\u003e`) - An array of interceptors that are run before calls are executed.\n- `timeout` (*type:* `Numeric`) - Default timeout in seconds.\n- `metadata` (*type:* `Hash{Symbol=\u003eString}`) - Additional headers to be sent with the call.\n- `retry_policy` (*type:* `Hash`) - The retry policy. The value is a hash with the following keys:\n - `:initial_delay` (*type:* `Numeric`) - The initial delay in seconds.\n - `:max_delay` (*type:* `Numeric`) - The max delay in seconds.\n - `:multiplier` (*type:* `Numeric`) - The incremental backoff multiplier.\n- `:retry_codes` (*type:* `Array\u003cString\u003e`) - The error codes that should trigger a retry. \n**Yields**\n\n- (::Google::Cloud.configure.device_streaming) \n**Returns**\n\n- (::Google::Cloud::Config) --- The default configuration used by this library\n\n### .direct_access_service\n\n def self.direct_access_service(version: :v1, transport: :grpc, &block) -\u003e ::Object\n\nCreate a new client object for DirectAccessService.\n\n\nBy default, this returns an instance of\n[Google::Cloud::DeviceStreaming::V1::DirectAccessService::Client](https://cloud.google.com/ruby/docs/reference/google-cloud-device_streaming-v1/latest/Google-Cloud-DeviceStreaming-V1-DirectAccessService-Client)\nfor a gRPC client for version V1 of the API.\nHowever, you can specify a different API version by passing it in the\n`version` parameter. If the DirectAccessService service is\nsupported by that API version, and the corresponding gem is available, the\nappropriate versioned client will be returned.\nYou can also specify a different transport by passing `:rest` or `:grpc` in\nthe `transport` parameter.\n\nRaises an exception if the currently installed versioned client gem for the\ngiven API version does not support the given transport of the DirectAccessService service.\nYou can determine whether the method will succeed by calling\n[DeviceStreaming.direct_access_service_available?](/ruby/docs/reference/google-cloud-device_streaming/latest/Google-Cloud-DeviceStreaming#Google__Cloud__DeviceStreaming_direct_access_service_available__class_ \"Google::Cloud::DeviceStreaming.direct_access_service_available? (method)\").\n\n#### About DirectAccessService\n\nA service for allocating Android devices and interacting with the\nlive-allocated devices.\n\nEach Session will wait for available capacity, at a higher\npriority over Test Execution. When allocated, the session will be exposed\nthrough a stream for integration.\n\n\u003cbr /\u003e\n\nDirectAccessService is currently available as a preview to select developers.\nYou can register today on behalf of you and your team at\n\u003chttps://developer.android.com/studio/preview/android-device-streaming\u003e \n**Parameters**\n\n- **version** (::String, ::Symbol) *(defaults to: :v1)* --- The API version to connect to. Optional. Defaults to `:v1`.\n- **transport** (:grpc, :rest) *(defaults to: :grpc)* --- The transport to use. Defaults to `:grpc`. \n**Returns**\n\n- (::Object) --- A client object for the specified version.\n\n### .direct_access_service_available?\n\n def self.direct_access_service_available?(version: :v1, transport: :grpc) -\u003e boolean\n\nDetermines whether the DirectAccessService service is supported by the current client.\nIf true, you can retrieve a client object by calling [DeviceStreaming.direct_access_service](/ruby/docs/reference/google-cloud-device_streaming/latest/Google-Cloud-DeviceStreaming#Google__Cloud__DeviceStreaming_direct_access_service_class_ \"Google::Cloud::DeviceStreaming.direct_access_service (method)\").\nIf false, that method will raise an exception. This could happen if the given\nAPI version does not exist or does not support the DirectAccessService service,\nor if the versioned client gem needs an update to support the DirectAccessService service. \n**Parameters**\n\n- **version** (::String, ::Symbol) *(defaults to: :v1)* --- The API version to connect to. Optional. Defaults to `:v1`.\n- **transport** (:grpc, :rest) *(defaults to: :grpc)* --- The transport to use. Defaults to `:grpc`. \n**Returns**\n\n- (boolean) --- Whether the service is available.\n\nConstants\n---------\n\n### VERSION\n\n**value:**\"0.1.0\""]]