Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Google Cloud Native
  3. API Docs
  4. testing
  5. testing/v1
  6. getDeviceSession

Google Cloud Native is in preview. Google Cloud Classic is fully supported.

Google Cloud Native v0.32.0 published on Wednesday, Nov 29, 2023 by Pulumi
pulumi/pulumi-google-native

google-native.testing/v1.getDeviceSession

Explore with Pulumi AI

Google Cloud Native is in preview. Google Cloud Classic is fully supported.

Google Cloud Native v0.32.0 published on Wednesday, Nov 29, 2023 by Pulumi
pulumi/pulumi-google-native

GET /v1/projects/{project_id}/deviceSessions/{device_session_id} Return a DeviceSession, which documents the allocation status and whether the device is allocated. Clients making requests from this API must poll GetDeviceSession.

Using getDeviceSession

Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

function getDeviceSession(args: GetDeviceSessionArgs, opts?: InvokeOptions): Promise<GetDeviceSessionResult>
function getDeviceSessionOutput(args: GetDeviceSessionOutputArgs, opts?: InvokeOptions): Output<GetDeviceSessionResult>
Copy
def get_device_session(device_session_id: Optional[str] = None,
                       project: Optional[str] = None,
                       opts: Optional[InvokeOptions] = None) -> GetDeviceSessionResult
def get_device_session_output(device_session_id: Optional[pulumi.Input[str]] = None,
                       project: Optional[pulumi.Input[str]] = None,
                       opts: Optional[InvokeOptions] = None) -> Output[GetDeviceSessionResult]
Copy
func LookupDeviceSession(ctx *Context, args *LookupDeviceSessionArgs, opts ...InvokeOption) (*LookupDeviceSessionResult, error)
func LookupDeviceSessionOutput(ctx *Context, args *LookupDeviceSessionOutputArgs, opts ...InvokeOption) LookupDeviceSessionResultOutput
Copy

> Note: This function is named LookupDeviceSession in the Go SDK.

public static class GetDeviceSession 
{
    public static Task<GetDeviceSessionResult> InvokeAsync(GetDeviceSessionArgs args, InvokeOptions? opts = null)
    public static Output<GetDeviceSessionResult> Invoke(GetDeviceSessionInvokeArgs args, InvokeOptions? opts = null)
}
Copy
public static CompletableFuture<GetDeviceSessionResult> getDeviceSession(GetDeviceSessionArgs args, InvokeOptions options)
public static Output<GetDeviceSessionResult> getDeviceSession(GetDeviceSessionArgs args, InvokeOptions options)
Copy
fn::invoke:
  function: google-native:testing/v1:getDeviceSession
  arguments:
    # arguments dictionary
Copy

The following arguments are supported:

DeviceSessionId This property is required. string
Project string
DeviceSessionId This property is required. string
Project string
deviceSessionId This property is required. String
project String
deviceSessionId This property is required. string
project string
device_session_id This property is required. str
project str
deviceSessionId This property is required. String
project String

getDeviceSession Result

The following output properties are available:

