Class SessionEntityTypesClient (1.12.0)

public abstract class SessionEntityTypesClient

SessionEntityTypes client wrapper, for convenient use.

Inheritance

Object > SessionEntityTypesClient

Namespace

Google.Cloud.Dialogflow.Cx.V3

Assembly

Google.Cloud.Dialogflow.Cx.V3.dll

Remarks

Service for managing [SessionEntityTypes][google.cloud.dialogflow.cx.v3.SessionEntityType].

Properties

DefaultEndpoint

public static string DefaultEndpoint { get; }

The default endpoint for the SessionEntityTypes service, which is a host of "dialogflow.googleapis.com" and a port of 443.

Property Value
TypeDescription
String

DefaultScopes

public static IReadOnlyList<string> DefaultScopes { get; }

The default SessionEntityTypes scopes.

Property Value
TypeDescription
IReadOnlyList<String>
Remarks

GrpcClient

public virtual SessionEntityTypes.SessionEntityTypesClient GrpcClient { get; }

The underlying gRPC SessionEntityTypes client

Property Value
TypeDescription
SessionEntityTypes.SessionEntityTypesClient

Methods

Create()

public static SessionEntityTypesClient Create()

Synchronously creates a SessionEntityTypesClient using the default credentials, endpoint and settings. To specify custom credentials or other settings, use SessionEntityTypesClientBuilder .

Returns
TypeDescription
SessionEntityTypesClient

The created SessionEntityTypesClient.

CreateAsync(CancellationToken)

public static Task<SessionEntityTypesClient> CreateAsync(CancellationToken cancellationToken = default(CancellationToken))

Asynchronously creates a SessionEntityTypesClient using the default credentials, endpoint and settings. To specify custom credentials or other settings, use SessionEntityTypesClientBuilder .

Parameter
NameDescription
cancellationTokenCancellationToken

The CancellationToken to use while creating the client.

Returns
TypeDescription
Task<SessionEntityTypesClient>

The task representing the created SessionEntityTypesClient.

CreateSessionEntityType(CreateSessionEntityTypeRequest, CallSettings)

public virtual SessionEntityType CreateSessionEntityType(CreateSessionEntityTypeRequest request, CallSettings callSettings = null)

Creates a session entity type.

Parameters
NameDescription
requestCreateSessionEntityTypeRequest

The request object containing all of the parameters for the API call.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
SessionEntityType

The RPC response.

Example
// Create client
SessionEntityTypesClient sessionEntityTypesClient = SessionEntityTypesClient.Create();
// Initialize request argument(s)
CreateSessionEntityTypeRequest request = new CreateSessionEntityTypeRequest
{
    ParentAsSessionName = SessionName.FromProjectLocationAgentSession("[PROJECT]", "[LOCATION]", "[AGENT]", "[SESSION]"),
    SessionEntityType = new SessionEntityType(),
};
// Make the request
SessionEntityType response = sessionEntityTypesClient.CreateSessionEntityType(request);

CreateSessionEntityType(SessionName, SessionEntityType, CallSettings)

public virtual SessionEntityType CreateSessionEntityType(SessionName parent, SessionEntityType sessionEntityType, CallSettings callSettings = null)

Creates a session entity type.

Parameters
NameDescription
parentSessionName

Required. The session to create a session entity type for. Format: projects/&amp;lt;Project ID&amp;gt;/locations/&amp;lt;Location ID&amp;gt;/agents/&amp;lt;Agent ID&amp;gt;/sessions/&amp;lt;Session ID&amp;gt; or projects/&amp;lt;Project ID&amp;gt;/locations/&amp;lt;Location ID&amp;gt;/agents/&amp;lt;Agent ID&amp;gt;/environments/&amp;lt;Environment ID&amp;gt;/sessions/&amp;lt;Session ID&amp;gt;. If Environment ID is not specified, we assume default 'draft' environment.

sessionEntityTypeSessionEntityType

Required. The session entity type to create.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
SessionEntityType

The RPC response.

Example
// Create client
SessionEntityTypesClient sessionEntityTypesClient = SessionEntityTypesClient.Create();
// Initialize request argument(s)
SessionName parent = SessionName.FromProjectLocationAgentSession("[PROJECT]", "[LOCATION]", "[AGENT]", "[SESSION]");
SessionEntityType sessionEntityType = new SessionEntityType();
// Make the request
SessionEntityType response = sessionEntityTypesClient.CreateSessionEntityType(parent, sessionEntityType);

CreateSessionEntityType(String, SessionEntityType, CallSettings)

public virtual SessionEntityType CreateSessionEntityType(string parent, SessionEntityType sessionEntityType, CallSettings callSettings = null)

Creates a session entity type.

Parameters
NameDescription
parentString

Required. The session to create a session entity type for. Format: projects/&amp;lt;Project ID&amp;gt;/locations/&amp;lt;Location ID&amp;gt;/agents/&amp;lt;Agent ID&amp;gt;/sessions/&amp;lt;Session ID&amp;gt; or projects/&amp;lt;Project ID&amp;gt;/locations/&amp;lt;Location ID&amp;gt;/agents/&amp;lt;Agent ID&amp;gt;/environments/&amp;lt;Environment ID&amp;gt;/sessions/&amp;lt;Session ID&amp;gt;. If Environment ID is not specified, we assume default 'draft' environment.

sessionEntityTypeSessionEntityType

Required. The session entity type to create.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
SessionEntityType

The RPC response.

Example
// Create client
SessionEntityTypesClient sessionEntityTypesClient = SessionEntityTypesClient.Create();
// Initialize request argument(s)
string parent = "projects/[PROJECT]/locations/[LOCATION]/agents/[AGENT]/sessions/[SESSION]";
SessionEntityType sessionEntityType = new SessionEntityType();
// Make the request
SessionEntityType response = sessionEntityTypesClient.CreateSessionEntityType(parent, sessionEntityType);

CreateSessionEntityTypeAsync(CreateSessionEntityTypeRequest, CallSettings)

public virtual Task<SessionEntityType> CreateSessionEntityTypeAsync(CreateSessionEntityTypeRequest request, CallSettings callSettings = null)

Creates a session entity type.

Parameters
NameDescription
requestCreateSessionEntityTypeRequest

The request object containing all of the parameters for the API call.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
Task<SessionEntityType>

A Task containing the RPC response.

Example
// Create client
SessionEntityTypesClient sessionEntityTypesClient = await SessionEntityTypesClient.CreateAsync();
// Initialize request argument(s)
CreateSessionEntityTypeRequest request = new CreateSessionEntityTypeRequest
{
    ParentAsSessionName = SessionName.FromProjectLocationAgentSession("[PROJECT]", "[LOCATION]", "[AGENT]", "[SESSION]"),
    SessionEntityType = new SessionEntityType(),
};
// Make the request
SessionEntityType response = await sessionEntityTypesClient.CreateSessionEntityTypeAsync(request);

CreateSessionEntityTypeAsync(CreateSessionEntityTypeRequest, CancellationToken)

public virtual Task<SessionEntityType> CreateSessionEntityTypeAsync(CreateSessionEntityTypeRequest request, CancellationToken cancellationToken)

Creates a session entity type.

Parameters
NameDescription
requestCreateSessionEntityTypeRequest

The request object containing all of the parameters for the API call.

cancellationTokenCancellationToken

A CancellationToken to use for this RPC.

Returns
TypeDescription
Task<SessionEntityType>

A Task containing the RPC response.

Example
// Create client
SessionEntityTypesClient sessionEntityTypesClient = await SessionEntityTypesClient.CreateAsync();
// Initialize request argument(s)
CreateSessionEntityTypeRequest request = new CreateSessionEntityTypeRequest
{
    ParentAsSessionName = SessionName.FromProjectLocationAgentSession("[PROJECT]", "[LOCATION]", "[AGENT]", "[SESSION]"),
    SessionEntityType = new SessionEntityType(),
};
// Make the request
SessionEntityType response = await sessionEntityTypesClient.CreateSessionEntityTypeAsync(request);

