Show / Hide Table of Contents

Class ProjectsResource.LocationsResource.SessionsResource

The "sessions" collection of methods.

Inheritance
object
ProjectsResource.LocationsResource.SessionsResource
Inherited Members
object.Equals(object)
object.Equals(object, object)
object.GetHashCode()
object.GetType()
object.MemberwiseClone()
object.ReferenceEquals(object, object)
object.ToString()
Namespace: Google.Apis.DeviceRun.v1alpha
Assembly: Google.Apis.DeviceRun.v1alpha.dll
Syntax
public class ProjectsResource.LocationsResource.SessionsResource

Constructors

SessionsResource(IClientService)

Constructs a new resource.

Declaration
public SessionsResource(IClientService service)
Parameters
Type Name Description
IClientService service

Methods

BatchGet(string)

Retrieves multiple automation sessions in a single batch request. Sessions are returned in the same order as the names in the request. If any of the requested sessions does not exist, the whole request fails with NOT_FOUND and no sessions are returned. When calling this method over HTTP/REST with a large number of names, the request URL may exceed the maximum URL length (about 16 KB) and be rejected. In that case, send a POST request to the same URL with the X-HTTP-Method-Override: GET header and pass the request parameters in a JSON (application/json) or form-encoded (application/x-www-form-urlencoded) body. See https://cloud.google.com/apis/docs/http#long_request_urls.

Declaration
public virtual ProjectsResource.LocationsResource.SessionsResource.BatchGetRequest BatchGet(string parent)
Parameters
Type Name Description
string parent

Required. The parent resource shared by all sessions being retrieved. Format: projects/{project}/locations/{location}. The parent field in the BatchGetSessionsRequest message must match the parent of all Session resource names in names.

Returns
Type Description
ProjectsResource.LocationsResource.SessionsResource.BatchGetRequest

Cancel(CancelSessionRequest, string)

Cancels an in-progress automation session. This RPC returns immediately and cancellation proceeds asynchronously. If the session is already finished, this RPC will have no effect.

Declaration
public virtual ProjectsResource.LocationsResource.SessionsResource.CancelRequest Cancel(CancelSessionRequest body, string name)
Parameters
Type Name Description
CancelSessionRequest body

The body of the request.

string name

Required. The name of the session. Format: "projects/{project}/locations/{location}/sessions/{session}"

Returns
Type Description
ProjectsResource.LocationsResource.SessionsResource.CancelRequest

Create(Session, string)

Starts an automation session with the specified configuration. This method returns a long-running Operation, awaiting the completion of all jobs in the session.

Declaration
public virtual ProjectsResource.LocationsResource.SessionsResource.CreateRequest Create(Session body, string parent)
Parameters
Type Name Description
Session body

The body of the request.

string parent

Required. The parent resource where this session will be created. Format: projects/{project}/locations/{location}.

Returns
Type Description
ProjectsResource.LocationsResource.SessionsResource.CreateRequest

Delete(string)

Deletes a session. This RPC returns immediately and deletion proceeds asynchronously. It will cancel the session at first if it is still running.

Declaration
public virtual ProjectsResource.LocationsResource.SessionsResource.DeleteRequest Delete(string name)
Parameters
Type Name Description
string name

Required. The name of the session. Format: projects/{project}/locations/{location}/sessions/{session}.

Returns
Type Description
ProjectsResource.LocationsResource.SessionsResource.DeleteRequest

Get(string)

Returns information about a previously created automation session.

Declaration
public virtual ProjectsResource.LocationsResource.SessionsResource.GetRequest Get(string name)
Parameters
Type Name Description
string name

Required. The name of the session. Format: projects/{project}/locations/{location}/sessions/{session}.

Returns
Type Description
ProjectsResource.LocationsResource.SessionsResource.GetRequest

List(string)

Lists previously created automation sessions. Sessions may still be in-progress, or may have finished successfully, or unsuccessfully.

Declaration
public virtual ProjectsResource.LocationsResource.SessionsResource.ListRequest List(string parent)
Parameters
Type Name Description
string parent

Required. Parent value for ListSessionsRequest The parent of the collection of sessions. Format: projects/{project}/locations/{location}.

Returns
Type Description
ProjectsResource.LocationsResource.SessionsResource.ListRequest
In this article
Back to top Generated by DocFX