Google Cloud Dataproc v1 API - Class SessionController.SessionControllerClient (5.12.0)

public class SessionController.SessionControllerClient : ClientBase<SessionController.SessionControllerClient>

Reference documentation and code samples for the Google Cloud Dataproc v1 API class SessionController.SessionControllerClient.

Client for SessionController

Inheritance

object > ClientBase > ClientBaseSessionControllerSessionControllerClient > SessionController.SessionControllerClient

Namespace

Google.Cloud.Dataproc.V1

Assembly

Google.Cloud.Dataproc.V1.dll

Constructors

SessionControllerClient()

protected SessionControllerClient()

Protected parameterless constructor to allow creation of test doubles.

SessionControllerClient(CallInvoker)

public SessionControllerClient(CallInvoker callInvoker)

Creates a new client for SessionController that uses a custom CallInvoker.

Parameter
Name Description
callInvoker CallInvoker

The callInvoker to use to make remote calls.

SessionControllerClient(ChannelBase)

public SessionControllerClient(ChannelBase channel)

Creates a new client for SessionController

Parameter
Name Description
channel ChannelBase

The channel to use to make remote calls.

SessionControllerClient(ClientBaseConfiguration)

protected SessionControllerClient(ClientBase.ClientBaseConfiguration configuration)

Protected constructor to allow creation of configured clients.

Parameter
Name Description
configuration ClientBaseClientBaseConfiguration

The client configuration.

Methods

CreateIAMPolicyClient()

public virtual IAMPolicy.IAMPolicyClient CreateIAMPolicyClient()

Creates a new instance of IAMPolicy.IAMPolicyClient using the same call invoker as this client.

Returns
Type Description
IAMPolicyIAMPolicyClient

A new IAMPolicy.IAMPolicyClient for the same target as this client.

CreateOperationsClient()

public virtual Operations.OperationsClient CreateOperationsClient()

Creates a new instance of Operations.OperationsClient using the same call invoker as this client.

Returns
Type Description
OperationsOperationsClient

A new Operations client for the same target as this client.

CreateSession(CreateSessionRequest, CallOptions)

public virtual Operation CreateSession(CreateSessionRequest request, CallOptions options)

Create an interactive session asynchronously.

Parameters
Name Description
request CreateSessionRequest

The request to send to the server.

options CallOptions

The options for the call.

Returns
Type Description
Operation

The response received from the server.

CreateSession(CreateSessionRequest, Metadata, DateTime?, CancellationToken)