CreateSessionEntityTypeAsync(SessionName, SessionEntityType, CallSettings)

public virtual Task<SessionEntityType> CreateSessionEntityTypeAsync(SessionName parent, SessionEntityType sessionEntityType, CallSettings callSettings = null)

Creates a session entity type.

Parameters
NameDescription
parentSessionName

Required. The session to create a session entity type for. Format: projects/&amp;lt;Project ID&amp;gt;/locations/&amp;lt;Location ID&amp;gt;/agents/&amp;lt;Agent ID&amp;gt;/sessions/&amp;lt;Session ID&amp;gt; or projects/&amp;lt;Project ID&amp;gt;/locations/&amp;lt;Location ID&amp;gt;/agents/&amp;lt;Agent ID&amp;gt;/environments/&amp;lt;Environment ID&amp;gt;/sessions/&amp;lt;Session ID&amp;gt;. If Environment ID is not specified, we assume default 'draft' environment.

sessionEntityTypeSessionEntityType

Required. The session entity type to create.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
Task<SessionEntityType>

A Task containing the RPC response.

Example
// Create client
SessionEntityTypesClient sessionEntityTypesClient = await SessionEntityTypesClient.CreateAsync();
// Initialize request argument(s)
SessionName parent = SessionName.FromProjectLocationAgentSession("[PROJECT]", "[LOCATION]", "[AGENT]", "[SESSION]");
SessionEntityType sessionEntityType = new SessionEntityType();
// Make the request
SessionEntityType response = await sessionEntityTypesClient.CreateSessionEntityTypeAsync(parent, sessionEntityType);

CreateSessionEntityTypeAsync(SessionName, SessionEntityType, CancellationToken)

public virtual Task<SessionEntityType> CreateSessionEntityTypeAsync(SessionName parent, SessionEntityType sessionEntityType, CancellationToken cancellationToken)

Creates a session entity type.

Parameters
NameDescription
parentSessionName

Required. The session to create a session entity type for. Format: projects/&amp;lt;Project ID&amp;gt;/locations/&amp;lt;Location ID&amp;gt;/agents/&amp;lt;Agent ID&amp;gt;/sessions/&amp;lt;Session ID&amp;gt; or projects/&amp;lt;Project ID&amp;gt;/locations/&amp;lt;Location ID&amp;gt;/agents/&amp;lt;Agent ID&amp;gt;/environments/&amp;lt;Environment ID&amp;gt;/sessions/&amp;lt;Session ID&amp;gt;. If Environment ID is not specified, we assume default 'draft' environment.

sessionEntityTypeSessionEntityType

Required. The session entity type to create.

cancellationTokenCancellationToken

A CancellationToken to use for this RPC.

Returns
TypeDescription
Task<SessionEntityType>

A Task containing the RPC response.

Example
// Create client
SessionEntityTypesClient sessionEntityTypesClient = await SessionEntityTypesClient.CreateAsync();
// Initialize request argument(s)
SessionName parent = SessionName.FromProjectLocationAgentSession("[PROJECT]", "[LOCATION]", "[AGENT]", "[SESSION]");
SessionEntityType sessionEntityType = new SessionEntityType();
// Make the request
SessionEntityType response = await sessionEntityTypesClient.CreateSessionEntityTypeAsync(parent, sessionEntityType);

CreateSessionEntityTypeAsync(String, SessionEntityType, CallSettings)

public virtual Task<SessionEntityType> CreateSessionEntityTypeAsync(string parent, SessionEntityType sessionEntityType, CallSettings callSettings = null)

Creates a session entity type.

Parameters
NameDescription
parentString

Required. The session to create a session entity type for. Format: projects/&amp;lt;Project ID&amp;gt;/locations/&amp;lt;Location ID&amp;gt;/agents/&amp;lt;Agent ID&amp;gt;/sessions/&amp;lt;Session ID&amp;gt; or projects/&amp;lt;Project ID&amp;gt;/locations/&amp;lt;Location ID&amp;gt;/agents/&amp;lt;Agent ID&amp;gt;/environments/&amp;lt;Environment ID&amp;gt;/sessions/&amp;lt;Session ID&amp;gt;. If Environment ID is not specified, we assume default 'draft' environment.

sessionEntityTypeSessionEntityType

Required. The session entity type to create.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
Task<SessionEntityType>

A Task containing the RPC response.

Example
// Create client
SessionEntityTypesClient sessionEntityTypesClient = await SessionEntityTypesClient.CreateAsync();
// Initialize request argument(s)
string parent = "projects/[PROJECT]/locations/[LOCATION]/agents/[AGENT]/sessions/[SESSION]";
SessionEntityType sessionEntityType = new SessionEntityType();
// Make the request
SessionEntityType response = await sessionEntityTypesClient.CreateSessionEntityTypeAsync(parent, sessionEntityType);

CreateSessionEntityTypeAsync(String, SessionEntityType, CancellationToken)

public virtual Task<SessionEntityType> CreateSessionEntityTypeAsync(string parent, SessionEntityType sessionEntityType, CancellationToken cancellationToken)

Creates a session entity type.

Parameters
NameDescription
parentString

Required. The session to create a session entity type for. Format: projects/&amp;lt;Project ID&amp;gt;/locations/&amp;lt;Location ID&amp;gt;/agents/&amp;lt;Agent ID&amp;gt;/sessions/&amp;lt;Session ID&amp;gt; or projects/&amp;lt;Project ID&amp;gt;/locations/&amp;lt;Location ID&amp;gt;/agents/&amp;lt;Agent ID&amp;gt;/environments/&amp;lt;Environment ID&amp;gt;/sessions/&amp;lt;Session ID&amp;gt;. If Environment ID is not specified, we assume default 'draft' environment.

sessionEntityTypeSessionEntityType

Required. The session entity type to create.

cancellationTokenCancellationToken

A CancellationToken to use for this RPC.

Returns
TypeDescription
Task<SessionEntityType>

A Task containing the RPC response.

Example
// Create client
SessionEntityTypesClient sessionEntityTypesClient = await SessionEntityTypesClient.CreateAsync();
// Initialize request argument(s)
string parent = "projects/[PROJECT]/locations/[LOCATION]/agents/[AGENT]/sessions/[SESSION]";
SessionEntityType sessionEntityType = new SessionEntityType();
// Make the request
SessionEntityType response = await sessionEntityTypesClient.CreateSessionEntityTypeAsync(parent, sessionEntityType);

DeleteSessionEntityType(DeleteSessionEntityTypeRequest, CallSettings)

public virtual void DeleteSessionEntityType(DeleteSessionEntityTypeRequest request, CallSettings callSettings = null)

Deletes the specified session entity type.

Parameters
NameDescription
requestDeleteSessionEntityTypeRequest

The request object containing all of the parameters for the API call.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Example
// Create client
SessionEntityTypesClient sessionEntityTypesClient = SessionEntityTypesClient.Create();
// Initialize request argument(s)
DeleteSessionEntityTypeRequest request = new DeleteSessionEntityTypeRequest
{
    SessionEntityTypeName = SessionEntityTypeName.FromProjectLocationAgentSessionEntityType("[PROJECT]", "[LOCATION]", "[AGENT]", "[SESSION]", "[ENTITY_TYPE]"),
};
// Make the request
sessionEntityTypesClient.DeleteSessionEntityType(request);

DeleteSessionEntityType(SessionEntityTypeName, CallSettings)

public virtual void DeleteSessionEntityType(SessionEntityTypeName name, CallSettings callSettings = null)

Deletes the specified session entity type.

Parameters
NameDescription
nameSessionEntityTypeName

