Vertex AI v1beta1 API - Class SessionService.SessionServiceClient (1.0.0-beta24) 

public class SessionService.SessionServiceClient : ClientBase<SessionService.SessionServiceClient>

Reference documentation and code samples for the Vertex AI v1beta1 API class SessionService.SessionServiceClient.

Client for SessionService

Inheritance

object > ClientBase > ClientBaseSessionServiceSessionServiceClient > SessionService.SessionServiceClient

Namespace

Google.Cloud.AIPlatform.V1Beta1

Assembly

Google.Cloud.AIPlatform.V1Beta1.dll

Constructors

SessionServiceClient()

protected SessionServiceClient()

Protected parameterless constructor to allow creation of test doubles.

SessionServiceClient(CallInvoker)

public SessionServiceClient(CallInvoker callInvoker)

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

Parameter
Name Description
callInvoker CallInvoker

The callInvoker to use to make remote calls.

SessionServiceClient(ChannelBase)

public SessionServiceClient(ChannelBase channel)

Creates a new client for SessionService

Parameter
Name Description
channel ChannelBase

The channel to use to make remote calls.

SessionServiceClient(ClientBaseConfiguration)

protected SessionServiceClient(ClientBase.ClientBaseConfiguration configuration)

Protected constructor to allow creation of configured clients.

Parameter
Name Description
configuration ClientBaseClientBaseConfiguration

The client configuration.

Methods

AppendEvent(AppendEventRequest, CallOptions)

public virtual AppendEventResponse AppendEvent(AppendEventRequest request, CallOptions options)

Appends an event to a given session.

Parameters
Name Description
request AppendEventRequest

The request to send to the server.
options CallOptions

The options for the call.
Returns
Type Description
AppendEventResponse

The response received from the server.

AppendEvent(AppendEventRequest, Metadata, DateTime?, CancellationToken)

public virtual AppendEventResponse AppendEvent(AppendEventRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Appends an event to a given session.

Parameters
Name Description
request AppendEventRequest

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
AppendEventResponse

The response received from the server.

AppendEventAsync(AppendEventRequest, CallOptions)

public virtual AsyncUnaryCall<AppendEventResponse> AppendEventAsync(AppendEventRequest request, CallOptions options)

Appends an event to a given session.

Parameters
Name Description
request AppendEventRequest

The request to send to the server.
options CallOptions

The options for the call.
Returns
Type Description
AsyncUnaryCallAppendEventResponse

The call object.

AppendEventAsync(AppendEventRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<AppendEventResponse> AppendEventAsync(AppendEventRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Appends an event to a given session.

Parameters
Name Description
request AppendEventRequest

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
AsyncUnaryCallAppendEventResponse

The call object.

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.

CreateLocationsClient()

public virtual Locations.LocationsClient CreateLocationsClient()

Creates a new instance of Locations.LocationsClient using the same call invoker as this client.

Returns
Type Description
LocationsLocationsClient

A new Locations.LocationsClient 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)

Creates a new [Session][google.cloud.aiplatform.v1beta1.Session] in a given project and location.

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)

Creates a new [Session][google.cloud.aiplatform.v1beta1.Session] in a given project and location.

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)

Creates a new [Session][google.cloud.aiplatform.v1beta1.Session] in a given project and location.

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)