ActiveStartTime string
The timestamp that the session first became ACTIVE.
AndroidDevice Pulumi.GoogleNative.Testing.V1.Outputs.AndroidDeviceResponse
The requested device
CreateTime string
The time that the Session was created.
DisplayName string
The title of the DeviceSession to be presented in the UI.
ExpireTime string
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.
InactivityTimeout string
The interval of time that this device must be interacted with before it transitions from ACTIVE to TIMEOUT_INACTIVITY.
Name string
Optional. Name of the DeviceSession, e.g. "projects/{project_id}/deviceSessions/{session_id}"
State string
Current state of the DeviceSession.
StateHistories List<Pulumi.GoogleNative.Testing.V1.Outputs.SessionStateEventResponse>
The historical state transitions of the session_state message including the current session state.
Ttl string
Optional. The amount of time that a device will be initially allocated for. This can eventually be extended with the UpdateDeviceSession RPC. Default: 30 minutes.
ActiveStartTime string
The timestamp that the session first became ACTIVE.
AndroidDevice AndroidDeviceResponse
The requested device
CreateTime string
The time that the Session was created.
DisplayName string
The title of the DeviceSession to be presented in the UI.
ExpireTime string
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.
InactivityTimeout string
The interval of time that this device must be interacted with before it transitions from ACTIVE to TIMEOUT_INACTIVITY.
Name string
Optional. Name of the DeviceSession, e.g. "projects/{project_id}/deviceSessions/{session_id}"
State string
Current state of the DeviceSession.
StateHistories []SessionStateEventResponse
The historical state transitions of the session_state message including the current session state.
Ttl string
Optional. The amount of time that a device will be initially allocated for. This can eventually be extended with the UpdateDeviceSession RPC. Default: 30 minutes.
activeStartTime String
The timestamp that the session first became ACTIVE.
androidDevice AndroidDeviceResponse
The requested device
createTime String
The time that the Session was created.
displayName String
The title of the DeviceSession to be presented in the UI.
expireTime String
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.
inactivityTimeout String
The interval of time that this device must be interacted with before it transitions from ACTIVE to TIMEOUT_INACTIVITY.
name String
Optional. Name of the DeviceSession, e.g. "projects/{project_id}/deviceSessions/{session_id}"
state String
Current state of the DeviceSession.
stateHistories List<SessionStateEventResponse>
The historical state transitions of the session_state message including the current session state.
ttl String
Optional. The amount of time that a device will be initially allocated for. This can eventually be extended with the UpdateDeviceSession RPC. Default: 30 minutes.
activeStartTime string
The timestamp that the session first became ACTIVE.
androidDevice AndroidDeviceResponse
The requested device
createTime string
The time that the Session was created.
displayName string
The title of the DeviceSession to be presented in the UI.
expireTime string
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.
inactivityTimeout string
The interval of time that this device must be interacted with before it transitions from ACTIVE to TIMEOUT_INACTIVITY.
name string
Optional. Name of the DeviceSession, e.g. "projects/{project_id}/deviceSessions/{session_id}"
state string
Current state of the DeviceSession.
stateHistories SessionStateEventResponse[]
The historical state transitions of the session_state message including the current session state.
ttl string
Optional. The amount of time that a device will be initially allocated for. This can eventually be extended with the UpdateDeviceSession RPC. Default: 30 minutes.
active_start_time str
The timestamp that the session first became ACTIVE.
android_device AndroidDeviceResponse
The requested device
create_time str
The time that the Session was created.
display_name str
The title of the DeviceSession to be presented in the UI.
expire_time str
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.
inactivity_timeout str
The interval of time that this device must be interacted with before it transitions from ACTIVE to TIMEOUT_INACTIVITY.
name str
Optional. Name of the DeviceSession, e.g. "projects/{project_id}/deviceSessions/{session_id}"
state str
Current state of the DeviceSession.
state_histories Sequence[SessionStateEventResponse]
The historical state transitions of the session_state message including the current session state.
ttl str
Optional. The amount of time that a device will be initially allocated for. This can eventually be extended with the UpdateDeviceSession RPC. Default: 30 minutes.
activeStartTime String
The timestamp that the session first became ACTIVE.
androidDevice Property Map
The requested device
createTime String
The time that the Session was created.
displayName String
The title of the DeviceSession to be presented in the UI.
expireTime String
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.
inactivityTimeout String
The interval of time that this device must be interacted with before it transitions from ACTIVE to TIMEOUT_INACTIVITY.
name String
Optional. Name of the DeviceSession, e.g. "projects/{project_id}/deviceSessions/{session_id}"
state String
Current state of the DeviceSession.
stateHistories List<Property Map>
The historical state transitions of the session_state message including the current session state.
ttl String
Optional. The amount of time that a device will be initially allocated for. This can eventually be extended with the UpdateDeviceSession RPC. Default: 30 minutes.

Supporting Types

AndroidDeviceResponse