Required. The name of the session entity type to delete. Format: projects/&amp;lt;Project ID&amp;gt;/locations/&amp;lt;Location ID&amp;gt;/agents/&amp;lt;Agent ID&amp;gt;/sessions/&amp;lt;Session ID&amp;gt;/entityTypes/&amp;lt;Entity Type ID&amp;gt; or projects/&amp;lt;Project ID&amp;gt;/locations/&amp;lt;Location ID&amp;gt;/agents/&amp;lt;Agent ID&amp;gt;/environments/&amp;lt;Environment ID&amp;gt;/sessions/&amp;lt;Session ID&amp;gt;/entityTypes/&amp;lt;Entity Type ID&amp;gt;. If Environment ID is not specified, we assume default 'draft' environment.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Example
// Create client
SessionEntityTypesClient sessionEntityTypesClient = SessionEntityTypesClient.Create();
// Initialize request argument(s)
SessionEntityTypeName name = SessionEntityTypeName.FromProjectLocationAgentSessionEntityType("[PROJECT]", "[LOCATION]", "[AGENT]", "[SESSION]", "[ENTITY_TYPE]");
// Make the request
sessionEntityTypesClient.DeleteSessionEntityType(name);

DeleteSessionEntityType(String, CallSettings)

public virtual void DeleteSessionEntityType(string name, CallSettings callSettings = null)

Deletes the specified session entity type.

Parameters
NameDescription
nameString

Required. The name of the session entity type to delete. Format: projects/&amp;lt;Project ID&amp;gt;/locations/&amp;lt;Location ID&amp;gt;/agents/&amp;lt;Agent ID&amp;gt;/sessions/&amp;lt;Session ID&amp;gt;/entityTypes/&amp;lt;Entity Type ID&amp;gt; or projects/&amp;lt;Project ID&amp;gt;/locations/&amp;lt;Location ID&amp;gt;/agents/&amp;lt;Agent ID&amp;gt;/environments/&amp;lt;Environment ID&amp;gt;/sessions/&amp;lt;Session ID&amp;gt;/entityTypes/&amp;lt;Entity Type ID&amp;gt;. If Environment ID is not specified, we assume default 'draft' environment.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Example
// Create client
SessionEntityTypesClient sessionEntityTypesClient = SessionEntityTypesClient.Create();
// Initialize request argument(s)
string name = "projects/[PROJECT]/locations/[LOCATION]/agents/[AGENT]/sessions/[SESSION]/entityTypes/[ENTITY_TYPE]";
// Make the request
sessionEntityTypesClient.DeleteSessionEntityType(name);

DeleteSessionEntityTypeAsync(DeleteSessionEntityTypeRequest, CallSettings)

public virtual Task DeleteSessionEntityTypeAsync(DeleteSessionEntityTypeRequest request, CallSettings callSettings = null)

Deletes the specified session entity type.

Parameters
NameDescription
requestDeleteSessionEntityTypeRequest

The request object containing all of the parameters for the API call.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
Task

A Task containing the RPC response.

Example
// Create client
SessionEntityTypesClient sessionEntityTypesClient = await SessionEntityTypesClient.CreateAsync();
// Initialize request argument(s)
DeleteSessionEntityTypeRequest request = new DeleteSessionEntityTypeRequest
{
    SessionEntityTypeName = SessionEntityTypeName.FromProjectLocationAgentSessionEntityType("[PROJECT]", "[LOCATION]", "[AGENT]", "[SESSION]", "[ENTITY_TYPE]"),
};
// Make the request
await sessionEntityTypesClient.DeleteSessionEntityTypeAsync(request);

DeleteSessionEntityTypeAsync(DeleteSessionEntityTypeRequest, CancellationToken)

public virtual Task DeleteSessionEntityTypeAsync(DeleteSessionEntityTypeRequest request, CancellationToken cancellationToken)

Deletes the specified session entity type.

Parameters
NameDescription
requestDeleteSessionEntityTypeRequest

The request object containing all of the parameters for the API call.

cancellationTokenCancellationToken

A CancellationToken to use for this RPC.

Returns
TypeDescription
Task

A Task containing the RPC response.

Example
// Create client
SessionEntityTypesClient sessionEntityTypesClient = await SessionEntityTypesClient.CreateAsync();
// Initialize request argument(s)
DeleteSessionEntityTypeRequest request = new DeleteSessionEntityTypeRequest
{
    SessionEntityTypeName = SessionEntityTypeName.FromProjectLocationAgentSessionEntityType("[PROJECT]", "[LOCATION]", "[AGENT]", "[SESSION]", "[ENTITY_TYPE]"),
};
// Make the request
await sessionEntityTypesClient.DeleteSessionEntityTypeAsync(request);

DeleteSessionEntityTypeAsync(SessionEntityTypeName, CallSettings)

public virtual Task DeleteSessionEntityTypeAsync(SessionEntityTypeName name, CallSettings callSettings = null)

Deletes the specified session entity type.

Parameters
NameDescription
nameSessionEntityTypeName

Required. The name of the session entity type to delete. Format: projects/&amp;lt;Project ID&amp;gt;/locations/&amp;lt;Location ID&amp;gt;/agents/&amp;lt;Agent ID&amp;gt;/sessions/&amp;lt;Session ID&amp;gt;/entityTypes/&amp;lt;Entity Type ID&amp;gt; or projects/&amp;lt;Project ID&amp;gt;/locations/&amp;lt;Location ID&amp;gt;/agents/&amp;lt;Agent ID&amp;gt;/environments/&amp;lt;Environment ID&amp;gt;/sessions/&amp;lt;Session ID&amp;gt;/entityTypes/&amp;lt;Entity Type ID&amp;gt;. If Environment ID is not specified, we assume default 'draft' environment.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
Task

A Task containing the RPC response.

Example
// Create client
SessionEntityTypesClient sessionEntityTypesClient = await SessionEntityTypesClient.CreateAsync();
// Initialize request argument(s)
SessionEntityTypeName name = SessionEntityTypeName.FromProjectLocationAgentSessionEntityType("[PROJECT]", "[LOCATION]", "[AGENT]", "[SESSION]", "[ENTITY_TYPE]");
// Make the request
await sessionEntityTypesClient.DeleteSessionEntityTypeAsync(name);

DeleteSessionEntityTypeAsync(SessionEntityTypeName, CancellationToken)

public virtual Task DeleteSessionEntityTypeAsync(SessionEntityTypeName name, CancellationToken cancellationToken)

Deletes the specified session entity type.

Parameters
NameDescription
nameSessionEntityTypeName

Required. The name of the session entity type to delete. Format: projects/&amp;lt;Project ID&amp;gt;/locations/&amp;lt;Location ID&amp;gt;/agents/&amp;lt;Agent ID&amp;gt;/sessions/&amp;lt;Session ID&amp;gt;/entityTypes/&amp;lt;Entity Type ID&amp;gt; or projects/&amp;lt;Project ID&amp;gt;/locations/&amp;lt;Location ID&amp;gt;/agents/&amp;lt;Agent ID&amp;gt;/environments/&amp;lt;Environment ID&amp;gt;/sessions/&amp;lt;Session ID&amp;gt;/entityTypes/&amp;lt;Entity Type ID&amp;gt;. If Environment ID is not specified, we assume default 'draft' environment.

cancellationTokenCancellationToken

A CancellationToken to use for this RPC.

Returns
TypeDescription
Task

A Task containing the RPC response.

Example
// Create client
SessionEntityTypesClient sessionEntityTypesClient = await SessionEntityTypesClient.CreateAsync();
// Initialize request argument(s)
SessionEntityTypeName name = SessionEntityTypeName.FromProjectLocationAgentSessionEntityType("[PROJECT]", "[LOCATION]", "[AGENT]", "[SESSION]", "[ENTITY_TYPE]");
// Make the request
await sessionEntityTypesClient.DeleteSessionEntityTypeAsync(name);

DeleteSessionEntityTypeAsync(String, CallSettings)

