Discovery Engine v1 API - Class SessionServiceClientImpl (1.10.0)

public sealed class SessionServiceClientImpl : SessionServiceClient

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

SessionService client wrapper implementation, for convenient use.

Inheritance

object > SessionServiceClient > SessionServiceClientImpl

Inherited Members

SessionServiceClient.DefaultEndpoint

SessionServiceClient.DefaultScopes

SessionServiceClient.ServiceMetadata

SessionServiceClient.CreateAsync(CancellationToken)

SessionServiceClient.Create()

SessionServiceClient.ShutdownDefaultChannelsAsync()

SessionServiceClient.CreateSessionAsync(CreateSessionRequest, CancellationToken)

SessionServiceClient.CreateSession(string, Session, CallSettings)

SessionServiceClient.CreateSessionAsync(string, Session, CallSettings)

SessionServiceClient.CreateSessionAsync(string, Session, CancellationToken)

SessionServiceClient.CreateSession(DataStoreName, Session, CallSettings)

SessionServiceClient.CreateSessionAsync(DataStoreName, Session, CallSettings)

SessionServiceClient.CreateSessionAsync(DataStoreName, Session, CancellationToken)

SessionServiceClient.DeleteSessionAsync(DeleteSessionRequest, CancellationToken)

SessionServiceClient.DeleteSession(string, CallSettings)

SessionServiceClient.DeleteSessionAsync(string, CallSettings)

SessionServiceClient.DeleteSessionAsync(string, CancellationToken)

SessionServiceClient.DeleteSession(SessionName, CallSettings)

SessionServiceClient.DeleteSessionAsync(SessionName, CallSettings)

SessionServiceClient.DeleteSessionAsync(SessionName, CancellationToken)

SessionServiceClient.UpdateSessionAsync(UpdateSessionRequest, CancellationToken)

SessionServiceClient.UpdateSession(Session, FieldMask, CallSettings)

SessionServiceClient.UpdateSessionAsync(Session, FieldMask, CallSettings)

SessionServiceClient.UpdateSessionAsync(Session, FieldMask, CancellationToken)

SessionServiceClient.GetSessionAsync(GetSessionRequest, CancellationToken)

SessionServiceClient.GetSession(string, CallSettings)

SessionServiceClient.GetSessionAsync(string, CallSettings)

SessionServiceClient.GetSessionAsync(string, CancellationToken)

SessionServiceClient.GetSession(SessionName, CallSettings)

SessionServiceClient.GetSessionAsync(SessionName, CallSettings)

SessionServiceClient.GetSessionAsync(SessionName, CancellationToken)

SessionServiceClient.ListSessions(string, string, int?, CallSettings)

SessionServiceClient.ListSessionsAsync(string, string, int?, CallSettings)

SessionServiceClient.ListSessions(DataStoreName, string, int?, CallSettings)

SessionServiceClient.ListSessionsAsync(DataStoreName, string, int?, CallSettings)

object.GetHashCode()

object.GetType()

object.ToString()

Namespace

Google.Cloud.DiscoveryEngine.V1

Assembly

Google.Cloud.DiscoveryEngine.V1.dll

Remarks

Service for managing Sessions and Session-related resources.

Constructors

SessionServiceClientImpl(SessionServiceClient, SessionServiceSettings, ILogger)

public SessionServiceClientImpl(SessionService.SessionServiceClient grpcClient, SessionServiceSettings settings, ILogger logger)

Constructs a client wrapper for the SessionService service, with the specified gRPC client and settings.

Parameters
Name	Description
`grpcClient`	`SessionServiceSessionServiceClient` The underlying gRPC client.
`settings`	`SessionServiceSettings` The base SessionServiceSettings used within this client.
`logger`	`ILogger` Optional ILogger to use within this client.

Properties

GrpcClient

public override SessionService.SessionServiceClient GrpcClient { get; }

The underlying gRPC SessionService client

Property Value
Type	Description
`SessionServiceSessionServiceClient`

Overrides

SessionServiceClient.GrpcClient

LocationsClient

public override LocationsClient LocationsClient { get; }

The LocationsClient associated with this client.

Property Value
Type	Description
`LocationsClient`

Overrides

SessionServiceClient.LocationsClient

Methods

CreateSession(CreateSessionRequest, CallSettings)

public override Session CreateSession(CreateSessionRequest request, CallSettings callSettings = null)

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 object containing all of the parameters for the API call.
`callSettings`	`CallSettings` If not null, applies overrides to this RPC call.

Returns
Type	Description
`Session`	The RPC response.

Overrides

SessionServiceClient.CreateSession(CreateSessionRequest, CallSettings)

