public abstract class PhoneNumbersClient
Reference documentation and code samples for the Google Cloud Dialogflow v2beta1 API class PhoneNumbersClient.
PhoneNumbers client wrapper, for convenient use.
Derived Types
Namespace
Google.Cloud.Dialogflow.V2Beta1Assembly
Google.Cloud.Dialogflow.V2Beta1.dll
Remarks
Service for managing [PhoneNumbers][google.cloud.dialogflow.v2beta1.PhoneNumber].
Properties
DefaultEndpoint
public static string DefaultEndpoint { get; }
The default endpoint for the PhoneNumbers service, which is a host of "dialogflow.googleapis.com" and a port of 443.
Property Value | |
---|---|
Type | Description |
string |
DefaultScopes
public static IReadOnlyList<string> DefaultScopes { get; }
The default PhoneNumbers scopes.
Property Value | |
---|---|
Type | Description |
IReadOnlyListstring |
The default PhoneNumbers scopes are:
GrpcClient
public virtual PhoneNumbers.PhoneNumbersClient GrpcClient { get; }
The underlying gRPC PhoneNumbers client
Property Value | |
---|---|
Type | Description |
PhoneNumbersPhoneNumbersClient |
LocationsClient
public virtual LocationsClient LocationsClient { get; }
The LocationsClient associated with this client.
Property Value | |
---|---|
Type | Description |
LocationsClient |
ServiceMetadata
public static ServiceMetadata ServiceMetadata { get; }
The service metadata associated with this client type.
Property Value | |
---|---|
Type | Description |
ServiceMetadata |
Methods
Create()
public static PhoneNumbersClient Create()
Synchronously creates a PhoneNumbersClient using the default credentials, endpoint and settings. To specify custom credentials or other settings, use PhoneNumbersClientBuilder.
Returns | |
---|---|
Type | Description |
PhoneNumbersClient |
The created PhoneNumbersClient. |
CreateAsync(CancellationToken)
public static Task<PhoneNumbersClient> CreateAsync(CancellationToken cancellationToken = default)
Asynchronously creates a PhoneNumbersClient using the default credentials, endpoint and settings. To specify custom credentials or other settings, use PhoneNumbersClientBuilder.
Parameter | |
---|---|
Name | Description |
cancellationToken |
CancellationToken The CancellationToken to use while creating the client. |
Returns | |
---|---|
Type | Description |
TaskPhoneNumbersClient |
The task representing the created PhoneNumbersClient. |
DeletePhoneNumber(DeletePhoneNumberRequest, CallSettings)
public virtual PhoneNumber DeletePhoneNumber(DeletePhoneNumberRequest request, CallSettings callSettings = null)
Requests deletion of a PhoneNumber
. The PhoneNumber
is moved into the
[DELETE_REQUESTED][google.cloud.dialogflow.v2beta1.PhoneNumber.LifecycleState.DELETE_REQUESTED]
state immediately, and is deleted approximately 30 days later. This method
may only be called on a PhoneNumber
in the
[ACTIVE][google.cloud.dialogflow.v2beta1.PhoneNumber.LifecycleState.ACTIVE]
state.
Parameters | |
---|---|
Name | Description |
request |
DeletePhoneNumberRequest The request object containing all of the parameters for the API call. |
callSettings |
CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
PhoneNumber |
The RPC response. |
// Create client
PhoneNumbersClient phoneNumbersClient = PhoneNumbersClient.Create();
// Initialize request argument(s)
DeletePhoneNumberRequest request = new DeletePhoneNumberRequest
{
PhoneNumberName = PhoneNumberName.FromProjectPhoneNumber("[PROJECT]", "[PHONE_NUMBER]"),
};
// Make the request
PhoneNumber response = phoneNumbersClient.DeletePhoneNumber(request);
DeletePhoneNumber(PhoneNumberName, CallSettings)
public virtual PhoneNumber DeletePhoneNumber(PhoneNumberName name, CallSettings callSettings = null)
Requests deletion of a PhoneNumber
. The PhoneNumber
is moved into the
[DELETE_REQUESTED][google.cloud.dialogflow.v2beta1.PhoneNumber.LifecycleState.DELETE_REQUESTED]
state immediately, and is deleted approximately 30 days later. This method
may only be called on a PhoneNumber
in the
[ACTIVE][google.cloud.dialogflow.v2beta1.PhoneNumber.LifecycleState.ACTIVE]
state.
Parameters | |
---|---|
Name | Description |
name |
PhoneNumberName Required. The unique identifier of the |
callSettings |
CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
PhoneNumber |
The RPC response. |
// Create client
PhoneNumbersClient phoneNumbersClient = PhoneNumbersClient.Create();
// Initialize request argument(s)
PhoneNumberName name = PhoneNumberName.FromProjectPhoneNumber("[PROJECT]", "[PHONE_NUMBER]");
// Make the request
PhoneNumber response = phoneNumbersClient.DeletePhoneNumber(name);
DeletePhoneNumber(string, CallSettings)
public virtual PhoneNumber DeletePhoneNumber(string name, CallSettings callSettings = null)
Requests deletion of a PhoneNumber
. The PhoneNumber
is moved into the
[DELETE_REQUESTED][google.cloud.dialogflow.v2beta1.PhoneNumber.LifecycleState.DELETE_REQUESTED]
state immediately, and is deleted approximately 30 days later. This method
may only be called on a PhoneNumber
in the
[ACTIVE][google.cloud.dialogflow.v2beta1.PhoneNumber.LifecycleState.ACTIVE]
state.
Parameters | |
---|---|
Name | Description |
name |
string Required. The unique identifier of the |
callSettings |
CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
PhoneNumber |
The RPC response. |
// Create client
PhoneNumbersClient phoneNumbersClient = PhoneNumbersClient.Create();
// Initialize request argument(s)
string name = "projects/[PROJECT]/phoneNumbers/[PHONE_NUMBER]";
// Make the request
PhoneNumber response = phoneNumbersClient.DeletePhoneNumber(name);
DeletePhoneNumberAsync(DeletePhoneNumberRequest, CallSettings)
public virtual Task<PhoneNumber> DeletePhoneNumberAsync(DeletePhoneNumberRequest request, CallSettings callSettings = null)
Requests deletion of a PhoneNumber
. The PhoneNumber
is moved into the
[DELETE_REQUESTED][google.cloud.dialogflow.v2beta1.PhoneNumber.LifecycleState.DELETE_REQUESTED]
state immediately, and is deleted approximately 30 days later. This method
may only be called on a PhoneNumber
in the
[ACTIVE][google.cloud.dialogflow.v2beta1.PhoneNumber.LifecycleState.ACTIVE]
state.
Parameters | |
---|---|
Name | Description |
request |
DeletePhoneNumberRequest The request object containing all of the parameters for the API call. |
callSettings |
CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
TaskPhoneNumber |
A Task containing the RPC response. |
// Create client
PhoneNumbersClient phoneNumbersClient = await PhoneNumbersClient.CreateAsync();
// Initialize request argument(s)
DeletePhoneNumberRequest request = new DeletePhoneNumberRequest
{
PhoneNumberName = PhoneNumberName.FromProjectPhoneNumber("[PROJECT]", "[PHONE_NUMBER]"),
};
// Make the request
PhoneNumber response = await phoneNumbersClient.DeletePhoneNumberAsync(request);
DeletePhoneNumberAsync(DeletePhoneNumberRequest, CancellationToken)
public virtual Task<PhoneNumber> DeletePhoneNumberAsync(DeletePhoneNumberRequest request, CancellationToken cancellationToken)
Requests deletion of a PhoneNumber
. The PhoneNumber
is moved into the
[DELETE_REQUESTED][google.cloud.dialogflow.v2beta1.PhoneNumber.LifecycleState.DELETE_REQUESTED]
state immediately, and is deleted approximately 30 days later. This method
may only be called on a PhoneNumber
in the
[ACTIVE][google.cloud.dialogflow.v2beta1.PhoneNumber.LifecycleState.ACTIVE]
state.
Parameters | |
---|---|
Name | Description |
request |
DeletePhoneNumberRequest The request object containing all of the parameters for the API call. |
cancellationToken |
CancellationToken A CancellationToken to use for this RPC. |
Returns | |
---|---|
Type | Description |
TaskPhoneNumber |
A Task containing the RPC response. |
// Create client
PhoneNumbersClient phoneNumbersClient = await PhoneNumbersClient.CreateAsync();
// Initialize request argument(s)
DeletePhoneNumberRequest request = new DeletePhoneNumberRequest
{
PhoneNumberName = PhoneNumberName.FromProjectPhoneNumber("[PROJECT]", "[PHONE_NUMBER]"),
};
// Make the request
PhoneNumber response = await phoneNumbersClient.DeletePhoneNumberAsync(request);
DeletePhoneNumberAsync(PhoneNumberName, CallSettings)
public virtual Task<PhoneNumber> DeletePhoneNumberAsync(PhoneNumberName name, CallSettings callSettings = null)
Requests deletion of a PhoneNumber
. The PhoneNumber
is moved into the
[DELETE_REQUESTED][google.cloud.dialogflow.v2beta1.PhoneNumber.LifecycleState.DELETE_REQUESTED]
state immediately, and is deleted approximately 30 days later. This method
may only be called on a PhoneNumber
in the
[ACTIVE][google.cloud.dialogflow.v2beta1.PhoneNumber.LifecycleState.ACTIVE]
state.
Parameters | |
---|---|
Name | Description |
name |
PhoneNumberName Required. The unique identifier of the |
callSettings |
CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
TaskPhoneNumber |
A Task containing the RPC response. |
// Create client
PhoneNumbersClient phoneNumbersClient = await PhoneNumbersClient.CreateAsync();
// Initialize request argument(s)
PhoneNumberName name = PhoneNumberName.FromProjectPhoneNumber("[PROJECT]", "[PHONE_NUMBER]");
// Make the request
PhoneNumber response = await phoneNumbersClient.DeletePhoneNumberAsync(name);
DeletePhoneNumberAsync(PhoneNumberName, CancellationToken)
public virtual Task<PhoneNumber> DeletePhoneNumberAsync(PhoneNumberName name, CancellationToken cancellationToken)
Requests deletion of a PhoneNumber
. The PhoneNumber
is moved into the
[DELETE_REQUESTED][google.cloud.dialogflow.v2beta1.PhoneNumber.LifecycleState.DELETE_REQUESTED]
state immediately, and is deleted approximately 30 days later. This method
may only be called on a PhoneNumber
in the
[ACTIVE][google.cloud.dialogflow.v2beta1.PhoneNumber.LifecycleState.ACTIVE]
state.
Parameters | |
---|---|
Name | Description |
name |
PhoneNumberName Required. The unique identifier of the |
cancellationToken |
CancellationToken A CancellationToken to use for this RPC. |
Returns | |
---|---|
Type | Description |
TaskPhoneNumber |
A Task containing the RPC response. |
// Create client
PhoneNumbersClient phoneNumbersClient = await PhoneNumbersClient.CreateAsync();
// Initialize request argument(s)
PhoneNumberName name = PhoneNumberName.FromProjectPhoneNumber("[PROJECT]", "[PHONE_NUMBER]");
// Make the request
PhoneNumber response = await phoneNumbersClient.DeletePhoneNumberAsync(name);
DeletePhoneNumberAsync(string, CallSettings)
public virtual Task<PhoneNumber> DeletePhoneNumberAsync(string name, CallSettings callSettings = null)
Requests deletion of a PhoneNumber
. The PhoneNumber
is moved into the
[DELETE_REQUESTED][google.cloud.dialogflow.v2beta1.PhoneNumber.LifecycleState.DELETE_REQUESTED]
state immediately, and is deleted approximately 30 days later. This method
may only be called on a PhoneNumber
in the
[ACTIVE][google.cloud.dialogflow.v2beta1.PhoneNumber.LifecycleState.ACTIVE]
state.
Parameters | |
---|---|
Name | Description |
name |
string Required. The unique identifier of the |
callSettings |
CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
TaskPhoneNumber |
A Task containing the RPC response. |
// Create client
PhoneNumbersClient phoneNumbersClient = await PhoneNumbersClient.CreateAsync();
// Initialize request argument(s)
string name = "projects/[PROJECT]/phoneNumbers/[PHONE_NUMBER]";
// Make the request
PhoneNumber response = await phoneNumbersClient.DeletePhoneNumberAsync(name);
DeletePhoneNumberAsync(string, CancellationToken)
public virtual Task<PhoneNumber> DeletePhoneNumberAsync(string name, CancellationToken cancellationToken)
Requests deletion of a PhoneNumber
. The PhoneNumber
is moved into the
[DELETE_REQUESTED][google.cloud.dialogflow.v2beta1.PhoneNumber.LifecycleState.DELETE_REQUESTED]
state immediately, and is deleted approximately 30 days later. This method
may only be called on a PhoneNumber
in the
[ACTIVE][google.cloud.dialogflow.v2beta1.PhoneNumber.LifecycleState.ACTIVE]
state.
Parameters | |
---|---|
Name | Description |
name |
string Required. The unique identifier of the |
cancellationToken |
CancellationToken A CancellationToken to use for this RPC. |
Returns | |
---|---|
Type | Description |
TaskPhoneNumber |
A Task containing the RPC response. |
// Create client
PhoneNumbersClient phoneNumbersClient = await PhoneNumbersClient.CreateAsync();
// Initialize request argument(s)
string name = "projects/[PROJECT]/phoneNumbers/[PHONE_NUMBER]";
// Make the request
PhoneNumber response = await phoneNumbersClient.DeletePhoneNumberAsync(name);
ListPhoneNumbers(LocationName, string, int?, CallSettings)
public virtual PagedEnumerable<ListPhoneNumbersResponse, PhoneNumber> ListPhoneNumbers(LocationName parent, string pageToken = null, int? pageSize = null, CallSettings callSettings = null)
Returns the list of all phone numbers in the specified project.
Parameters | |
---|---|
Name | Description |
parent |
LocationName Required. The project to list all |
pageToken |
string The token returned from the previous request. A value of |
pageSize |
int The size of page to request. The response will not be larger than this, but may be smaller. A value of
|
callSettings |
CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
PagedEnumerableListPhoneNumbersResponsePhoneNumber |
A pageable sequence of PhoneNumber resources. |
// Create client
PhoneNumbersClient phoneNumbersClient = PhoneNumbersClient.Create();
// Initialize request argument(s)
LocationName parent = LocationName.FromProjectLocation("[PROJECT]", "[LOCATION]");
// Make the request
PagedEnumerable<ListPhoneNumbersResponse, PhoneNumber> response = phoneNumbersClient.ListPhoneNumbers(parent);
// Iterate over all response items, lazily performing RPCs as required
foreach (PhoneNumber 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 (ListPhoneNumbersResponse page in response.AsRawResponses())
{
// Do something with each page of items
Console.WriteLine("A page of results:");
foreach (PhoneNumber 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<PhoneNumber> 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 (PhoneNumber 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;
ListPhoneNumbers(ProjectName, string, int?, CallSettings)
public virtual PagedEnumerable<ListPhoneNumbersResponse, PhoneNumber> ListPhoneNumbers(ProjectName parent, string pageToken = null, int? pageSize = null, CallSettings callSettings = null)
Returns the list of all phone numbers in the specified project.
Parameters | |
---|---|
Name | Description |
parent |
ProjectName Required. The project to list all |
pageToken |
string The token returned from the previous request. A value of |
pageSize |
int The size of page to request. The response will not be larger than this, but may be smaller. A value of
|
callSettings |
CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
PagedEnumerableListPhoneNumbersResponsePhoneNumber |
A pageable sequence of PhoneNumber resources. |
// Create client
PhoneNumbersClient phoneNumbersClient = PhoneNumbersClient.Create();
// Initialize request argument(s)
ProjectName parent = ProjectName.FromProject("[PROJECT]");
// Make the request
PagedEnumerable<ListPhoneNumbersResponse, PhoneNumber> response = phoneNumbersClient.ListPhoneNumbers(parent);
// Iterate over all response items, lazily performing RPCs as required
foreach (PhoneNumber 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 (ListPhoneNumbersResponse page in response.AsRawResponses())
{
// Do something with each page of items
Console.WriteLine("A page of results:");
foreach (PhoneNumber 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<PhoneNumber> 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 (PhoneNumber 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;
ListPhoneNumbers(ListPhoneNumbersRequest, CallSettings)
public virtual PagedEnumerable<ListPhoneNumbersResponse, PhoneNumber> ListPhoneNumbers(ListPhoneNumbersRequest request, CallSettings callSettings = null)
Returns the list of all phone numbers in the specified project.
Parameters | |
---|---|
Name | Description |
request |
ListPhoneNumbersRequest The request object containing all of the parameters for the API call. |
callSettings |
CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
PagedEnumerableListPhoneNumbersResponsePhoneNumber |
A pageable sequence of PhoneNumber resources. |
// Create client
PhoneNumbersClient phoneNumbersClient = PhoneNumbersClient.Create();
// Initialize request argument(s)
ListPhoneNumbersRequest request = new ListPhoneNumbersRequest
{
ParentAsProjectName = ProjectName.FromProject("[PROJECT]"),
ShowDeleted = false,
};
// Make the request
PagedEnumerable<ListPhoneNumbersResponse, PhoneNumber> response = phoneNumbersClient.ListPhoneNumbers(request);
// Iterate over all response items, lazily performing RPCs as required
foreach (PhoneNumber 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 (ListPhoneNumbersResponse page in response.AsRawResponses())
{
// Do something with each page of items
Console.WriteLine("A page of results:");
foreach (PhoneNumber 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<PhoneNumber> 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 (PhoneNumber 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;
ListPhoneNumbers(string, string, int?, CallSettings)
public virtual PagedEnumerable<ListPhoneNumbersResponse, PhoneNumber> ListPhoneNumbers(string parent, string pageToken = null, int? pageSize = null, CallSettings callSettings = null)
Returns the list of all phone numbers in the specified project.
Parameters | |
---|---|
Name | Description |
parent |
string Required. The project to list all |
pageToken |
string The token returned from the previous request. A value of |
pageSize |
int The size of page to request. The response will not be larger than this, but may be smaller. A value of
|
callSettings |
CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
PagedEnumerableListPhoneNumbersResponsePhoneNumber |
A pageable sequence of PhoneNumber resources. |
// Create client
PhoneNumbersClient phoneNumbersClient = PhoneNumbersClient.Create();
// Initialize request argument(s)
string parent = "projects/[PROJECT]";
// Make the request
PagedEnumerable<ListPhoneNumbersResponse, PhoneNumber> response = phoneNumbersClient.ListPhoneNumbers(parent);
// Iterate over all response items, lazily performing RPCs as required
foreach (PhoneNumber 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 (ListPhoneNumbersResponse page in response.AsRawResponses())
{
// Do something with each page of items
Console.WriteLine("A page of results:");
foreach (PhoneNumber 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<PhoneNumber> 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 (PhoneNumber 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;
ListPhoneNumbersAsync(LocationName, string, int?, CallSettings)
public virtual PagedAsyncEnumerable<ListPhoneNumbersResponse, PhoneNumber> ListPhoneNumbersAsync(LocationName parent, string pageToken = null, int? pageSize = null, CallSettings callSettings = null)
Returns the list of all phone numbers in the specified project.
Parameters | |
---|---|
Name | Description |
parent |
LocationName Required. The project to list all |
pageToken |
string The token returned from the previous request. A value of |
pageSize |
int The size of page to request. The response will not be larger than this, but may be smaller. A value of
|
callSettings |
CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
PagedAsyncEnumerableListPhoneNumbersResponsePhoneNumber |
A pageable asynchronous sequence of PhoneNumber resources. |
// Create client
PhoneNumbersClient phoneNumbersClient = await PhoneNumbersClient.CreateAsync();
// Initialize request argument(s)
LocationName parent = LocationName.FromProjectLocation("[PROJECT]", "[LOCATION]");
// Make the request
PagedAsyncEnumerable<ListPhoneNumbersResponse, PhoneNumber> response = phoneNumbersClient.ListPhoneNumbersAsync(parent);
// Iterate over all response items, lazily performing RPCs as required
await response.ForEachAsync((PhoneNumber 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((ListPhoneNumbersResponse page) =>
{
// Do something with each page of items
Console.WriteLine("A page of results:");
foreach (PhoneNumber 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<PhoneNumber> 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 (PhoneNumber 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;
ListPhoneNumbersAsync(ProjectName, string, int?, CallSettings)
public virtual PagedAsyncEnumerable<ListPhoneNumbersResponse, PhoneNumber> ListPhoneNumbersAsync(ProjectName parent, string pageToken = null, int? pageSize = null, CallSettings callSettings = null)
Returns the list of all phone numbers in the specified project.
Parameters | |
---|---|
Name | Description |
parent |
ProjectName Required. The project to list all |
pageToken |
string The token returned from the previous request. A value of |
pageSize |
int The size of page to request. The response will not be larger than this, but may be smaller. A value of
|
callSettings |
CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
PagedAsyncEnumerableListPhoneNumbersResponsePhoneNumber |
A pageable asynchronous sequence of PhoneNumber resources. |
// Create client
PhoneNumbersClient phoneNumbersClient = await PhoneNumbersClient.CreateAsync();
// Initialize request argument(s)
ProjectName parent = ProjectName.FromProject("[PROJECT]");
// Make the request
PagedAsyncEnumerable<ListPhoneNumbersResponse, PhoneNumber> response = phoneNumbersClient.ListPhoneNumbersAsync(parent);
// Iterate over all response items, lazily performing RPCs as required
await response.ForEachAsync((PhoneNumber 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((ListPhoneNumbersResponse page) =>
{
// Do something with each page of items
Console.WriteLine("A page of results:");
foreach (PhoneNumber 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<PhoneNumber> 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 (PhoneNumber 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;
ListPhoneNumbersAsync(ListPhoneNumbersRequest, CallSettings)
public virtual PagedAsyncEnumerable<ListPhoneNumbersResponse, PhoneNumber> ListPhoneNumbersAsync(ListPhoneNumbersRequest request, CallSettings callSettings = null)
Returns the list of all phone numbers in the specified project.
Parameters | |
---|---|
Name | Description |
request |
ListPhoneNumbersRequest The request object containing all of the parameters for the API call. |
callSettings |
CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
PagedAsyncEnumerableListPhoneNumbersResponsePhoneNumber |
A pageable asynchronous sequence of PhoneNumber resources. |
// Create client
PhoneNumbersClient phoneNumbersClient = await PhoneNumbersClient.CreateAsync();
// Initialize request argument(s)
ListPhoneNumbersRequest request = new ListPhoneNumbersRequest
{
ParentAsProjectName = ProjectName.FromProject("[PROJECT]"),
ShowDeleted = false,
};
// Make the request
PagedAsyncEnumerable<ListPhoneNumbersResponse, PhoneNumber> response = phoneNumbersClient.ListPhoneNumbersAsync(request);
// Iterate over all response items, lazily performing RPCs as required
await response.ForEachAsync((PhoneNumber 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((ListPhoneNumbersResponse page) =>
{
// Do something with each page of items
Console.WriteLine("A page of results:");
foreach (PhoneNumber 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<PhoneNumber> 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 (PhoneNumber 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;
ListPhoneNumbersAsync(string, string, int?, CallSettings)
public virtual PagedAsyncEnumerable<ListPhoneNumbersResponse, PhoneNumber> ListPhoneNumbersAsync(string parent, string pageToken = null, int? pageSize = null, CallSettings callSettings = null)
Returns the list of all phone numbers in the specified project.
Parameters | |
---|---|
Name | Description |
parent |
string Required. The project to list all |
pageToken |
string The token returned from the previous request. A value of |
pageSize |
int The size of page to request. The response will not be larger than this, but may be smaller. A value of
|
callSettings |
CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
PagedAsyncEnumerableListPhoneNumbersResponsePhoneNumber |
A pageable asynchronous sequence of PhoneNumber resources. |
// Create client
PhoneNumbersClient phoneNumbersClient = await PhoneNumbersClient.CreateAsync();
// Initialize request argument(s)
string parent = "projects/[PROJECT]";
// Make the request
PagedAsyncEnumerable<ListPhoneNumbersResponse, PhoneNumber> response = phoneNumbersClient.ListPhoneNumbersAsync(parent);
// Iterate over all response items, lazily performing RPCs as required
await response.ForEachAsync((PhoneNumber 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((ListPhoneNumbersResponse page) =>
{
// Do something with each page of items
Console.WriteLine("A page of results:");
foreach (PhoneNumber 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<PhoneNumber> 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 (PhoneNumber 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 | |
---|---|
Type | Description |
Task |
A task representing the asynchronous shutdown operation. |
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.
UndeletePhoneNumber(PhoneNumberName, CallSettings)
public virtual PhoneNumber UndeletePhoneNumber(PhoneNumberName name, CallSettings callSettings = null)
Cancels the deletion request for a PhoneNumber
. This method may only be
called on a PhoneNumber
in the
[DELETE_REQUESTED][google.cloud.dialogflow.v2beta1.PhoneNumber.LifecycleState.DELETE_REQUESTED]
state.
Parameters | |
---|---|
Name | Description |
name |
PhoneNumberName Required. The unique identifier of the |
callSettings |
CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
PhoneNumber |
The RPC response. |
// Create client
PhoneNumbersClient phoneNumbersClient = PhoneNumbersClient.Create();
// Initialize request argument(s)
PhoneNumberName name = PhoneNumberName.FromProjectPhoneNumber("[PROJECT]", "[PHONE_NUMBER]");
// Make the request
PhoneNumber response = phoneNumbersClient.UndeletePhoneNumber(name);
UndeletePhoneNumber(UndeletePhoneNumberRequest, CallSettings)
public virtual PhoneNumber UndeletePhoneNumber(UndeletePhoneNumberRequest request, CallSettings callSettings = null)
Cancels the deletion request for a PhoneNumber
. This method may only be
called on a PhoneNumber
in the
[DELETE_REQUESTED][google.cloud.dialogflow.v2beta1.PhoneNumber.LifecycleState.DELETE_REQUESTED]
state.
Parameters | |
---|---|
Name | Description |
request |
UndeletePhoneNumberRequest The request object containing all of the parameters for the API call. |
callSettings |
CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
PhoneNumber |
The RPC response. |
// Create client
PhoneNumbersClient phoneNumbersClient = PhoneNumbersClient.Create();
// Initialize request argument(s)
UndeletePhoneNumberRequest request = new UndeletePhoneNumberRequest
{
PhoneNumberName = PhoneNumberName.FromProjectPhoneNumber("[PROJECT]", "[PHONE_NUMBER]"),
};
// Make the request
PhoneNumber response = phoneNumbersClient.UndeletePhoneNumber(request);
UndeletePhoneNumber(string, CallSettings)
public virtual PhoneNumber UndeletePhoneNumber(string name, CallSettings callSettings = null)
Cancels the deletion request for a PhoneNumber
. This method may only be
called on a PhoneNumber
in the
[DELETE_REQUESTED][google.cloud.dialogflow.v2beta1.PhoneNumber.LifecycleState.DELETE_REQUESTED]
state.
Parameters | |
---|---|
Name | Description |
name |
string Required. The unique identifier of the |
callSettings |
CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
PhoneNumber |
The RPC response. |
// Create client
PhoneNumbersClient phoneNumbersClient = PhoneNumbersClient.Create();
// Initialize request argument(s)
string name = "projects/[PROJECT]/phoneNumbers/[PHONE_NUMBER]";
// Make the request
PhoneNumber response = phoneNumbersClient.UndeletePhoneNumber(name);
UndeletePhoneNumberAsync(PhoneNumberName, CallSettings)
public virtual Task<PhoneNumber> UndeletePhoneNumberAsync(PhoneNumberName name, CallSettings callSettings = null)
Cancels the deletion request for a PhoneNumber
. This method may only be
called on a PhoneNumber
in the
[DELETE_REQUESTED][google.cloud.dialogflow.v2beta1.PhoneNumber.LifecycleState.DELETE_REQUESTED]
state.
Parameters | |
---|---|
Name | Description |
name |
PhoneNumberName Required. The unique identifier of the |
callSettings |
CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
TaskPhoneNumber |
A Task containing the RPC response. |
// Create client
PhoneNumbersClient phoneNumbersClient = await PhoneNumbersClient.CreateAsync();
// Initialize request argument(s)
PhoneNumberName name = PhoneNumberName.FromProjectPhoneNumber("[PROJECT]", "[PHONE_NUMBER]");
// Make the request
PhoneNumber response = await phoneNumbersClient.UndeletePhoneNumberAsync(name);
UndeletePhoneNumberAsync(PhoneNumberName, CancellationToken)
public virtual Task<PhoneNumber> UndeletePhoneNumberAsync(PhoneNumberName name, CancellationToken cancellationToken)
Cancels the deletion request for a PhoneNumber
. This method may only be
called on a PhoneNumber
in the
[DELETE_REQUESTED][google.cloud.dialogflow.v2beta1.PhoneNumber.LifecycleState.DELETE_REQUESTED]
state.
Parameters | |
---|---|
Name | Description |
name |
PhoneNumberName Required. The unique identifier of the |
cancellationToken |
CancellationToken A CancellationToken to use for this RPC. |
Returns | |
---|---|
Type | Description |
TaskPhoneNumber |
A Task containing the RPC response. |
// Create client
PhoneNumbersClient phoneNumbersClient = await PhoneNumbersClient.CreateAsync();
// Initialize request argument(s)
PhoneNumberName name = PhoneNumberName.FromProjectPhoneNumber("[PROJECT]", "[PHONE_NUMBER]");
// Make the request
PhoneNumber response = await phoneNumbersClient.UndeletePhoneNumberAsync(name);
UndeletePhoneNumberAsync(UndeletePhoneNumberRequest, CallSettings)
public virtual Task<PhoneNumber> UndeletePhoneNumberAsync(UndeletePhoneNumberRequest request, CallSettings callSettings = null)
Cancels the deletion request for a PhoneNumber
. This method may only be
called on a PhoneNumber
in the
[DELETE_REQUESTED][google.cloud.dialogflow.v2beta1.PhoneNumber.LifecycleState.DELETE_REQUESTED]
state.
Parameters | |
---|---|
Name | Description |
request |
UndeletePhoneNumberRequest The request object containing all of the parameters for the API call. |
callSettings |
CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
TaskPhoneNumber |
A Task containing the RPC response. |
// Create client
PhoneNumbersClient phoneNumbersClient = await PhoneNumbersClient.CreateAsync();
// Initialize request argument(s)
UndeletePhoneNumberRequest request = new UndeletePhoneNumberRequest
{
PhoneNumberName = PhoneNumberName.FromProjectPhoneNumber("[PROJECT]", "[PHONE_NUMBER]"),
};
// Make the request
PhoneNumber response = await phoneNumbersClient.UndeletePhoneNumberAsync(request);
UndeletePhoneNumberAsync(UndeletePhoneNumberRequest, CancellationToken)
public virtual Task<PhoneNumber> UndeletePhoneNumberAsync(UndeletePhoneNumberRequest request, CancellationToken cancellationToken)
Cancels the deletion request for a PhoneNumber
. This method may only be
called on a PhoneNumber
in the
[DELETE_REQUESTED][google.cloud.dialogflow.v2beta1.PhoneNumber.LifecycleState.DELETE_REQUESTED]
state.
Parameters | |
---|---|
Name | Description |
request |
UndeletePhoneNumberRequest The request object containing all of the parameters for the API call. |
cancellationToken |
CancellationToken A CancellationToken to use for this RPC. |
Returns | |
---|---|
Type | Description |
TaskPhoneNumber |
A Task containing the RPC response. |
// Create client
PhoneNumbersClient phoneNumbersClient = await PhoneNumbersClient.CreateAsync();
// Initialize request argument(s)
UndeletePhoneNumberRequest request = new UndeletePhoneNumberRequest
{
PhoneNumberName = PhoneNumberName.FromProjectPhoneNumber("[PROJECT]", "[PHONE_NUMBER]"),
};
// Make the request
PhoneNumber response = await phoneNumbersClient.UndeletePhoneNumberAsync(request);
UndeletePhoneNumberAsync(string, CallSettings)
public virtual Task<PhoneNumber> UndeletePhoneNumberAsync(string name, CallSettings callSettings = null)
Cancels the deletion request for a PhoneNumber
. This method may only be
called on a PhoneNumber
in the
[DELETE_REQUESTED][google.cloud.dialogflow.v2beta1.PhoneNumber.LifecycleState.DELETE_REQUESTED]
state.
Parameters | |
---|---|
Name | Description |
name |
string Required. The unique identifier of the |
callSettings |
CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
TaskPhoneNumber |
A Task containing the RPC response. |
// Create client
PhoneNumbersClient phoneNumbersClient = await PhoneNumbersClient.CreateAsync();
// Initialize request argument(s)
string name = "projects/[PROJECT]/phoneNumbers/[PHONE_NUMBER]";
// Make the request
PhoneNumber response = await phoneNumbersClient.UndeletePhoneNumberAsync(name);
UndeletePhoneNumberAsync(string, CancellationToken)
public virtual Task<PhoneNumber> UndeletePhoneNumberAsync(string name, CancellationToken cancellationToken)
Cancels the deletion request for a PhoneNumber
. This method may only be
called on a PhoneNumber
in the
[DELETE_REQUESTED][google.cloud.dialogflow.v2beta1.PhoneNumber.LifecycleState.DELETE_REQUESTED]
state.
Parameters | |
---|---|
Name | Description |
name |
string Required. The unique identifier of the |
cancellationToken |
CancellationToken A CancellationToken to use for this RPC. |
Returns | |
---|---|
Type | Description |
TaskPhoneNumber |
A Task containing the RPC response. |
// Create client
PhoneNumbersClient phoneNumbersClient = await PhoneNumbersClient.CreateAsync();
// Initialize request argument(s)
string name = "projects/[PROJECT]/phoneNumbers/[PHONE_NUMBER]";
// Make the request
PhoneNumber response = await phoneNumbersClient.UndeletePhoneNumberAsync(name);
UpdatePhoneNumber(PhoneNumber, FieldMask, CallSettings)
public virtual PhoneNumber UpdatePhoneNumber(PhoneNumber phoneNumber, FieldMask updateMask, CallSettings callSettings = null)
Updates the specified PhoneNumber
.
Parameters | |
---|---|
Name | Description |
phoneNumber |
PhoneNumber Required. The |
updateMask |
FieldMask Optional. The mask to control which fields get updated. |
callSettings |
CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
PhoneNumber |
The RPC response. |
// Create client
PhoneNumbersClient phoneNumbersClient = PhoneNumbersClient.Create();
// Initialize request argument(s)
PhoneNumber phoneNumber = new PhoneNumber();
FieldMask updateMask = new FieldMask();
// Make the request
PhoneNumber response = phoneNumbersClient.UpdatePhoneNumber(phoneNumber, updateMask);
UpdatePhoneNumber(UpdatePhoneNumberRequest, CallSettings)
public virtual PhoneNumber UpdatePhoneNumber(UpdatePhoneNumberRequest request, CallSettings callSettings = null)
Updates the specified PhoneNumber
.
Parameters | |
---|---|
Name | Description |
request |
UpdatePhoneNumberRequest The request object containing all of the parameters for the API call. |
callSettings |
CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
PhoneNumber |
The RPC response. |
// Create client
PhoneNumbersClient phoneNumbersClient = PhoneNumbersClient.Create();
// Initialize request argument(s)
UpdatePhoneNumberRequest request = new UpdatePhoneNumberRequest
{
PhoneNumber = new PhoneNumber(),
UpdateMask = new FieldMask(),
};
// Make the request
PhoneNumber response = phoneNumbersClient.UpdatePhoneNumber(request);
UpdatePhoneNumberAsync(PhoneNumber, FieldMask, CallSettings)
public virtual Task<PhoneNumber> UpdatePhoneNumberAsync(PhoneNumber phoneNumber, FieldMask updateMask, CallSettings callSettings = null)
Updates the specified PhoneNumber
.
Parameters | |
---|---|
Name | Description |
phoneNumber |
PhoneNumber Required. The |
updateMask |
FieldMask Optional. The mask to control which fields get updated. |
callSettings |
CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
TaskPhoneNumber |
A Task containing the RPC response. |
// Create client
PhoneNumbersClient phoneNumbersClient = await PhoneNumbersClient.CreateAsync();
// Initialize request argument(s)
PhoneNumber phoneNumber = new PhoneNumber();
FieldMask updateMask = new FieldMask();
// Make the request
PhoneNumber response = await phoneNumbersClient.UpdatePhoneNumberAsync(phoneNumber, updateMask);
UpdatePhoneNumberAsync(PhoneNumber, FieldMask, CancellationToken)
public virtual Task<PhoneNumber> UpdatePhoneNumberAsync(PhoneNumber phoneNumber, FieldMask updateMask, CancellationToken cancellationToken)
Updates the specified PhoneNumber
.
Parameters | |
---|---|
Name | Description |
phoneNumber |
PhoneNumber Required. The |
updateMask |
FieldMask Optional. The mask to control which fields get updated. |
cancellationToken |
CancellationToken A CancellationToken to use for this RPC. |
Returns | |
---|---|
Type | Description |
TaskPhoneNumber |
A Task containing the RPC response. |
// Create client
PhoneNumbersClient phoneNumbersClient = await PhoneNumbersClient.CreateAsync();
// Initialize request argument(s)
PhoneNumber phoneNumber = new PhoneNumber();
FieldMask updateMask = new FieldMask();
// Make the request
PhoneNumber response = await phoneNumbersClient.UpdatePhoneNumberAsync(phoneNumber, updateMask);
UpdatePhoneNumberAsync(UpdatePhoneNumberRequest, CallSettings)
public virtual Task<PhoneNumber> UpdatePhoneNumberAsync(UpdatePhoneNumberRequest request, CallSettings callSettings = null)
Updates the specified PhoneNumber
.
Parameters | |
---|---|
Name | Description |
request |
UpdatePhoneNumberRequest The request object containing all of the parameters for the API call. |
callSettings |
CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
TaskPhoneNumber |
A Task containing the RPC response. |
// Create client
PhoneNumbersClient phoneNumbersClient = await PhoneNumbersClient.CreateAsync();
// Initialize request argument(s)
UpdatePhoneNumberRequest request = new UpdatePhoneNumberRequest
{
PhoneNumber = new PhoneNumber(),
UpdateMask = new FieldMask(),
};
// Make the request
PhoneNumber response = await phoneNumbersClient.UpdatePhoneNumberAsync(request);
UpdatePhoneNumberAsync(UpdatePhoneNumberRequest, CancellationToken)
public virtual Task<PhoneNumber> UpdatePhoneNumberAsync(UpdatePhoneNumberRequest request, CancellationToken cancellationToken)
Updates the specified PhoneNumber
.
Parameters | |
---|---|
Name | Description |
request |
UpdatePhoneNumberRequest The request object containing all of the parameters for the API call. |
cancellationToken |
CancellationToken A CancellationToken to use for this RPC. |
Returns | |
---|---|
Type | Description |
TaskPhoneNumber |
A Task containing the RPC response. |
// Create client
PhoneNumbersClient phoneNumbersClient = await PhoneNumbersClient.CreateAsync();
// Initialize request argument(s)
UpdatePhoneNumberRequest request = new UpdatePhoneNumberRequest
{
PhoneNumber = new PhoneNumber(),
UpdateMask = new FieldMask(),
};
// Make the request
PhoneNumber response = await phoneNumbersClient.UpdatePhoneNumberAsync(request);