Creates a new [Session][google.cloud.aiplatform.v1beta1.Session] in a given project and location.

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 details of the specific [Session][google.cloud.aiplatform.v1beta1.Session].

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 details of the specific [Session][google.cloud.aiplatform.v1beta1.Session].

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 details of the specific [Session][google.cloud.aiplatform.v1beta1.Session].

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 details of the specific [Session][google.cloud.aiplatform.v1beta1.Session].

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 details of the specific [Session][google.cloud.aiplatform.v1beta1.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 details of the specific [Session][google.cloud.aiplatform.v1beta1.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 details of the specific [Session][google.cloud.aiplatform.v1beta1.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 details of the specific [Session][google.cloud.aiplatform.v1beta1.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.

ListEvents(ListEventsRequest, CallOptions)

public virtual ListEventsResponse ListEvents(ListEventsRequest request, CallOptions options)

Lists [Events][google.cloud.aiplatform.v1beta1.Event] in a given session.

Parameters
Name Description
request ListEventsRequest

The request to send to the server.
options CallOptions

The options for the call.
Returns
Type Description
ListEventsResponse

The response received from the server.

ListEvents(ListEventsRequest, Metadata, DateTime?, CancellationToken)

public virtual ListEventsResponse ListEvents(ListEventsRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Lists [Events][google.cloud.aiplatform.v1beta1.Event] in a given session.

Parameters
Name Description
request ListEventsRequest

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
ListEventsResponse

The response received from the server.

ListEventsAsync(ListEventsRequest, CallOptions)

public virtual AsyncUnaryCall<ListEventsResponse> ListEventsAsync(ListEventsRequest request, CallOptions options)

Lists [Events][google.cloud.aiplatform.v1beta1.Event] in a given session.

Parameters
Name Description
request ListEventsRequest

The request to send to the server.
options CallOptions

The options for the call.
Returns
Type Description
AsyncUnaryCallListEventsResponse

The call object.

ListEventsAsync(ListEventsRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<ListEventsResponse> ListEventsAsync(ListEventsRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Lists [Events][google.cloud.aiplatform.v1beta1.Event] in a given session.

Parameters
Name Description
request ListEventsRequest

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
AsyncUnaryCallListEventsResponse

The call object.

ListSessions(ListSessionsRequest, CallOptions)

public virtual ListSessionsResponse ListSessions(ListSessionsRequest request, CallOptions options)

Lists [Sessions][google.cloud.aiplatform.v1beta1.Session] in a given project and location.

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 [Sessions][google.cloud.aiplatform.v1beta1.Session] in a given project and location.

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 [Sessions][google.cloud.aiplatform.v1beta1.Session] in a given project and location.

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 [Sessions][google.cloud.aiplatform.v1beta1.Session] in a given project and location.

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 SessionService.SessionServiceClient NewInstance(ClientBase.ClientBaseConfiguration configuration)

Creates a new instance of client from given ClientBaseConfiguration.

Parameter
Name Description
configuration ClientBaseClientBaseConfiguration
Returns
Type Description
SessionServiceSessionServiceClient
Overrides
Grpc.Core.ClientBase<Google.Cloud.AIPlatform.V1Beta1.SessionService.SessionServiceClient>.NewInstance(Grpc.Core.ClientBase.ClientBaseConfiguration)

UpdateSession(UpdateSessionRequest, CallOptions)

public virtual Session UpdateSession(UpdateSessionRequest request, CallOptions options)

Updates the specific [Session][google.cloud.aiplatform.v1beta1.Session].

Parameters
Name Description
request UpdateSessionRequest

The request to send to the server.
options CallOptions

The options for the call.
Returns
Type Description
Session

The response received from the server.

UpdateSession(UpdateSessionRequest, Metadata, DateTime?, CancellationToken)

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

Updates the specific [Session][google.cloud.aiplatform.v1beta1.Session].

Parameters
Name Description
request UpdateSessionRequest

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.

UpdateSessionAsync(UpdateSessionRequest, CallOptions)

public virtual AsyncUnaryCall<Session> UpdateSessionAsync(UpdateSessionRequest request, CallOptions options)

Updates the specific [Session][google.cloud.aiplatform.v1beta1.Session].

Parameters
Name Description
request UpdateSessionRequest

The request to send to the server.
options CallOptions

The options for the call.
Returns
Type Description
AsyncUnaryCallSession

The call object.

UpdateSessionAsync(UpdateSessionRequest, Metadata, DateTime?, CancellationToken)

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

Updates the specific [Session][google.cloud.aiplatform.v1beta1.Session].

Parameters
Name Description
request UpdateSessionRequest

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.