public virtual Task DeleteSessionEntityTypeAsync(string name, CallSettings callSettings = null)

Deletes the specified session entity type.

Parameters
NameDescription
nameString

Required. The name of the session entity type to delete. Format: projects/&amp;lt;Project ID&amp;gt;/locations/&amp;lt;Location ID&amp;gt;/agents/&amp;lt;Agent ID&amp;gt;/sessions/&amp;lt;Session ID&amp;gt;/entityTypes/&amp;lt;Entity Type ID&amp;gt; or projects/&amp;lt;Project ID&amp;gt;/locations/&amp;lt;Location ID&amp;gt;/agents/&amp;lt;Agent ID&amp;gt;/environments/&amp;lt;Environment ID&amp;gt;/sessions/&amp;lt;Session ID&amp;gt;/entityTypes/&amp;lt;Entity Type ID&amp;gt;. If Environment ID is not specified, we assume default 'draft' environment.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
Task

A Task containing the RPC response.

Example
// Create client
SessionEntityTypesClient sessionEntityTypesClient = await SessionEntityTypesClient.CreateAsync();
// Initialize request argument(s)
string name = "projects/[PROJECT]/locations/[LOCATION]/agents/[AGENT]/sessions/[SESSION]/entityTypes/[ENTITY_TYPE]";
// Make the request
await sessionEntityTypesClient.DeleteSessionEntityTypeAsync(name);

DeleteSessionEntityTypeAsync(String, CancellationToken)

public virtual Task DeleteSessionEntityTypeAsync(string name, CancellationToken cancellationToken)

Deletes the specified session entity type.

Parameters
NameDescription
nameString

Required. The name of the session entity type to delete. Format: projects/&amp;lt;Project ID&amp;gt;/locations/&amp;lt;Location ID&amp;gt;/agents/&amp;lt;Agent ID&amp;gt;/sessions/&amp;lt;Session ID&amp;gt;/entityTypes/&amp;lt;Entity Type ID&amp;gt; or projects/&amp;lt;Project ID&amp;gt;/locations/&amp;lt;Location ID&amp;gt;/agents/&amp;lt;Agent ID&amp;gt;/environments/&amp;lt;Environment ID&amp;gt;/sessions/&amp;lt;Session ID&amp;gt;/entityTypes/&amp;lt;Entity Type ID&amp;gt;. If Environment ID is not specified, we assume default 'draft' environment.

cancellationTokenCancellationToken

A CancellationToken to use for this RPC.

Returns
TypeDescription
Task

A Task containing the RPC response.

Example
// Create client
SessionEntityTypesClient sessionEntityTypesClient = await SessionEntityTypesClient.CreateAsync();
// Initialize request argument(s)
string name = "projects/[PROJECT]/locations/[LOCATION]/agents/[AGENT]/sessions/[SESSION]/entityTypes/[ENTITY_TYPE]";
// Make the request
await sessionEntityTypesClient.DeleteSessionEntityTypeAsync(name);

GetSessionEntityType(GetSessionEntityTypeRequest, CallSettings)

public virtual SessionEntityType GetSessionEntityType(GetSessionEntityTypeRequest request, CallSettings callSettings = null)

Retrieves the specified session entity type.

Parameters
NameDescription
requestGetSessionEntityTypeRequest

The request object containing all of the parameters for the API call.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
SessionEntityType

The RPC response.

Example
// Create client
SessionEntityTypesClient sessionEntityTypesClient = SessionEntityTypesClient.Create();
// Initialize request argument(s)
GetSessionEntityTypeRequest request = new GetSessionEntityTypeRequest
{
    SessionEntityTypeName = SessionEntityTypeName.FromProjectLocationAgentSessionEntityType("[PROJECT]", "[LOCATION]", "[AGENT]", "[SESSION]", "[ENTITY_TYPE]"),
};
// Make the request
SessionEntityType response = sessionEntityTypesClient.GetSessionEntityType(request);

GetSessionEntityType(SessionEntityTypeName, CallSettings)

public virtual SessionEntityType GetSessionEntityType(SessionEntityTypeName name, CallSettings callSettings = null)

Retrieves the specified session entity type.

Parameters
NameDescription
nameSessionEntityTypeName

Required. The name of the session entity type. Format: projects/&amp;lt;Project ID&amp;gt;/locations/&amp;lt;Location ID&amp;gt;/agents/&amp;lt;Agent ID&amp;gt;/sessions/&amp;lt;Session ID&amp;gt;/entityTypes/&amp;lt;Entity Type ID&amp;gt; or projects/&amp;lt;Project ID&amp;gt;/locations/&amp;lt;Location ID&amp;gt;/agents/&amp;lt;Agent ID&amp;gt;/environments/&amp;lt;Environment ID&amp;gt;/sessions/&amp;lt;Session ID&amp;gt;/entityTypes/&amp;lt;Entity Type ID&amp;gt;. If Environment ID is not specified, we assume default 'draft' environment.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
SessionEntityType

The RPC response.

Example
// Create client
SessionEntityTypesClient sessionEntityTypesClient = SessionEntityTypesClient.Create();
// Initialize request argument(s)
SessionEntityTypeName name = SessionEntityTypeName.FromProjectLocationAgentSessionEntityType("[PROJECT]", "[LOCATION]", "[AGENT]", "[SESSION]", "[ENTITY_TYPE]");
// Make the request
SessionEntityType response = sessionEntityTypesClient.GetSessionEntityType(name);

GetSessionEntityType(String, CallSettings)

public virtual SessionEntityType GetSessionEntityType(string name, CallSettings callSettings = null)

Retrieves the specified session entity type.

Parameters
NameDescription
nameString

Required. The name of the session entity type. Format: projects/&amp;lt;Project ID&amp;gt;/locations/&amp;lt;Location ID&amp;gt;/agents/&amp;lt;Agent ID&amp;gt;/sessions/&amp;lt;Session ID&amp;gt;/entityTypes/&amp;lt;Entity Type ID&amp;gt; or projects/&amp;lt;Project ID&amp;gt;/locations/&amp;lt;Location ID&amp;gt;/agents/&amp;lt;Agent ID&amp;gt;/environments/&amp;lt;Environment ID&amp;gt;/sessions/&amp;lt;Session ID&amp;gt;/entityTypes/&amp;lt;Entity Type ID&amp;gt;. If Environment ID is not specified, we assume default 'draft' environment.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
SessionEntityType

The RPC response.

Example
// Create client
SessionEntityTypesClient sessionEntityTypesClient = SessionEntityTypesClient.Create();
// Initialize request argument(s)
string name = "projects/[PROJECT]/locations/[LOCATION]/agents/[AGENT]/sessions/[SESSION]/entityTypes/[ENTITY_TYPE]";
// Make the request
SessionEntityType response = sessionEntityTypesClient.GetSessionEntityType(name);

GetSessionEntityTypeAsync(GetSessionEntityTypeRequest, CallSettings)

public virtual Task<SessionEntityType> GetSessionEntityTypeAsync(GetSessionEntityTypeRequest request, CallSettings callSettings = null)

Retrieves the specified session entity type.

Parameters
NameDescription
requestGetSessionEntityTypeRequest

The request object containing all of the parameters for the API call.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
Task<SessionEntityType>

A Task containing the RPC response.

Example
// Create client
SessionEntityTypesClient sessionEntityTypesClient = await SessionEntityTypesClient.CreateAsync();
// Initialize request argument(s)
GetSessionEntityTypeRequest request = new GetSessionEntityTypeRequest
{
    SessionEntityTypeName = SessionEntityTypeName.FromProjectLocationAgentSessionEntityType("[PROJECT]", "[LOCATION]", "[AGENT]", "[SESSION]", "[ENTITY_TYPE]"),
};
// Make the request
SessionEntityType response = await sessionEntityTypesClient.GetSessionEntityTypeAsync(request);

GetSessionEntityTypeAsync(GetSessionEntityTypeRequest, CancellationToken)

