public class Examples.ExamplesClient : ClientBase<Examples.ExamplesClient>Reference documentation and code samples for the Dialogflow v3 API class Examples.ExamplesClient.
Client for Examples
Namespace
Google.Cloud.Dialogflow.Cx.V3Assembly
Google.Cloud.Dialogflow.Cx.V3.dll
Constructors
ExamplesClient()
protected ExamplesClient()Protected parameterless constructor to allow creation of test doubles.
ExamplesClient(CallInvoker)
public ExamplesClient(CallInvoker callInvoker)Creates a new client for Examples that uses a custom CallInvoker.
| Parameter | |
|---|---|
| Name | Description |
callInvoker |
CallInvokerThe callInvoker to use to make remote calls. |
ExamplesClient(ChannelBase)
public ExamplesClient(ChannelBase channel)Creates a new client for Examples
| Parameter | |
|---|---|
| Name | Description |
channel |
ChannelBaseThe channel to use to make remote calls. |
ExamplesClient(ClientBaseConfiguration)
protected ExamplesClient(ClientBase.ClientBaseConfiguration configuration)Protected constructor to allow creation of configured clients.
| Parameter | |
|---|---|
| Name | Description |
configuration |
ClientBaseClientBaseConfigurationThe client configuration. |
Methods
CreateExample(CreateExampleRequest, CallOptions)
public virtual Example CreateExample(CreateExampleRequest request, CallOptions options)Creates an example in the specified playbook.
| Parameters | |
|---|---|
| Name | Description |
request |
CreateExampleRequestThe request to send to the server. |
options |
CallOptionsThe options for the call. |
| Returns | |
|---|---|
| Type | Description |
Example |
The response received from the server. |
CreateExample(CreateExampleRequest, Metadata, DateTime?, CancellationToken)
public virtual Example CreateExample(CreateExampleRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)Creates an example in the specified playbook.
| Parameters | |
|---|---|
| Name | Description |
request |
CreateExampleRequestThe request to send to the server. |
headers |
MetadataThe initial metadata to send with the call. This parameter is optional. |
deadline |
System.DateTimeAn optional deadline for the call. The call will be cancelled if deadline is hit. |
cancellationToken |
CancellationTokenAn optional token for canceling the call. |
| Returns | |
|---|---|
| Type | Description |
Example |
The response received from the server. |
CreateExampleAsync(CreateExampleRequest, CallOptions)
public virtual AsyncUnaryCall<Example> CreateExampleAsync(CreateExampleRequest request, CallOptions options)Creates an example in the specified playbook.
| Parameters | |
|---|---|
| Name | Description |
request |
CreateExampleRequestThe request to send to the server. |
options |
CallOptionsThe options for the call. |
| Returns | |
|---|---|
| Type | Description |
AsyncUnaryCallExample |
The call object. |
CreateExampleAsync(CreateExampleRequest, Metadata, DateTime?, CancellationToken)
public virtual AsyncUnaryCall<Example> CreateExampleAsync(CreateExampleRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)Creates an example in the specified playbook.
| Parameters | |
|---|---|
| Name | Description |
request |
CreateExampleRequestThe request to send to the server. |
headers |
MetadataThe initial metadata to send with the call. This parameter is optional. |
deadline |
System.DateTimeAn optional deadline for the call. The call will be cancelled if deadline is hit. |
cancellationToken |
CancellationTokenAn optional token for canceling the call. |
| Returns | |
|---|---|
| Type | Description |
AsyncUnaryCallExample |
The call object. |
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. |
DeleteExample(DeleteExampleRequest, CallOptions)
public virtual Empty DeleteExample(DeleteExampleRequest request, CallOptions options)Deletes the specified example.
| Parameters | |
|---|---|
| Name | Description |
request |
DeleteExampleRequestThe request to send to the server. |
options |
CallOptionsThe options for the call. |
| Returns | |
|---|---|
| Type | Description |
Empty |
The response received from the server. |
DeleteExample(DeleteExampleRequest, Metadata, DateTime?, CancellationToken)
public virtual Empty DeleteExample(DeleteExampleRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)Deletes the specified example.
| Parameters | |
|---|---|
| Name | Description |
request |
DeleteExampleRequestThe request to send to the server. |
headers |
MetadataThe initial metadata to send with the call. This parameter is optional. |
deadline |
System.DateTimeAn optional deadline for the call. The call will be cancelled if deadline is hit. |
cancellationToken |
CancellationTokenAn optional token for canceling the call. |
| Returns | |
|---|---|
| Type | Description |
Empty |
The response received from the server. |
DeleteExampleAsync(DeleteExampleRequest, CallOptions)
public virtual AsyncUnaryCall<Empty> DeleteExampleAsync(DeleteExampleRequest request, CallOptions options)Deletes the specified example.
| Parameters | |
|---|---|
| Name | Description |
request |
DeleteExampleRequestThe request to send to the server. |
options |
CallOptionsThe options for the call. |
| Returns | |
|---|---|
| Type | Description |
AsyncUnaryCallEmpty |
The call object. |
DeleteExampleAsync(DeleteExampleRequest, Metadata, DateTime?, CancellationToken)
public virtual AsyncUnaryCall<Empty> DeleteExampleAsync(DeleteExampleRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)Deletes the specified example.
| Parameters | |
|---|---|
| Name | Description |
request |
DeleteExampleRequestThe request to send to the server. |
headers |
MetadataThe initial metadata to send with the call. This parameter is optional. |
deadline |
System.DateTimeAn optional deadline for the call. The call will be cancelled if deadline is hit. |
cancellationToken |
CancellationTokenAn optional token for canceling the call. |
| Returns | |
|---|---|
| Type | Description |
AsyncUnaryCallEmpty |
The call object. |
GetExample(GetExampleRequest, CallOptions)
public virtual Example GetExample(GetExampleRequest request, CallOptions options)Retrieves the specified example.
| Parameters | |
|---|---|
| Name | Description |
request |
GetExampleRequestThe request to send to the server. |
options |
CallOptionsThe options for the call. |
| Returns | |
|---|---|
| Type | Description |
Example |
The response received from the server. |
GetExample(GetExampleRequest, Metadata, DateTime?, CancellationToken)
public virtual Example GetExample(GetExampleRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)Retrieves the specified example.
| Parameters | |
|---|---|
| Name | Description |
request |
GetExampleRequestThe request to send to the server. |
headers |
MetadataThe initial metadata to send with the call. This parameter is optional. |
deadline |
System.DateTimeAn optional deadline for the call. The call will be cancelled if deadline is hit. |
cancellationToken |
CancellationTokenAn optional token for canceling the call. |
| Returns | |
|---|---|
| Type | Description |
Example |
The response received from the server. |
GetExampleAsync(GetExampleRequest, CallOptions)
public virtual AsyncUnaryCall<Example> GetExampleAsync(GetExampleRequest request, CallOptions options)Retrieves the specified example.
| Parameters | |
|---|---|
| Name | Description |
request |
GetExampleRequestThe request to send to the server. |
options |
CallOptionsThe options for the call. |
| Returns | |
|---|---|
| Type | Description |
AsyncUnaryCallExample |
The call object. |
GetExampleAsync(GetExampleRequest, Metadata, DateTime?, CancellationToken)
public virtual AsyncUnaryCall<Example> GetExampleAsync(GetExampleRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)Retrieves the specified example.
| Parameters | |
|---|---|
| Name | Description |
request |
GetExampleRequestThe request to send to the server. |
headers |
MetadataThe initial metadata to send with the call. This parameter is optional. |
deadline |
System.DateTimeAn optional deadline for the call. The call will be cancelled if deadline is hit. |
cancellationToken |
CancellationTokenAn optional token for canceling the call. |
| Returns | |
|---|---|
| Type | Description |
AsyncUnaryCallExample |
The call object. |
ListExamples(ListExamplesRequest, CallOptions)
public virtual ListExamplesResponse ListExamples(ListExamplesRequest request, CallOptions options)Returns a list of examples in the specified playbook.
| Parameters | |
|---|---|
| Name | Description |
request |
ListExamplesRequestThe request to send to the server. |
options |
CallOptionsThe options for the call. |
| Returns | |
|---|---|
| Type | Description |
ListExamplesResponse |
The response received from the server. |
ListExamples(ListExamplesRequest, Metadata, DateTime?, CancellationToken)
public virtual ListExamplesResponse ListExamples(ListExamplesRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)Returns a list of examples in the specified playbook.
| Parameters | |
|---|---|
| Name | Description |
request |
ListExamplesRequestThe request to send to the server. |
headers |
MetadataThe initial metadata to send with the call. This parameter is optional. |
deadline |
System.DateTimeAn optional deadline for the call. The call will be cancelled if deadline is hit. |
cancellationToken |
CancellationTokenAn optional token for canceling the call. |
| Returns | |
|---|---|
| Type | Description |
ListExamplesResponse |
The response received from the server. |
ListExamplesAsync(ListExamplesRequest, CallOptions)
public virtual AsyncUnaryCall<ListExamplesResponse> ListExamplesAsync(ListExamplesRequest request, CallOptions options)Returns a list of examples in the specified playbook.
| Parameters | |
|---|---|
| Name | Description |
request |
ListExamplesRequestThe request to send to the server. |
options |
CallOptionsThe options for the call. |
| Returns | |
|---|---|
| Type | Description |
AsyncUnaryCallListExamplesResponse |
The call object. |
ListExamplesAsync(ListExamplesRequest, Metadata, DateTime?, CancellationToken)
public virtual AsyncUnaryCall<ListExamplesResponse> ListExamplesAsync(ListExamplesRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)Returns a list of examples in the specified playbook.
| Parameters | |
|---|---|
| Name | Description |
request |
ListExamplesRequestThe request to send to the server. |
headers |
MetadataThe initial metadata to send with the call. This parameter is optional. |
deadline |
System.DateTimeAn optional deadline for the call. The call will be cancelled if deadline is hit. |
cancellationToken |
CancellationTokenAn optional token for canceling the call. |
| Returns | |
|---|---|
| Type | Description |
AsyncUnaryCallListExamplesResponse |
The call object. |
NewInstance(ClientBaseConfiguration)
protected override Examples.ExamplesClient NewInstance(ClientBase.ClientBaseConfiguration configuration)Creates a new instance of client from given ClientBaseConfiguration.
| Parameter | |
|---|---|
| Name | Description |
configuration |
ClientBaseClientBaseConfiguration |
| Returns | |
|---|---|
| Type | Description |
ExamplesExamplesClient |
|
UpdateExample(UpdateExampleRequest, CallOptions)
public virtual Example UpdateExample(UpdateExampleRequest request, CallOptions options)Update the specified example.
| Parameters | |
|---|---|
| Name | Description |
request |
UpdateExampleRequestThe request to send to the server. |
options |
CallOptionsThe options for the call. |
| Returns | |
|---|---|
| Type | Description |
Example |
The response received from the server. |
UpdateExample(UpdateExampleRequest, Metadata, DateTime?, CancellationToken)
public virtual Example UpdateExample(UpdateExampleRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)Update the specified example.
| Parameters | |
|---|---|
| Name | Description |
request |
UpdateExampleRequestThe request to send to the server. |
headers |
MetadataThe initial metadata to send with the call. This parameter is optional. |
deadline |
System.DateTimeAn optional deadline for the call. The call will be cancelled if deadline is hit. |
cancellationToken |
CancellationTokenAn optional token for canceling the call. |
| Returns | |
|---|---|
| Type | Description |
Example |
The response received from the server. |
UpdateExampleAsync(UpdateExampleRequest, CallOptions)
public virtual AsyncUnaryCall<Example> UpdateExampleAsync(UpdateExampleRequest request, CallOptions options)Update the specified example.
| Parameters | |
|---|---|
| Name | Description |
request |
UpdateExampleRequestThe request to send to the server. |
options |
CallOptionsThe options for the call. |
| Returns | |
|---|---|
| Type | Description |
AsyncUnaryCallExample |
The call object. |
UpdateExampleAsync(UpdateExampleRequest, Metadata, DateTime?, CancellationToken)
public virtual AsyncUnaryCall<Example> UpdateExampleAsync(UpdateExampleRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)Update the specified example.
| Parameters | |
|---|---|
| Name | Description |
request |
UpdateExampleRequestThe request to send to the server. |
headers |
MetadataThe initial metadata to send with the call. This parameter is optional. |
deadline |
System.DateTimeAn optional deadline for the call. The call will be cancelled if deadline is hit. |
cancellationToken |
CancellationTokenAn optional token for canceling the call. |
| Returns | |
|---|---|
| Type | Description |
AsyncUnaryCallExample |
The call object. |