public class Pages.PagesClient : ClientBase<Pages.PagesClient>
Reference documentation and code samples for the Dialogflow v3 API class Pages.PagesClient.
Client for Pages
Namespace
Google.Cloud.Dialogflow.Cx.V3Assembly
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 | |
---|---|
Name | Description |
callInvoker |
CallInvoker The callInvoker to use to make remote calls. |
PagesClient(ChannelBase)
public PagesClient(ChannelBase channel)
Creates a new client for Pages
Parameter | |
---|---|
Name | Description |
channel |
ChannelBase The channel to use to make remote calls. |
PagesClient(ClientBaseConfiguration)
protected PagesClient(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. |
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 | |
---|---|
Name | Description |
request |
CreatePageRequest The request to send to the server. |
options |
CallOptions The options for the call. |
Returns | |
---|---|
Type | Description |
Page |
The response received from the server. |
CreatePage(CreatePageRequest, Metadata, DateTime?, CancellationToken)
public virtual Page CreatePage(CreatePageRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)
Creates a page in the specified flow.
Note: You should always train a flow prior to sending it queries. See the training documentation.
Parameters | |
---|---|
Name | Description |
request |
CreatePageRequest The request to send to the server. |
headers |
Metadata The initial metadata to send with the call. This parameter is optional. |
deadline |
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 |
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 | |
---|---|
Name | Description |
request |
CreatePageRequest The request to send to the server. |
options |
CallOptions The options for the call. |
Returns | |
---|---|
Type | Description |
AsyncUnaryCallPage |
The call object. |
CreatePageAsync(CreatePageRequest, Metadata, DateTime?, CancellationToken)
public virtual AsyncUnaryCall<Page> CreatePageAsync(CreatePageRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)
Creates a page in the specified flow.
Note: You should always train a flow prior to sending it queries. See the training documentation.
Parameters | |
---|---|
Name | Description |
request |
CreatePageRequest The request to send to the server. |
headers |
Metadata The initial metadata to send with the call. This parameter is optional. |
deadline |
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 |
AsyncUnaryCallPage |
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 | |
---|---|
Name | Description |
request |
DeletePageRequest The request to send to the server. |
options |
CallOptions The options for the call. |
Returns | |
---|---|
Type | Description |
Empty |
The response received from the server. |
DeletePage(DeletePageRequest, Metadata, DateTime?, CancellationToken)
public virtual Empty DeletePage(DeletePageRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)
Deletes the specified page.
Note: You should always train a flow prior to sending it queries. See the training documentation.
Parameters | |
---|---|
Name | Description |
request |
DeletePageRequest The request to send to the server. |
headers |
Metadata The initial metadata to send with the call. This parameter is optional. |
deadline |
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. |
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 | |
---|---|
Name | Description |
request |
DeletePageRequest The request to send to the server. |
options |
CallOptions The options for the call. |
Returns | |
---|---|
Type | Description |
AsyncUnaryCallEmpty |
The call object. |
DeletePageAsync(DeletePageRequest, Metadata, DateTime?, CancellationToken)
public virtual AsyncUnaryCall<Empty> DeletePageAsync(DeletePageRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)
Deletes the specified page.
Note: You should always train a flow prior to sending it queries. See the training documentation.
Parameters | |
---|---|
Name | Description |
request |
DeletePageRequest The request to send to the server. |
headers |
Metadata The initial metadata to send with the call. This parameter is optional. |
deadline |
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. |
GetPage(GetPageRequest, CallOptions)
public virtual Page GetPage(GetPageRequest request, CallOptions options)
Retrieves the specified page.
Parameters | |
---|---|
Name | Description |
request |
GetPageRequest The request to send to the server. |
options |
CallOptions The options for the call. |
Returns | |
---|---|
Type | Description |
Page |
The response received from the server. |
GetPage(GetPageRequest, Metadata, DateTime?, CancellationToken)
public virtual Page GetPage(GetPageRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)
Retrieves the specified page.
Parameters | |
---|---|
Name | Description |
request |
GetPageRequest The request to send to the server. |
headers |
Metadata The initial metadata to send with the call. This parameter is optional. |
deadline |
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 |
Page |
The response received from the server. |
GetPageAsync(GetPageRequest, CallOptions)
public virtual AsyncUnaryCall<Page> GetPageAsync(GetPageRequest request, CallOptions options)
Retrieves the specified page.
Parameters | |
---|---|
Name | Description |
request |
GetPageRequest The request to send to the server. |
options |
CallOptions The options for the call. |
Returns | |
---|---|
Type | Description |
AsyncUnaryCallPage |
The call object. |
GetPageAsync(GetPageRequest, Metadata, DateTime?, CancellationToken)
public virtual AsyncUnaryCall<Page> GetPageAsync(GetPageRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)
Retrieves the specified page.
Parameters | |
---|---|
Name | Description |
request |
GetPageRequest The request to send to the server. |
headers |
Metadata The initial metadata to send with the call. This parameter is optional. |
deadline |
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 |
AsyncUnaryCallPage |
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 | |
---|---|
Name | Description |
request |
ListPagesRequest The request to send to the server. |
options |
CallOptions The options for the call. |
Returns | |
---|---|
Type | Description |
ListPagesResponse |
The response received from the server. |
ListPages(ListPagesRequest, Metadata, DateTime?, CancellationToken)
public virtual ListPagesResponse ListPages(ListPagesRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)
Returns the list of all pages in the specified flow.
Parameters | |
---|---|
Name | Description |
request |
ListPagesRequest The request to send to the server. |
headers |
Metadata The initial metadata to send with the call. This parameter is optional. |
deadline |
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 |
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 | |
---|---|
Name | Description |
request |
ListPagesRequest The request to send to the server. |
options |
CallOptions The options for the call. |
Returns | |
---|---|
Type | Description |
AsyncUnaryCallListPagesResponse |
The call object. |
ListPagesAsync(ListPagesRequest, Metadata, DateTime?, CancellationToken)
public virtual AsyncUnaryCall<ListPagesResponse> ListPagesAsync(ListPagesRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)
Returns the list of all pages in the specified flow.
Parameters | |
---|---|
Name | Description |
request |
ListPagesRequest The request to send to the server. |
headers |
Metadata The initial metadata to send with the call. This parameter is optional. |
deadline |
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 |
AsyncUnaryCallListPagesResponse |
The call object. |
NewInstance(ClientBaseConfiguration)
protected override Pages.PagesClient NewInstance(ClientBase.ClientBaseConfiguration configuration)
Creates a new instance of client from given ClientBaseConfiguration
.
Parameter | |
---|---|
Name | Description |
configuration |
ClientBaseClientBaseConfiguration |
Returns | |
---|---|
Type | Description |
PagesPagesClient |
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 | |
---|---|
Name | Description |
request |
UpdatePageRequest The request to send to the server. |
options |
CallOptions The options for the call. |
Returns | |
---|---|
Type | Description |
Page |
The response received from the server. |
UpdatePage(UpdatePageRequest, Metadata, DateTime?, CancellationToken)
public virtual Page UpdatePage(UpdatePageRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)
Updates the specified page.
Note: You should always train a flow prior to sending it queries. See the training documentation.
Parameters | |
---|---|
Name | Description |
request |
UpdatePageRequest The request to send to the server. |
headers |
Metadata The initial metadata to send with the call. This parameter is optional. |
deadline |
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 |
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 | |
---|---|
Name | Description |
request |
UpdatePageRequest The request to send to the server. |
options |
CallOptions The options for the call. |
Returns | |
---|---|
Type | Description |
AsyncUnaryCallPage |
The call object. |
UpdatePageAsync(UpdatePageRequest, Metadata, DateTime?, CancellationToken)
public virtual AsyncUnaryCall<Page> UpdatePageAsync(UpdatePageRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)
Updates the specified page.
Note: You should always train a flow prior to sending it queries. See the training documentation.
Parameters | |
---|---|
Name | Description |
request |
UpdatePageRequest The request to send to the server. |
headers |
Metadata The initial metadata to send with the call. This parameter is optional. |
deadline |
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 |
AsyncUnaryCallPage |
The call object. |