CreateSessionAsync(CreateSessionRequest, CallSettings)

public override Task<Session> CreateSessionAsync(CreateSessionRequest request, CallSettings callSettings = null)

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 object containing all of the parameters for the API call.
`callSettings`	`CallSettings` If not null, applies overrides to this RPC call.

Returns
Type	Description
`TaskSession`	A Task containing the RPC response.

Overrides

SessionServiceClient.CreateSessionAsync(CreateSessionRequest, CallSettings)

DeleteSession(DeleteSessionRequest, CallSettings)

public override void DeleteSession(DeleteSessionRequest request, CallSettings callSettings = null)

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 object containing all of the parameters for the API call.
`callSettings`	`CallSettings` If not null, applies overrides to this RPC call.

Overrides

SessionServiceClient.DeleteSession(DeleteSessionRequest, CallSettings)

DeleteSessionAsync(DeleteSessionRequest, CallSettings)

public override Task DeleteSessionAsync(DeleteSessionRequest request, CallSettings callSettings = null)

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 object containing all of the parameters for the API call.
`callSettings`	`CallSettings` If not null, applies overrides to this RPC call.

Returns
Type	Description
`Task`	A Task containing the RPC response.

Overrides

SessionServiceClient.DeleteSessionAsync(DeleteSessionRequest, CallSettings)

GetSession(GetSessionRequest, CallSettings)

public override Session GetSession(GetSessionRequest request, CallSettings callSettings = null)

Gets a Session.

Parameters
Name	Description
`request`	`GetSessionRequest` The request object containing all of the parameters for the API call.
`callSettings`	`CallSettings` If not null, applies overrides to this RPC call.

Returns
Type	Description
`Session`	The RPC response.

Overrides

SessionServiceClient.GetSession(GetSessionRequest, CallSettings)

GetSessionAsync(GetSessionRequest, CallSettings)

public override Task<Session> GetSessionAsync(GetSessionRequest request, CallSettings callSettings = null)

Gets a Session.

Parameters
Name	Description
`request`	`GetSessionRequest` The request object containing all of the parameters for the API call.
`callSettings`	`CallSettings` If not null, applies overrides to this RPC call.

Returns
Type	Description
`TaskSession`	A Task containing the RPC response.

Overrides

SessionServiceClient.GetSessionAsync(GetSessionRequest, CallSettings)

ListSessions(ListSessionsRequest, CallSettings)

public override PagedEnumerable<ListSessionsResponse, Session> ListSessions(ListSessionsRequest request, CallSettings callSettings = null)

Lists all Sessions by their parent [DataStore][google.cloud.discoveryengine.v1.DataStore].

Parameters
Name	Description
`request`	`ListSessionsRequest` The request object containing all of the parameters for the API call.
`callSettings`	`CallSettings` If not null, applies overrides to this RPC call.

Returns
Type	Description
`PagedEnumerableListSessionsResponseSession`	A pageable sequence of Session resources.

Overrides

SessionServiceClient.ListSessions(ListSessionsRequest, CallSettings)

ListSessionsAsync(ListSessionsRequest, CallSettings)

public override PagedAsyncEnumerable<ListSessionsResponse, Session> ListSessionsAsync(ListSessionsRequest request, CallSettings callSettings = null)

Lists all Sessions by their parent [DataStore][google.cloud.discoveryengine.v1.DataStore].

Parameters
Name	Description
`request`	`ListSessionsRequest` The request object containing all of the parameters for the API call.
`callSettings`	`CallSettings` If not null, applies overrides to this RPC call.

Returns
Type	Description
`PagedAsyncEnumerableListSessionsResponseSession`	A pageable asynchronous sequence of Session resources.

Overrides

SessionServiceClient.ListSessionsAsync(ListSessionsRequest, CallSettings)

UpdateSession(UpdateSessionRequest, CallSettings)

public override Session UpdateSession(UpdateSessionRequest request, CallSettings callSettings = null)

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 object containing all of the parameters for the API call.
`callSettings`	`CallSettings` If not null, applies overrides to this RPC call.

Returns
Type	Description
`Session`	The RPC response.

Overrides

SessionServiceClient.UpdateSession(UpdateSessionRequest, CallSettings)

UpdateSessionAsync(UpdateSessionRequest, CallSettings)

public override Task<Session> UpdateSessionAsync(UpdateSessionRequest request, CallSettings callSettings = null)

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 object containing all of the parameters for the API call.
`callSettings`	`CallSettings` If not null, applies overrides to this RPC call.

Returns
Type	Description
`TaskSession`	A Task containing the RPC response.

Overrides

SessionServiceClient.UpdateSessionAsync(UpdateSessionRequest, CallSettings)