public virtual Task<SessionEntityType> GetSessionEntityTypeAsync(GetSessionEntityTypeRequest request, CancellationToken cancellationToken)

Retrieves the specified session entity type.

Parameters
NameDescription
requestGetSessionEntityTypeRequest

The request object containing all of the parameters for the API call.

cancellationTokenCancellationToken

A CancellationToken to use for this RPC.

Returns
TypeDescription
Task<SessionEntityType>

A Task containing the RPC response.

Example
// Create client
SessionEntityTypesClient sessionEntityTypesClient = await SessionEntityTypesClient.CreateAsync();
// Initialize request argument(s)
GetSessionEntityTypeRequest request = new GetSessionEntityTypeRequest
{
    SessionEntityTypeName = SessionEntityTypeName.FromProjectLocationAgentSessionEntityType("[PROJECT]", "[LOCATION]", "[AGENT]", "[SESSION]", "[ENTITY_TYPE]"),
};
// Make the request
SessionEntityType response = await sessionEntityTypesClient.GetSessionEntityTypeAsync(request);

GetSessionEntityTypeAsync(SessionEntityTypeName, CallSettings)

public virtual Task<SessionEntityType> GetSessionEntityTypeAsync(SessionEntityTypeName name, CallSettings callSettings = null)

Retrieves the specified session entity type.

Parameters
NameDescription
nameSessionEntityTypeName

Required. The name of the session entity type. Format: projects/&amp;lt;Project ID&amp;gt;/locations/&amp;lt;Location ID&amp;gt;/agents/&amp;lt;Agent ID&amp;gt;/sessions/&amp;lt;Session ID&amp;gt;/entityTypes/&amp;lt;Entity Type ID&amp;gt; or projects/&amp;lt;Project ID&amp;gt;/locations/&amp;lt;Location ID&amp;gt;/agents/&amp;lt;Agent ID&amp;gt;/environments/&amp;lt;Environment ID&amp;gt;/sessions/&amp;lt;Session ID&amp;gt;/entityTypes/&amp;lt;Entity Type ID&amp;gt;. If Environment ID is not specified, we assume default 'draft' environment.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
Task<SessionEntityType>

A Task containing the RPC response.

Example
// Create client
SessionEntityTypesClient sessionEntityTypesClient = await SessionEntityTypesClient.CreateAsync();
// Initialize request argument(s)
SessionEntityTypeName name = SessionEntityTypeName.FromProjectLocationAgentSessionEntityType("[PROJECT]", "[LOCATION]", "[AGENT]", "[SESSION]", "[ENTITY_TYPE]");
// Make the request
SessionEntityType response = await sessionEntityTypesClient.GetSessionEntityTypeAsync(name);

GetSessionEntityTypeAsync(SessionEntityTypeName, CancellationToken)

public virtual Task<SessionEntityType> GetSessionEntityTypeAsync(SessionEntityTypeName name, CancellationToken cancellationToken)

Retrieves the specified session entity type.

Parameters
NameDescription
nameSessionEntityTypeName

Required. The name of the session entity type. Format: projects/&amp;lt;Project ID&amp;gt;/locations/&amp;lt;Location ID&amp;gt;/agents/&amp;lt;Agent ID&amp;gt;/sessions/&amp;lt;Session ID&amp;gt;/entityTypes/&amp;lt;Entity Type ID&amp;gt; or projects/&amp;lt;Project ID&amp;gt;/locations/&amp;lt;Location ID&amp;gt;/agents/&amp;lt;Agent ID&amp;gt;/environments/&amp;lt;Environment ID&amp;gt;/sessions/&amp;lt;Session ID&amp;gt;/entityTypes/&amp;lt;Entity Type ID&amp;gt;. If Environment ID is not specified, we assume default 'draft' environment.

cancellationTokenCancellationToken

A CancellationToken to use for this RPC.

Returns
TypeDescription
Task<SessionEntityType>

A Task containing the RPC response.

Example
// Create client
SessionEntityTypesClient sessionEntityTypesClient = await SessionEntityTypesClient.CreateAsync();
// Initialize request argument(s)
SessionEntityTypeName name = SessionEntityTypeName.FromProjectLocationAgentSessionEntityType("[PROJECT]", "[LOCATION]", "[AGENT]", "[SESSION]", "[ENTITY_TYPE]");
// Make the request
SessionEntityType response = await sessionEntityTypesClient.GetSessionEntityTypeAsync(name);

GetSessionEntityTypeAsync(String, CallSettings)

public virtual Task<SessionEntityType> GetSessionEntityTypeAsync(string name, CallSettings callSettings = null)

Retrieves the specified session entity type.

Parameters
NameDescription
nameString

Required. The name of the session entity type. Format: projects/&amp;lt;Project ID&amp;gt;/locations/&amp;lt;Location ID&amp;gt;/agents/&amp;lt;Agent ID&amp;gt;/sessions/&amp;lt;Session ID&amp;gt;/entityTypes/&amp;lt;Entity Type ID&amp;gt; or projects/&amp;lt;Project ID&amp;gt;/locations/&amp;lt;Location ID&amp;gt;/agents/&amp;lt;Agent ID&amp;gt;/environments/&amp;lt;Environment ID&amp;gt;/sessions/&amp;lt;Session ID&amp;gt;/entityTypes/&amp;lt;Entity Type ID&amp;gt;. If Environment ID is not specified, we assume default 'draft' environment.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
Task<SessionEntityType>

A Task containing the RPC response.

Example
// Create client
SessionEntityTypesClient sessionEntityTypesClient = await SessionEntityTypesClient.CreateAsync();
// Initialize request argument(s)
string name = "projects/[PROJECT]/locations/[LOCATION]/agents/[AGENT]/sessions/[SESSION]/entityTypes/[ENTITY_TYPE]";
// Make the request
SessionEntityType response = await sessionEntityTypesClient.GetSessionEntityTypeAsync(name);

GetSessionEntityTypeAsync(String, CancellationToken)

public virtual Task<SessionEntityType> GetSessionEntityTypeAsync(string name, CancellationToken cancellationToken)

Retrieves the specified session entity type.

Parameters
NameDescription
nameString

Required. The name of the session entity type. Format: projects/&amp;lt;Project ID&amp;gt;/locations/&amp;lt;Location ID&amp;gt;/agents/&amp;lt;Agent ID&amp;gt;/sessions/&amp;lt;Session ID&amp;gt;/entityTypes/&amp;lt;Entity Type ID&amp;gt; or projects/&amp;lt;Project ID&amp;gt;/locations/&amp;lt;Location ID&amp;gt;/agents/&amp;lt;Agent ID&amp;gt;/environments/&amp;lt;Environment ID&amp;gt;/sessions/&amp;lt;Session ID&amp;gt;/entityTypes/&amp;lt;Entity Type ID&amp;gt;. If Environment ID is not specified, we assume default 'draft' environment.

cancellationTokenCancellationToken

A CancellationToken to use for this RPC.

Returns
TypeDescription
Task<SessionEntityType>

A Task containing the RPC response.

Example
// Create client
SessionEntityTypesClient sessionEntityTypesClient = await SessionEntityTypesClient.CreateAsync();
// Initialize request argument(s)
string name = "projects/[PROJECT]/locations/[LOCATION]/agents/[AGENT]/sessions/[SESSION]/entityTypes/[ENTITY_TYPE]";
// Make the request
SessionEntityType response = await sessionEntityTypesClient.GetSessionEntityTypeAsync(name);

ListSessionEntityTypes(ListSessionEntityTypesRequest, CallSettings)

public virtual PagedEnumerable<ListSessionEntityTypesResponse, SessionEntityType> ListSessionEntityTypes(ListSessionEntityTypesRequest request, CallSettings callSettings = null)

Returns the list of all session entity types in the specified session.

Parameters
NameDescription
requestListSessionEntityTypesRequest

