Discovery Engine v1 API - Class SessionService.SessionServiceClient (1.10.0)

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

Reference documentation and code samples for the Discovery Engine v1 API class SessionService.SessionServiceClient.

Client for SessionService

Inheritance

object > ClientBase > ClientBase SessionService SessionServiceClient > SessionService.SessionServiceClient

Inherited Members

ClientBase<SessionService.SessionServiceClient>.WithHost(string)

ClientBase.CallInvoker

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ToString()

Namespace

Google.Cloud.DiscoveryEngine.V1

Assembly

Google.Cloud.DiscoveryEngine.V1.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

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.

CreateSession(CreateSessionRequest, CallOptions)

public virtual Session CreateSession(CreateSessionRequest request, CallOptions options)

Creates a Session.

If the [Session][google.cloud.discoveryengine.v1.Session] to create already exists, an ALREADY_EXISTS error is returned.

Parameters
Name	Description
`request`	`CreateSessionRequest` The request to send to the server.
`options`	`CallOptions` The options for the call.

Returns
Type	Description
`Session`	The response received from the server.

CreateSession(CreateSessionRequest, Metadata, DateTime?, CancellationToken)

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

Creates a Session.

If the [Session][google.cloud.discoveryengine.v1.Session] to create already exists, an ALREADY_EXISTS error is returned.

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
`Session`	The response received from the server.

CreateSessionAsync(CreateSessionRequest, CallOptions)

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

Creates a Session.

If the [Session][google.cloud.discoveryengine.v1.Session] to create already exists, an ALREADY_EXISTS error is returned.

Parameters
Name	Description
`request`	`CreateSessionRequest` The request to send to the server.
`options`	`CallOptions` The options for the call.

Returns
Type	Description
`AsyncUnaryCallSession`	The call object.

CreateSessionAsync(CreateSessionRequest, Metadata, DateTime?, CancellationToken)

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

Creates a Session.

If the [Session][google.cloud.discoveryengine.v1.Session] to create already exists, an ALREADY_EXISTS error is returned.

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
`AsyncUnaryCallSession`	The call object.

DeleteSession(DeleteSessionRequest, CallOptions)

public virtual Empty DeleteSession(DeleteSessionRequest request, CallOptions options)

Deletes a Session.

If the [Session][google.cloud.discoveryengine.v1.Session] to delete does not exist, a NOT_FOUND error is returned.

Parameters
Name	Description
`request`	`DeleteSessionRequest` The request to send to the server.
`options`	`CallOptions` The options for the call.

Returns
Type	Description
`Empty`	The response received from the server.

DeleteSession(DeleteSessionRequest, Metadata, DateTime?, CancellationToken)

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

Deletes a Session.

If the [Session][google.cloud.discoveryengine.v1.Session] to delete does not exist, a NOT_FOUND error is returned.

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
`Empty`	The response received from the server.

DeleteSessionAsync(DeleteSessionRequest, CallOptions)

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

Deletes a Session.

If the [Session][google.cloud.discoveryengine.v1.Session] to delete does not exist, a NOT_FOUND error is returned.

Parameters
Name	Description
`request`	`DeleteSessionRequest` The request to send to the server.
`options`	`CallOptions` The options for the call.

Returns
Type	Description
`AsyncUnaryCallEmpty`	The call object.

DeleteSessionAsync(DeleteSessionRequest, Metadata, DateTime?, CancellationToken)

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

Deletes a Session.

If the [Session][google.cloud.discoveryengine.v1.Session] to delete does not exist, a NOT_FOUND error is returned.

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
`AsyncUnaryCallEmpty`	The call object.

GetSession(GetSessionRequest, CallOptions)

public virtual Session GetSession(GetSessionRequest request, CallOptions options)

Gets a 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 a 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 a 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 a 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 all Sessions by their parent [DataStore][google.cloud.discoveryengine.v1.DataStore].

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 all Sessions by their parent [DataStore][google.cloud.discoveryengine.v1.DataStore].

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 all Sessions by their parent [DataStore][google.cloud.discoveryengine.v1.DataStore].

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 all Sessions by their parent [DataStore][google.cloud.discoveryengine.v1.DataStore].

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.DiscoveryEngine.V1.SessionService.SessionServiceClient>.NewInstance(Grpc.Core.ClientBase.ClientBaseConfiguration)

UpdateSession(UpdateSessionRequest, CallOptions)

public virtual Session UpdateSession(UpdateSessionRequest request, CallOptions options)

Updates a Session.

[Session][google.cloud.discoveryengine.v1.Session] action type cannot be changed. If the [Session][google.cloud.discoveryengine.v1.Session] to update does not exist, a NOT_FOUND error is returned.

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 a Session.

[Session][google.cloud.discoveryengine.v1.Session] action type cannot be changed. If the [Session][google.cloud.discoveryengine.v1.Session] to update does not exist, a NOT_FOUND error is returned.

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 a Session.

[Session][google.cloud.discoveryengine.v1.Session] action type cannot be changed. If the [Session][google.cloud.discoveryengine.v1.Session] to update does not exist, a NOT_FOUND error is returned.

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 a Session.

[Session][google.cloud.discoveryengine.v1.Session] action type cannot be changed. If the [Session][google.cloud.discoveryengine.v1.Session] to update does not exist, a NOT_FOUND error is returned.

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.