AndroidModelId This property is required. string
The id of the Android device to be used. Use the TestEnvironmentDiscoveryService to get supported options.
AndroidVersionId This property is required. string
The id of the Android OS version to be used. Use the TestEnvironmentDiscoveryService to get supported options.
Locale This property is required. string
The locale the test device used for testing. Use the TestEnvironmentDiscoveryService to get supported options.
Orientation This property is required. string
How the device is oriented during the test. Use the TestEnvironmentDiscoveryService to get supported options.
AndroidModelId This property is required. string
The id of the Android device to be used. Use the TestEnvironmentDiscoveryService to get supported options.
AndroidVersionId This property is required. string
The id of the Android OS version to be used. Use the TestEnvironmentDiscoveryService to get supported options.
Locale This property is required. string
The locale the test device used for testing. Use the TestEnvironmentDiscoveryService to get supported options.
Orientation This property is required. string
How the device is oriented during the test. Use the TestEnvironmentDiscoveryService to get supported options.
androidModelId This property is required. String
The id of the Android device to be used. Use the TestEnvironmentDiscoveryService to get supported options.
androidVersionId This property is required. String
The id of the Android OS version to be used. Use the TestEnvironmentDiscoveryService to get supported options.
locale This property is required. String
The locale the test device used for testing. Use the TestEnvironmentDiscoveryService to get supported options.
orientation This property is required. String
How the device is oriented during the test. Use the TestEnvironmentDiscoveryService to get supported options.
androidModelId This property is required. string
The id of the Android device to be used. Use the TestEnvironmentDiscoveryService to get supported options.
androidVersionId This property is required. string
The id of the Android OS version to be used. Use the TestEnvironmentDiscoveryService to get supported options.
locale This property is required. string
The locale the test device used for testing. Use the TestEnvironmentDiscoveryService to get supported options.
orientation This property is required. string
How the device is oriented during the test. Use the TestEnvironmentDiscoveryService to get supported options.
android_model_id This property is required. str
The id of the Android device to be used. Use the TestEnvironmentDiscoveryService to get supported options.
android_version_id This property is required. str
The id of the Android OS version to be used. Use the TestEnvironmentDiscoveryService to get supported options.
locale This property is required. str
The locale the test device used for testing. Use the TestEnvironmentDiscoveryService to get supported options.
orientation This property is required. str
How the device is oriented during the test. Use the TestEnvironmentDiscoveryService to get supported options.
androidModelId This property is required. String
The id of the Android device to be used. Use the TestEnvironmentDiscoveryService to get supported options.
androidVersionId This property is required. String
The id of the Android OS version to be used. Use the TestEnvironmentDiscoveryService to get supported options.
locale This property is required. String
The locale the test device used for testing. Use the TestEnvironmentDiscoveryService to get supported options.
orientation This property is required. String
How the device is oriented during the test. Use the TestEnvironmentDiscoveryService to get supported options.

SessionStateEventResponse

EventTime This property is required. string
The time that the session_state first encountered that state.
SessionState This property is required. string
The session_state tracked by this event
StateMessage This property is required. string
A human-readable message to explain the state.
EventTime This property is required. string
The time that the session_state first encountered that state.
SessionState This property is required. string
The session_state tracked by this event
StateMessage This property is required. string
A human-readable message to explain the state.
eventTime This property is required. String
The time that the session_state first encountered that state.
sessionState This property is required. String
The session_state tracked by this event
stateMessage This property is required. String
A human-readable message to explain the state.
eventTime This property is required. string
The time that the session_state first encountered that state.
sessionState This property is required. string
The session_state tracked by this event
stateMessage This property is required. string
A human-readable message to explain the state.
event_time This property is required. str
The time that the session_state first encountered that state.
session_state This property is required. str
The session_state tracked by this event
state_message This property is required. str
A human-readable message to explain the state.
eventTime This property is required. String
The time that the session_state first encountered that state.
sessionState This property is required. String
The session_state tracked by this event
stateMessage This property is required. String
A human-readable message to explain the state.

Package Details

Repository
Google Cloud Native pulumi/pulumi-google-native
License
Apache-2.0

Google Cloud Native is in preview. Google Cloud Classic is fully supported.

Google Cloud Native v0.32.0 published on Wednesday, Nov 29, 2023 by Pulumi
pulumi/pulumi-google-native