The request object containing all of the parameters for the API call.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
PagedEnumerable<ListSessionEntityTypesResponse, SessionEntityType>

A pageable sequence of SessionEntityType resources.

Example
// Create client
SessionEntityTypesClient sessionEntityTypesClient = SessionEntityTypesClient.Create();
// Initialize request argument(s)
ListSessionEntityTypesRequest request = new ListSessionEntityTypesRequest
{
    ParentAsSessionName = SessionName.FromProjectLocationAgentSession("[PROJECT]", "[LOCATION]", "[AGENT]", "[SESSION]"),
};
// Make the request
PagedEnumerable<ListSessionEntityTypesResponse, SessionEntityType> response = sessionEntityTypesClient.ListSessionEntityTypes(request);

// Iterate over all response items, lazily performing RPCs as required
foreach (SessionEntityType item in response)
{
    // Do something with each item
    Console.WriteLine(item);
}

// Or iterate over pages (of server-defined size), performing one RPC per page
foreach (ListSessionEntityTypesResponse page in response.AsRawResponses())
{
    // Do something with each page of items
    Console.WriteLine("A page of results:");
    foreach (SessionEntityType item in page)
    {
        // Do something with each item
        Console.WriteLine(item);
    }
}

// Or retrieve a single page of known size (unless it's the final page), performing as many RPCs as required
int pageSize = 10;
Page<SessionEntityType> singlePage = response.ReadPage(pageSize);
// Do something with the page of items
Console.WriteLine($"A page of {pageSize} results (unless it's the final page):");
foreach (SessionEntityType item in singlePage)
{
    // Do something with each item
    Console.WriteLine(item);
}
// Store the pageToken, for when the next page is required.
string nextPageToken = singlePage.NextPageToken;

ListSessionEntityTypes(SessionName, String, Nullable<Int32>, CallSettings)

public virtual PagedEnumerable<ListSessionEntityTypesResponse, SessionEntityType> ListSessionEntityTypes(SessionName parent, string pageToken = null, int? pageSize = default(int? ), CallSettings callSettings = null)

Returns the list of all session entity types in the specified session.

Parameters
NameDescription
parentSessionName

Required. The session to list all session entity types from. Format: projects/&amp;lt;Project ID&amp;gt;/locations/&amp;lt;Location ID&amp;gt;/agents/&amp;lt;Agent ID&amp;gt;/sessions/&amp;lt;Session ID&amp;gt; or projects/&amp;lt;Project ID&amp;gt;/locations/&amp;lt;Location ID&amp;gt;/agents/&amp;lt;Agent ID&amp;gt;/environments/&amp;lt;Environment ID&amp;gt;/sessions/&amp;lt;Session ID&amp;gt;. If Environment ID is not specified, we assume default 'draft' environment.

pageTokenString

The token returned from the previous request. A value of null or an empty string retrieves the first page.

pageSizeNullable<Int32>

The size of page to request. The response will not be larger than this, but may be smaller. A value of null or 0 uses a server-defined page size.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
PagedEnumerable<ListSessionEntityTypesResponse, SessionEntityType>

A pageable sequence of SessionEntityType resources.

Example
// Create client
SessionEntityTypesClient sessionEntityTypesClient = SessionEntityTypesClient.Create();
// Initialize request argument(s)
SessionName parent = SessionName.FromProjectLocationAgentSession("[PROJECT]", "[LOCATION]", "[AGENT]", "[SESSION]");
// Make the request
PagedEnumerable<ListSessionEntityTypesResponse, SessionEntityType> response = sessionEntityTypesClient.ListSessionEntityTypes(parent);

// Iterate over all response items, lazily performing RPCs as required
foreach (SessionEntityType item in response)
{
    // Do something with each item
    Console.WriteLine(item);
}

// Or iterate over pages (of server-defined size), performing one RPC per page
foreach (ListSessionEntityTypesResponse page in response.AsRawResponses())
{
    // Do something with each page of items
    Console.WriteLine("A page of results:");
    foreach (SessionEntityType item in page)
    {
        // Do something with each item
        Console.WriteLine(item);
    }
}

// Or retrieve a single page of known size (unless it's the final page), performing as many RPCs as required
int pageSize = 10;
Page<SessionEntityType> singlePage = response.ReadPage(pageSize);
// Do something with the page of items
Console.WriteLine($"A page of {pageSize} results (unless it's the final page):");
foreach (SessionEntityType item in singlePage)
{
    // Do something with each item
    Console.WriteLine(item);
}
// Store the pageToken, for when the next page is required.
string nextPageToken = singlePage.NextPageToken;

ListSessionEntityTypes(String, String, Nullable<Int32>, CallSettings)

public virtual PagedEnumerable<ListSessionEntityTypesResponse, SessionEntityType> ListSessionEntityTypes(string parent, string pageToken = null, int? pageSize = default(int? ), CallSettings callSettings = null)

Returns the list of all session entity types in the specified session.

Parameters
NameDescription
parentString

Required. The session to list all session entity types from. Format: projects/&amp;lt;Project ID&amp;gt;/locations/&amp;lt;Location ID&amp;gt;/agents/&amp;lt;Agent ID&amp;gt;/sessions/&amp;lt;Session ID&amp;gt; or projects/&amp;lt;Project ID&amp;gt;/locations/&amp;lt;Location ID&amp;gt;/agents/&amp;lt;Agent ID&amp;gt;/environments/&amp;lt;Environment ID&amp;gt;/sessions/&amp;lt;Session ID&amp;gt;. If Environment ID is not specified, we assume default 'draft' environment.

pageTokenString

The token returned from the previous request. A value of null or an empty string retrieves the first page.

pageSizeNullable<Int32>

The size of page to request. The response will not be larger than this, but may be smaller. A value of null or 0 uses a server-defined page size.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
PagedEnumerable<ListSessionEntityTypesResponse, SessionEntityType>

A pageable sequence of SessionEntityType resources.

Example
// Create client
SessionEntityTypesClient sessionEntityTypesClient = SessionEntityTypesClient.Create();
// Initialize request argument(s)
string parent = "projects/[PROJECT]/locations/[LOCATION]/agents/[AGENT]/sessions/[SESSION]";
// Make the request
PagedEnumerable<ListSessionEntityTypesResponse, SessionEntityType> response = sessionEntityTypesClient.ListSessionEntityTypes(parent);

// Iterate over all response items, lazily performing RPCs as required
foreach (SessionEntityType item in response)
{
    // Do something with each item
    Console.WriteLine(item);
}

// Or iterate over pages (of server-defined size), performing one RPC per page
foreach (ListSessionEntityTypesResponse page in response.AsRawResponses())
{
    // Do something with each page of items
    Console.WriteLine("A page of results:");
    foreach (SessionEntityType item in page)
    {
        // Do something with each item
        Console.WriteLine(item);
    }
}

// Or retrieve a single page of known size (unless it's the final page), performing as many RPCs as required
int pageSize = 10;
Page<SessionEntityType> singlePage = response.ReadPage(pageSize);
// Do something with the page of items
Console.WriteLine($"A page of {pageSize} results (unless it's the final page):");
foreach (SessionEntityType item in singlePage)
{
    // Do something with each item
    Console.WriteLine(item);
}
// Store the pageToken, for when the next page is required.
string nextPageToken = singlePage.NextPageToken;

ListSessionEntityTypesAsync(ListSessionEntityTypesRequest, CallSettings)

public virtual PagedAsyncEnumerable<ListSessionEntityTypesResponse, SessionEntityType> ListSessionEntityTypesAsync(ListSessionEntityTypesRequest request, CallSettings callSettings = null)

Returns the list of all session entity types in the specified session.

Parameters
NameDescription
requestListSessionEntityTypesRequest

The request object containing all of the parameters for the API call.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
PagedAsyncEnumerable<ListSessionEntityTypesResponse, SessionEntityType>

