Device Streaming V1 API - Class Google::Cloud::DeviceStreaming::V1::DeviceSession (v0.1.0)

Reference documentation and code samples for the Device Streaming V1 API class Google::Cloud::DeviceStreaming::V1::DeviceSession.

Protobuf message describing the device message, used from several RPCs.

Inherits

  • Object

Extended By

  • Google::Protobuf::MessageExts::ClassMethods

Includes

  • Google::Protobuf::MessageExts

Methods

#active_start_time

def active_start_time() -> ::Google::Protobuf::Timestamp
Returns

#android_device

def android_device() -> ::Google::Cloud::DeviceStreaming::V1::AndroidDevice
Returns

#android_device=

def android_device=(value) -> ::Google::Cloud::DeviceStreaming::V1::AndroidDevice
Parameter
Returns

#create_time

def create_time() -> ::Google::Protobuf::Timestamp
Returns

#display_name

def display_name() -> ::String
Returns
  • (::String) — Output only. The title of the DeviceSession to be presented in the UI.

#expire_time

def expire_time() -> ::Google::Protobuf::Timestamp
Returns
  • (::Google::Protobuf::Timestamp) — Optional. If the device is still in use at this time, any connections will be ended and the SessionState will transition from ACTIVE to FINISHED.

    Note: The following fields are mutually exclusive: expire_time, ttl. If a field in that set is populated, all other fields in the set will automatically be cleared.

#expire_time=

def expire_time=(value) -> ::Google::Protobuf::Timestamp
Parameter
  • value (::Google::Protobuf::Timestamp) — Optional. If the device is still in use at this time, any connections will be ended and the SessionState will transition from ACTIVE to FINISHED.

    Note: The following fields are mutually exclusive: expire_time, ttl. If a field in that set is populated, all other fields in the set will automatically be cleared.

Returns
  • (::Google::Protobuf::Timestamp) — Optional. If the device is still in use at this time, any connections will be ended and the SessionState will transition from ACTIVE to FINISHED.

    Note: The following fields are mutually exclusive: expire_time, ttl. If a field in that set is populated, all other fields in the set will automatically be cleared.

#inactivity_timeout

def inactivity_timeout() -> ::Google::Protobuf::Duration
Returns
  • (::Google::Protobuf::Duration) — Output only. The interval of time that this device must be interacted with before it transitions from ACTIVE to TIMEOUT_INACTIVITY.

#name

def name() -> ::String
Returns
  • (::String) — Optional. Name of the DeviceSession, e.g. "projects/{project_id}/deviceSessions/{session_id}"

#name=

def name=(value) -> ::String
Parameter
  • value (::String) — Optional. Name of the DeviceSession, e.g. "projects/{project_id}/deviceSessions/{session_id}"
Returns
  • (::String) — Optional. Name of the DeviceSession, e.g. "projects/{project_id}/deviceSessions/{session_id}"

#state

def state() -> ::Google::Cloud::DeviceStreaming::V1::DeviceSession::SessionState
Returns

#state_histories

def state_histories() -> ::Array<::Google::Cloud::DeviceStreaming::V1::DeviceSession::SessionStateEvent>
Returns

#ttl

def ttl() -> ::Google::Protobuf::Duration
Returns
  • (::Google::Protobuf::Duration) — Optional. The amount of time that a device will be initially allocated for. This can eventually be extended with the UpdateDeviceSession RPC. Default: 15 minutes.

    Note: The following fields are mutually exclusive: ttl, expire_time. If a field in that set is populated, all other fields in the set will automatically be cleared.

#ttl=

def ttl=(value) -> ::Google::Protobuf::Duration
Parameter
  • value (::Google::Protobuf::Duration) — Optional. The amount of time that a device will be initially allocated for. This can eventually be extended with the UpdateDeviceSession RPC. Default: 15 minutes.

    Note: The following fields are mutually exclusive: ttl, expire_time. If a field in that set is populated, all other fields in the set will automatically be cleared.

Returns
  • (::Google::Protobuf::Duration) — Optional. The amount of time that a device will be initially allocated for. This can eventually be extended with the UpdateDeviceSession RPC. Default: 15 minutes.

    Note: The following fields are mutually exclusive: ttl, expire_time. If a field in that set is populated, all other fields in the set will automatically be cleared.