Class Pages.PagesClient (2.0.0)

public class PagesClient : ClientBase<Pages.PagesClient>

Client for Pages

Inheritance

Object > ClientBase > ClientBase<Pages.PagesClient> > Pages.PagesClient

Namespace

Google.Cloud.Dialogflow.Cx.V3

Assembly

Google.Cloud.Dialogflow.Cx.V3.dll

Constructors

PagesClient()

protected PagesClient()

Protected parameterless constructor to allow creation of test doubles.

PagesClient(CallInvoker)

public PagesClient(CallInvoker callInvoker)

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

Parameter
NameDescription
callInvokerCallInvoker

The callInvoker to use to make remote calls.

PagesClient(ChannelBase)

public PagesClient(ChannelBase channel)

Creates a new client for Pages

Parameter
NameDescription
channelChannelBase

The channel to use to make remote calls.

PagesClient(ClientBase.ClientBaseConfiguration)

protected PagesClient(ClientBase.ClientBaseConfiguration configuration)

Protected constructor to allow creation of configured clients.

Parameter
NameDescription
configurationClientBase.ClientBaseConfiguration

The client configuration.

Methods

CreatePage(CreatePageRequest, CallOptions)

public virtual Page CreatePage(CreatePageRequest request, CallOptions options)

Creates a page in the specified flow.

Note: You should always train a flow prior to sending it queries. See the training documentation.

Parameters
NameDescription
requestCreatePageRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
Page

The response received from the server.

CreatePage(CreatePageRequest, Metadata, Nullable<DateTime>, CancellationToken)

public virtual Page CreatePage(CreatePageRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default(CancellationToken))

Creates a page in the specified flow.

Note: You should always train a flow prior to sending it queries. See the training documentation.

Parameters
NameDescription
requestCreatePageRequest

The request to send to the server.

headersMetadata

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

deadlineNullable<DateTime>

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

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
Page

The response received from the server.

CreatePageAsync(CreatePageRequest, CallOptions)

public virtual AsyncUnaryCall<Page> CreatePageAsync(CreatePageRequest request, CallOptions options)

Creates a page in the specified flow.

Note: You should always train a flow prior to sending it queries. See the training documentation.

Parameters
NameDescription
requestCreatePageRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
AsyncUnaryCall<Page>

The call object.

CreatePageAsync(CreatePageRequest, Metadata, Nullable<DateTime>, CancellationToken)

public virtual AsyncUnaryCall<Page> CreatePageAsync(CreatePageRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default(CancellationToken))

Creates a page in the specified flow.

Note: You should always train a flow prior to sending it queries. See the training documentation.

Parameters
NameDescription
requestCreatePageRequest

The request to send to the server.

headersMetadata

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

deadlineNullable<DateTime>

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

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
AsyncUnaryCall<Page>

The call object.

DeletePage(DeletePageRequest, CallOptions)

public virtual Empty DeletePage(DeletePageRequest request, CallOptions options)

Deletes the specified page.

Note: You should always train a flow prior to sending it queries. See the training documentation.

Parameters
NameDescription
requestDeletePageRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
Empty

The response received from the server.

DeletePage(DeletePageRequest, Metadata, Nullable<DateTime>, CancellationToken)

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

Deletes the specified page.

Note: You should always train a flow prior to sending it queries. See the training documentation.

Parameters
NameDescription
requestDeletePageRequest

The request to send to the server.

headersMetadata

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

deadlineNullable<DateTime>

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

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
Empty

The response received from the server.

DeletePageAsync(DeletePageRequest, CallOptions)

public virtual AsyncUnaryCall<Empty> DeletePageAsync(DeletePageRequest request, CallOptions options)

Deletes the specified page.

Note: You should always train a flow prior to sending it queries. See the training documentation.

Parameters
NameDescription
requestDeletePageRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
AsyncUnaryCall<Empty>

The call object.

DeletePageAsync(DeletePageRequest, Metadata, Nullable<DateTime>, CancellationToken)

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

Deletes the specified page.

Note: You should always train a flow prior to sending it queries. See the training documentation.

Parameters
NameDescription
requestDeletePageRequest

The request to send to the server.

headersMetadata

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

deadlineNullable<DateTime>

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

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
AsyncUnaryCall<Empty>

The call object.

GetPage(GetPageRequest, CallOptions)

public virtual Page GetPage(GetPageRequest request, CallOptions options)

Retrieves the specified page.

Parameters
NameDescription
requestGetPageRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
Page

The response received from the server.

GetPage(GetPageRequest, Metadata, Nullable<DateTime>, CancellationToken)

public virtual Page GetPage(GetPageRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default(CancellationToken))