A pageable asynchronous sequence of SessionEntityType resources.

Example
// Create client
SessionEntityTypesClient sessionEntityTypesClient = await SessionEntityTypesClient.CreateAsync();
// Initialize request argument(s)
ListSessionEntityTypesRequest request = new ListSessionEntityTypesRequest
{
    ParentAsSessionName = SessionName.FromProjectLocationAgentSession("[PROJECT]", "[LOCATION]", "[AGENT]", "[SESSION]"),
};
// Make the request
PagedAsyncEnumerable<ListSessionEntityTypesResponse, SessionEntityType> response = sessionEntityTypesClient.ListSessionEntityTypesAsync(request);

// Iterate over all response items, lazily performing RPCs as required
await response.ForEachAsync((SessionEntityType item) =>
{
    // Do something with each item
    Console.WriteLine(item);
});

// Or iterate over pages (of server-defined size), performing one RPC per page
await response.AsRawResponses().ForEachAsync((ListSessionEntityTypesResponse page) =>
{
    // Do something with each page of items
    Console.WriteLine("A page of results:");
    foreach (SessionEntityType item in page)
    {
        // Do something with each item
        Console.WriteLine(item);
    }
});

// Or retrieve a single page of known size (unless it's the final page), performing as many RPCs as required
int pageSize = 10;
Page<SessionEntityType> singlePage = await response.ReadPageAsync(pageSize);
// Do something with the page of items
Console.WriteLine($"A page of {pageSize} results (unless it's the final page):");
foreach (SessionEntityType item in singlePage)
{
    // Do something with each item
    Console.WriteLine(item);
}
// Store the pageToken, for when the next page is required.
string nextPageToken = singlePage.NextPageToken;

ListSessionEntityTypesAsync(SessionName, String, Nullable<Int32>, CallSettings)

public virtual PagedAsyncEnumerable<ListSessionEntityTypesResponse, SessionEntityType> ListSessionEntityTypesAsync(SessionName parent, string pageToken = null, int? pageSize = default(int? ), CallSettings callSettings = null)

Returns the list of all session entity types in the specified session.

Parameters
NameDescription
parentSessionName

Required. The session to list all session entity types from. Format: projects/&amp;lt;Project ID&amp;gt;/locations/&amp;lt;Location ID&amp;gt;/agents/&amp;lt;Agent ID&amp;gt;/sessions/&amp;lt;Session ID&amp;gt; or projects/&amp;lt;Project ID&amp;gt;/locations/&amp;lt;Location ID&amp;gt;/agents/&amp;lt;Agent ID&amp;gt;/environments/&amp;lt;Environment ID&amp;gt;/sessions/&amp;lt;Session ID&amp;gt;. If Environment ID is not specified, we assume default 'draft' environment.

pageTokenString

The token returned from the previous request. A value of null or an empty string retrieves the first page.

pageSizeNullable<Int32>

The size of page to request. The response will not be larger than this, but may be smaller. A value of null or 0 uses a server-defined page size.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
PagedAsyncEnumerable<ListSessionEntityTypesResponse, SessionEntityType>

A pageable asynchronous sequence of SessionEntityType resources.

Example
// Create client
SessionEntityTypesClient sessionEntityTypesClient = await SessionEntityTypesClient.CreateAsync();
// Initialize request argument(s)
SessionName parent = SessionName.FromProjectLocationAgentSession("[PROJECT]", "[LOCATION]", "[AGENT]", "[SESSION]");
// Make the request
PagedAsyncEnumerable<ListSessionEntityTypesResponse, SessionEntityType> response = sessionEntityTypesClient.ListSessionEntityTypesAsync(parent);

// Iterate over all response items, lazily performing RPCs as required
await response.ForEachAsync((SessionEntityType item) =>
{
    // Do something with each item
    Console.WriteLine(item);
});

// Or iterate over pages (of server-defined size), performing one RPC per page
await response.AsRawResponses().ForEachAsync((ListSessionEntityTypesResponse page) =>
{
    // Do something with each page of items
    Console.WriteLine("A page of results:");
    foreach (SessionEntityType item in page)
    {
        // Do something with each item
        Console.WriteLine(item);
    }
});

// Or retrieve a single page of known size (unless it's the final page), performing as many RPCs as required
int pageSize = 10;
Page<SessionEntityType> singlePage = await response.ReadPageAsync(pageSize);
// Do something with the page of items
Console.WriteLine($"A page of {pageSize} results (unless it's the final page):");
foreach (SessionEntityType item in singlePage)
{
    // Do something with each item
    Console.WriteLine(item);
}
// Store the pageToken, for when the next page is required.
string nextPageToken = singlePage.NextPageToken;

ListSessionEntityTypesAsync(String, String, Nullable<Int32>, CallSettings)

public virtual PagedAsyncEnumerable<ListSessionEntityTypesResponse, SessionEntityType> ListSessionEntityTypesAsync(string parent, string pageToken = null, int? pageSize = default(int? ), CallSettings callSettings = null)

Returns the list of all session entity types in the specified session.

Parameters
NameDescription
parentString

Required. The session to list all session entity types from. Format: projects/&amp;lt;Project ID&amp;gt;/locations/&amp;lt;Location ID&amp;gt;/agents/&amp;lt;Agent ID&amp;gt;/sessions/&amp;lt;Session ID&amp;gt; or projects/&amp;lt;Project ID&amp;gt;/locations/&amp;lt;Location ID&amp;gt;/agents/&amp;lt;Agent ID&amp;gt;/environments/&amp;lt;Environment ID&amp;gt;/sessions/&amp;lt;Session ID&amp;gt;. If Environment ID is not specified, we assume default 'draft' environment.

pageTokenString

The token returned from the previous request. A value of null or an empty string retrieves the first page.

pageSizeNullable<Int32>

The size of page to request. The response will not be larger than this, but may be smaller. A value of null or 0 uses a server-defined page size.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
PagedAsyncEnumerable<ListSessionEntityTypesResponse, SessionEntityType>

A pageable asynchronous sequence of SessionEntityType resources.

Example
// Create client
SessionEntityTypesClient sessionEntityTypesClient = await SessionEntityTypesClient.CreateAsync();
// Initialize request argument(s)
string parent = "projects/[PROJECT]/locations/[LOCATION]/agents/[AGENT]/sessions/[SESSION]";
// Make the request
PagedAsyncEnumerable<ListSessionEntityTypesResponse, SessionEntityType> response = sessionEntityTypesClient.ListSessionEntityTypesAsync(parent);

// Iterate over all response items, lazily performing RPCs as required
await response.ForEachAsync((SessionEntityType item) =>
{
    // Do something with each item
    Console.WriteLine(item);
});

// Or iterate over pages (of server-defined size), performing one RPC per page
await response.AsRawResponses().ForEachAsync((ListSessionEntityTypesResponse page) =>
{
    // Do something with each page of items
    Console.WriteLine("A page of results:");
    foreach (SessionEntityType item in page)
    {
        // Do something with each item
        Console.WriteLine(item);
    }
});

// Or retrieve a single page of known size (unless it's the final page), performing as many RPCs as required
int pageSize = 10;
Page<SessionEntityType> singlePage = await response.ReadPageAsync(pageSize);
// Do something with the page of items
Console.WriteLine($"A page of {pageSize} results (unless it's the final page):");
foreach (SessionEntityType item in singlePage)
{
    // Do something with each item
    Console.WriteLine(item);
}
// Store the pageToken, for when the next page is required.
string nextPageToken = singlePage.NextPageToken;

ShutdownDefaultChannelsAsync()

public static Task ShutdownDefaultChannelsAsync()

Shuts down any channels automatically created by Create() and CreateAsync(CancellationToken). Channels which weren't automatically created are not affected.

Returns
TypeDescription
Task

A task representing the asynchronous shutdown operation.

Remarks