public virtual Operation CreateSession(CreateSessionRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Create an interactive session asynchronously.

Parameters
Name Description
request CreateSessionRequest

The request to send to the server.

headers Metadata

The initial metadata to send with the call. This parameter is optional.

deadline System.DateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationToken CancellationToken

An optional token for canceling the call.

Returns
Type Description
Operation

The response received from the server.

CreateSessionAsync(CreateSessionRequest, CallOptions)

public virtual AsyncUnaryCall<Operation> CreateSessionAsync(CreateSessionRequest request, CallOptions options)

Create an interactive session asynchronously.

Parameters
Name Description
request CreateSessionRequest

The request to send to the server.

options CallOptions

The options for the call.

Returns
Type Description
AsyncUnaryCallOperation

The call object.

CreateSessionAsync(CreateSessionRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<Operation> CreateSessionAsync(CreateSessionRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Create an interactive session asynchronously.

Parameters
Name Description
request CreateSessionRequest

The request to send to the server.

headers Metadata

The initial metadata to send with the call. This parameter is optional.

deadline System.DateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationToken CancellationToken

An optional token for canceling the call.

Returns
Type Description
AsyncUnaryCallOperation

The call object.

DeleteSession(DeleteSessionRequest, CallOptions)

public virtual Operation DeleteSession(DeleteSessionRequest request, CallOptions options)

Deletes the interactive session resource. If the session is not in terminal state, it is terminated, and then deleted.

Parameters
Name Description
request DeleteSessionRequest

The request to send to the server.

options CallOptions

The options for the call.

Returns
Type Description
Operation

The response received from the server.

DeleteSession(DeleteSessionRequest, Metadata, DateTime?, CancellationToken)

public virtual Operation DeleteSession(DeleteSessionRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Deletes the interactive session resource. If the session is not in terminal state, it is terminated, and then deleted.

Parameters
Name Description
request DeleteSessionRequest

The request to send to the server.

headers Metadata

The initial metadata to send with the call. This parameter is optional.

deadline System.DateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationToken CancellationToken

An optional token for canceling the call.

Returns
Type Description
Operation

The response received from the server.

DeleteSessionAsync(DeleteSessionRequest, CallOptions)

public virtual AsyncUnaryCall<Operation> DeleteSessionAsync(DeleteSessionRequest request, CallOptions options)

Deletes the interactive session resource. If the session is not in terminal state, it is terminated, and then deleted.

Parameters
Name Description
request DeleteSessionRequest

The request to send to the server.

options CallOptions

The options for the call.

Returns
Type Description
AsyncUnaryCallOperation

The call object.

DeleteSessionAsync(DeleteSessionRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<Operation> DeleteSessionAsync(DeleteSessionRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Deletes the interactive session resource. If the session is not in terminal state, it is terminated, and then deleted.

Parameters
Name Description
request DeleteSessionRequest

The request to send to the server.

headers Metadata

The initial metadata to send with the call. This parameter is optional.

deadline System.DateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationToken CancellationToken

An optional token for canceling the call.

Returns
Type Description
AsyncUnaryCallOperation

The call object.

GetSession(GetSessionRequest, CallOptions)

public virtual Session GetSession(GetSessionRequest request, CallOptions options)

Gets the resource representation for an interactive session.

Parameters
Name Description
request GetSessionRequest

The request to send to the server.

options CallOptions

The options for the call.

Returns
Type Description
Session

The response received from the server.

GetSession(GetSessionRequest, Metadata, DateTime?, CancellationToken)

public virtual Session GetSession(GetSessionRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Gets the resource representation for an interactive session.

Parameters
Name Description
request GetSessionRequest

The request to send to the server.

headers Metadata

The initial metadata to send with the call. This parameter is optional.

deadline System.DateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationToken CancellationToken

An optional token for canceling the call.

Returns
Type Description
Session

The response received from the server.

GetSessionAsync(GetSessionRequest, CallOptions)

public virtual AsyncUnaryCall<Session> GetSessionAsync(GetSessionRequest request, CallOptions options)

Gets the resource representation for an interactive session.

Parameters
Name Description
request GetSessionRequest

The request to send to the server.

options CallOptions

The options for the call.

Returns
Type Description
AsyncUnaryCallSession

The call object.

GetSessionAsync(GetSessionRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<Session> GetSessionAsync(GetSessionRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Gets the resource representation for an interactive session.

Parameters
Name Description
request GetSessionRequest

The request to send to the server.

headers Metadata

The initial metadata to send with the call. This parameter is optional.

deadline System.DateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationToken CancellationToken

An optional token for canceling the call.

Returns
Type Description
AsyncUnaryCallSession

The call object.

ListSessions(ListSessionsRequest, CallOptions)

public virtual ListSessionsResponse ListSessions(ListSessionsRequest request, CallOptions options)

Lists interactive sessions.

Parameters
Name Description
request ListSessionsRequest

The request to send to the server.

options CallOptions

The options for the call.

Returns
Type Description
ListSessionsResponse

The response received from the server.

ListSessions(ListSessionsRequest, Metadata, DateTime?, CancellationToken)

public virtual ListSessionsResponse ListSessions(ListSessionsRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Lists interactive sessions.

Parameters
Name Description
request ListSessionsRequest

The request to send to the server.

headers Metadata

The initial metadata to send with the call. This parameter is optional.

deadline System.DateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationToken CancellationToken

An optional token for canceling the call.

Returns
Type Description
ListSessionsResponse

The response received from the server.

ListSessionsAsync(ListSessionsRequest, CallOptions)

public virtual AsyncUnaryCall<ListSessionsResponse> ListSessionsAsync(ListSessionsRequest request, CallOptions options)

Lists interactive sessions.

Parameters
Name Description
request ListSessionsRequest

The request to send to the server.

options CallOptions

The options for the call.

Returns
Type Description
AsyncUnaryCallListSessionsResponse

The call object.

ListSessionsAsync(ListSessionsRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<ListSessionsResponse> ListSessionsAsync(ListSessionsRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Lists interactive sessions.

Parameters
Name Description
request ListSessionsRequest

The request to send to the server.

headers Metadata

The initial metadata to send with the call. This parameter is optional.

deadline System.DateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationToken CancellationToken

An optional token for canceling the call.

Returns
Type Description
AsyncUnaryCallListSessionsResponse

The call object.

NewInstance(ClientBaseConfiguration)

protected override SessionController.SessionControllerClient NewInstance(ClientBase.ClientBaseConfiguration configuration)

Creates a new instance of client from given ClientBaseConfiguration.

Parameter
Name Description
configuration ClientBaseClientBaseConfiguration
Returns
Type Description
SessionControllerSessionControllerClient
Overrides
Grpc.Core.ClientBase<Google.Cloud.Dataproc.V1.SessionController.SessionControllerClient>.NewInstance(Grpc.Core.ClientBase.ClientBaseConfiguration)

TerminateSession(TerminateSessionRequest, CallOptions)

public virtual Operation TerminateSession(TerminateSessionRequest request, CallOptions options)

Terminates the interactive session.

Parameters
Name Description
request TerminateSessionRequest

The request to send to the server.

options CallOptions

The options for the call.

Returns
Type Description
Operation

The response received from the server.

TerminateSession(TerminateSessionRequest, Metadata, DateTime?, CancellationToken)

public virtual Operation TerminateSession(TerminateSessionRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Terminates the interactive session.

Parameters
Name Description
request TerminateSessionRequest

The request to send to the server.

headers Metadata

The initial metadata to send with the call. This parameter is optional.

deadline System.DateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationToken CancellationToken

An optional token for canceling the call.

Returns
Type Description
Operation

The response received from the server.

TerminateSessionAsync(TerminateSessionRequest, CallOptions)

public virtual AsyncUnaryCall<Operation> TerminateSessionAsync(TerminateSessionRequest request, CallOptions options)

Terminates the interactive session.

Parameters
Name Description
request TerminateSessionRequest

The request to send to the server.

options CallOptions

The options for the call.

Returns
Type Description
AsyncUnaryCallOperation

The call object.

TerminateSessionAsync(TerminateSessionRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<Operation> TerminateSessionAsync(TerminateSessionRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Terminates the interactive session.

Parameters
Name Description
request TerminateSessionRequest

The request to send to the server.

headers Metadata

The initial metadata to send with the call. This parameter is optional.

deadline System.DateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationToken CancellationToken

An optional token for canceling the call.

Returns
Type Description
AsyncUnaryCallOperation

The call object.