Retrieves the specified page.

Parameters
NameDescription
requestGetPageRequest

The request to send to the server.

headersMetadata

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

deadlineNullable<DateTime>

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

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
Page

The response received from the server.

GetPageAsync(GetPageRequest, CallOptions)

public virtual AsyncUnaryCall<Page> GetPageAsync(GetPageRequest request, CallOptions options)

Retrieves the specified page.

Parameters
NameDescription
requestGetPageRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
AsyncUnaryCall<Page>

The call object.

GetPageAsync(GetPageRequest, Metadata, Nullable<DateTime>, CancellationToken)

public virtual AsyncUnaryCall<Page> GetPageAsync(GetPageRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default(CancellationToken))

Retrieves the specified page.

Parameters
NameDescription
requestGetPageRequest

The request to send to the server.

headersMetadata

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

deadlineNullable<DateTime>

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

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
AsyncUnaryCall<Page>

The call object.

ListPages(ListPagesRequest, CallOptions)

public virtual ListPagesResponse ListPages(ListPagesRequest request, CallOptions options)

Returns the list of all pages in the specified flow.

Parameters
NameDescription
requestListPagesRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
ListPagesResponse

The response received from the server.

ListPages(ListPagesRequest, Metadata, Nullable<DateTime>, CancellationToken)

public virtual ListPagesResponse ListPages(ListPagesRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default(CancellationToken))

Returns the list of all pages in the specified flow.

Parameters
NameDescription
requestListPagesRequest

The request to send to the server.

headersMetadata

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

deadlineNullable<DateTime>

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

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
ListPagesResponse

The response received from the server.

ListPagesAsync(ListPagesRequest, CallOptions)

public virtual AsyncUnaryCall<ListPagesResponse> ListPagesAsync(ListPagesRequest request, CallOptions options)

Returns the list of all pages in the specified flow.

Parameters
NameDescription
requestListPagesRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
AsyncUnaryCall<ListPagesResponse>

The call object.

ListPagesAsync(ListPagesRequest, Metadata, Nullable<DateTime>, CancellationToken)

public virtual AsyncUnaryCall<ListPagesResponse> ListPagesAsync(ListPagesRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default(CancellationToken))

Returns the list of all pages in the specified flow.

Parameters
NameDescription
requestListPagesRequest

The request to send to the server.

headersMetadata

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

deadlineNullable<DateTime>

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

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
AsyncUnaryCall<ListPagesResponse>

The call object.

NewInstance(ClientBase.ClientBaseConfiguration)

protected override Pages.PagesClient NewInstance(ClientBase.ClientBaseConfiguration configuration)

Creates a new instance of client from given ClientBaseConfiguration.

Parameter
NameDescription
configurationClientBase.ClientBaseConfiguration
Returns
TypeDescription
Pages.PagesClient
Overrides
Grpc.Core.ClientBase<Google.Cloud.Dialogflow.Cx.V3.Pages.PagesClient>.NewInstance(Grpc.Core.ClientBase.ClientBaseConfiguration)

UpdatePage(UpdatePageRequest, CallOptions)

public virtual Page UpdatePage(UpdatePageRequest request, CallOptions options)

Updates the specified page.

Note: You should always train a flow prior to sending it queries. See the training documentation.

Parameters
NameDescription
requestUpdatePageRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
Page

The response received from the server.

UpdatePage(UpdatePageRequest, Metadata, Nullable<DateTime>, CancellationToken)

public virtual Page UpdatePage(UpdatePageRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default(CancellationToken))

Updates the specified page.

Note: You should always train a flow prior to sending it queries. See the training documentation.

Parameters
NameDescription
requestUpdatePageRequest

The request to send to the server.

headersMetadata

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

deadlineNullable<DateTime>

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

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
Page

The response received from the server.

UpdatePageAsync(UpdatePageRequest, CallOptions)

public virtual AsyncUnaryCall<Page> UpdatePageAsync(UpdatePageRequest request, CallOptions options)

Updates the specified page.

Note: You should always train a flow prior to sending it queries. See the training documentation.

Parameters
NameDescription
requestUpdatePageRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
AsyncUnaryCall<Page>

The call object.

UpdatePageAsync(UpdatePageRequest, Metadata, Nullable<DateTime>, CancellationToken)

public virtual AsyncUnaryCall<Page> UpdatePageAsync(UpdatePageRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default(CancellationToken))

Updates the specified page.

Note: You should always train a flow prior to sending it queries. See the training documentation.

Parameters
NameDescription
requestUpdatePageRequest

The request to send to the server.

headersMetadata

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

deadlineNullable<DateTime>

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

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
AsyncUnaryCall<Page>

The call object.