After calling this method, further calls to Create() and CreateAsync(CancellationToken) will create new channels, which could in turn be shut down by another call to this method.

UpdateSessionEntityType(SessionEntityType, FieldMask, CallSettings)

public virtual SessionEntityType UpdateSessionEntityType(SessionEntityType sessionEntityType, FieldMask updateMask, CallSettings callSettings = null)

Updates the specified session entity type.

Parameters
NameDescription
sessionEntityTypeSessionEntityType

Required. The session entity type to update. Format: projects/&amp;lt;Project ID&amp;gt;/locations/&amp;lt;Location ID&amp;gt;/agents/&amp;lt;Agent ID&amp;gt;/sessions/&amp;lt;Session ID&amp;gt;/entityTypes/&amp;lt;Entity Type ID&amp;gt; or projects/&amp;lt;Project ID&amp;gt;/locations/&amp;lt;Location ID&amp;gt;/agents/&amp;lt;Agent ID&amp;gt;/environments/&amp;lt;Environment ID&amp;gt;/sessions/&amp;lt;Session ID&amp;gt;/entityTypes/&amp;lt;Entity Type ID&amp;gt;. If Environment ID is not specified, we assume default 'draft' environment.

updateMaskFieldMask

The mask to control which fields get updated.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
SessionEntityType

The RPC response.

Example
// Create client
SessionEntityTypesClient sessionEntityTypesClient = SessionEntityTypesClient.Create();
// Initialize request argument(s)
SessionEntityType sessionEntityType = new SessionEntityType();
FieldMask updateMask = new FieldMask();
// Make the request
SessionEntityType response = sessionEntityTypesClient.UpdateSessionEntityType(sessionEntityType, updateMask);

UpdateSessionEntityType(UpdateSessionEntityTypeRequest, CallSettings)

public virtual SessionEntityType UpdateSessionEntityType(UpdateSessionEntityTypeRequest request, CallSettings callSettings = null)

Updates the specified session entity type.

Parameters
NameDescription
requestUpdateSessionEntityTypeRequest

The request object containing all of the parameters for the API call.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
SessionEntityType

The RPC response.

Example
// Create client
SessionEntityTypesClient sessionEntityTypesClient = SessionEntityTypesClient.Create();
// Initialize request argument(s)
UpdateSessionEntityTypeRequest request = new UpdateSessionEntityTypeRequest
{
    SessionEntityType = new SessionEntityType(),
    UpdateMask = new FieldMask(),
};
// Make the request
SessionEntityType response = sessionEntityTypesClient.UpdateSessionEntityType(request);

UpdateSessionEntityTypeAsync(SessionEntityType, FieldMask, CallSettings)

public virtual Task<SessionEntityType> UpdateSessionEntityTypeAsync(SessionEntityType sessionEntityType, FieldMask updateMask, CallSettings callSettings = null)

Updates the specified session entity type.

Parameters
NameDescription
sessionEntityTypeSessionEntityType

Required. The session entity type to update. Format: projects/&amp;lt;Project ID&amp;gt;/locations/&amp;lt;Location ID&amp;gt;/agents/&amp;lt;Agent ID&amp;gt;/sessions/&amp;lt;Session ID&amp;gt;/entityTypes/&amp;lt;Entity Type ID&amp;gt; or projects/&amp;lt;Project ID&amp;gt;/locations/&amp;lt;Location ID&amp;gt;/agents/&amp;lt;Agent ID&amp;gt;/environments/&amp;lt;Environment ID&amp;gt;/sessions/&amp;lt;Session ID&amp;gt;/entityTypes/&amp;lt;Entity Type ID&amp;gt;. If Environment ID is not specified, we assume default 'draft' environment.

updateMaskFieldMask

The mask to control which fields get updated.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
Task<SessionEntityType>

A Task containing the RPC response.

Example
// Create client
SessionEntityTypesClient sessionEntityTypesClient = await SessionEntityTypesClient.CreateAsync();
// Initialize request argument(s)
SessionEntityType sessionEntityType = new SessionEntityType();
FieldMask updateMask = new FieldMask();
// Make the request
SessionEntityType response = await sessionEntityTypesClient.UpdateSessionEntityTypeAsync(sessionEntityType, updateMask);

UpdateSessionEntityTypeAsync(SessionEntityType, FieldMask, CancellationToken)

public virtual Task<SessionEntityType> UpdateSessionEntityTypeAsync(SessionEntityType sessionEntityType, FieldMask updateMask, CancellationToken cancellationToken)

Updates the specified session entity type.

Parameters
NameDescription
sessionEntityTypeSessionEntityType

Required. The session entity type to update. Format: projects/&amp;lt;Project ID&amp;gt;/locations/&amp;lt;Location ID&amp;gt;/agents/&amp;lt;Agent ID&amp;gt;/sessions/&amp;lt;Session ID&amp;gt;/entityTypes/&amp;lt;Entity Type ID&amp;gt; or projects/&amp;lt;Project ID&amp;gt;/locations/&amp;lt;Location ID&amp;gt;/agents/&amp;lt;Agent ID&amp;gt;/environments/&amp;lt;Environment ID&amp;gt;/sessions/&amp;lt;Session ID&amp;gt;/entityTypes/&amp;lt;Entity Type ID&amp;gt;. If Environment ID is not specified, we assume default 'draft' environment.

updateMaskFieldMask

The mask to control which fields get updated.

cancellationTokenCancellationToken

A CancellationToken to use for this RPC.

Returns
TypeDescription
Task<SessionEntityType>

A Task containing the RPC response.

Example
// Create client
SessionEntityTypesClient sessionEntityTypesClient = await SessionEntityTypesClient.CreateAsync();
// Initialize request argument(s)
SessionEntityType sessionEntityType = new SessionEntityType();
FieldMask updateMask = new FieldMask();
// Make the request
SessionEntityType response = await sessionEntityTypesClient.UpdateSessionEntityTypeAsync(sessionEntityType, updateMask);

UpdateSessionEntityTypeAsync(UpdateSessionEntityTypeRequest, CallSettings)

public virtual Task<SessionEntityType> UpdateSessionEntityTypeAsync(UpdateSessionEntityTypeRequest request, CallSettings callSettings = null)

Updates the specified session entity type.

Parameters
NameDescription
requestUpdateSessionEntityTypeRequest

The request object containing all of the parameters for the API call.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
Task<SessionEntityType>

A Task containing the RPC response.

Example
// Create client
SessionEntityTypesClient sessionEntityTypesClient = await SessionEntityTypesClient.CreateAsync();
// Initialize request argument(s)
UpdateSessionEntityTypeRequest request = new UpdateSessionEntityTypeRequest
{
    SessionEntityType = new SessionEntityType(),
    UpdateMask = new FieldMask(),
};
// Make the request
SessionEntityType response = await sessionEntityTypesClient.UpdateSessionEntityTypeAsync(request);

UpdateSessionEntityTypeAsync(UpdateSessionEntityTypeRequest, CancellationToken)

public virtual Task<SessionEntityType> UpdateSessionEntityTypeAsync(UpdateSessionEntityTypeRequest request, CancellationToken cancellationToken)

Updates the specified session entity type.

Parameters
NameDescription
requestUpdateSessionEntityTypeRequest

The request object containing all of the parameters for the API call.

cancellationTokenCancellationToken

A CancellationToken to use for this RPC.

Returns
TypeDescription
Task<SessionEntityType>

A Task containing the RPC response.

Example
// Create client
SessionEntityTypesClient sessionEntityTypesClient = await SessionEntityTypesClient.CreateAsync();
// Initialize request argument(s)
UpdateSessionEntityTypeRequest request = new UpdateSessionEntityTypeRequest
{
    SessionEntityType = new SessionEntityType(),
    UpdateMask = new FieldMask(),
};
// Make the request
SessionEntityType response = await sessionEntityTypesClient.UpdateSessionEntityTypeAsync(request);