Class PhoneNumbersClient (4.64.0)

GitHub RepositoryProduct Reference

Service Description: Service for managing PhoneNumbers.

This class provides the ability to make remote calls to the backing service through method calls that map to API methods. Sample code to get started:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (PhoneNumbersClient phoneNumbersClient = PhoneNumbersClient.create()) {
   PhoneNumber phoneNumber = PhoneNumber.newBuilder().build();
   FieldMask updateMask = FieldMask.newBuilder().build();
   PhoneNumber response = phoneNumbersClient.updatePhoneNumber(phoneNumber, updateMask);
 }

Note: close() needs to be called on the PhoneNumbersClient object to clean up resources such as threads. In the example above, try-with-resources is used, which automatically calls close().

Methods
Method Description Method Variants

ListPhoneNumbers

Returns the list of all phone numbers in the specified project.

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • listPhoneNumbers(ListPhoneNumbersRequest request)

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

  • listPhoneNumbers(LocationName parent)

  • listPhoneNumbers(ProjectName parent)

  • listPhoneNumbers(String parent)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • listPhoneNumbersPagedCallable()

  • listPhoneNumbersCallable()

UpdatePhoneNumber

Updates the specified PhoneNumber.

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • updatePhoneNumber(UpdatePhoneNumberRequest request)

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

  • updatePhoneNumber(PhoneNumber phoneNumber, FieldMask updateMask)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • updatePhoneNumberCallable()

DeletePhoneNumber

Requests deletion of a PhoneNumber. The PhoneNumber is moved into the DELETE_REQUESTED state immediately, and is deleted approximately 30 days later. This method may only be called on a PhoneNumber in the ACTIVE state.

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • deletePhoneNumber(DeletePhoneNumberRequest request)

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

  • deletePhoneNumber(PhoneNumberName name)

  • deletePhoneNumber(String name)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • deletePhoneNumberCallable()

UndeletePhoneNumber

Cancels the deletion request for a PhoneNumber. This method may only be called on a PhoneNumber in the DELETE_REQUESTED state.

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • undeletePhoneNumber(UndeletePhoneNumberRequest request)

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

  • undeletePhoneNumber(PhoneNumberName name)

  • undeletePhoneNumber(String name)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • undeletePhoneNumberCallable()

ListLocations

Lists information about the supported locations for this service.

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • listLocations(ListLocationsRequest request)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • listLocationsPagedCallable()

  • listLocationsCallable()

GetLocation

Gets information about a location.

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • getLocation(GetLocationRequest request)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • getLocationCallable()

See the individual methods for example code.

Many parameters require resource names to be formatted in a particular way. To assist with these names, this class includes a format method for each type of name, and additionally a parse method to extract the individual identifiers contained within names that are returned.

This class can be customized by passing in a custom instance of PhoneNumbersSettings to create(). For example:

To customize credentials:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 PhoneNumbersSettings phoneNumbersSettings =
     PhoneNumbersSettings.newBuilder()
         .setCredentialsProvider(FixedCredentialsProvider.create(myCredentials))
         .build();
 PhoneNumbersClient phoneNumbersClient = PhoneNumbersClient.create(phoneNumbersSettings);

To customize the endpoint:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 PhoneNumbersSettings phoneNumbersSettings =
     PhoneNumbersSettings.newBuilder().setEndpoint(myEndpoint).build();
 PhoneNumbersClient phoneNumbersClient = PhoneNumbersClient.create(phoneNumbersSettings);

To use REST (HTTP1.1/JSON) transport (instead of gRPC) for sending and receiving requests over the wire:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 PhoneNumbersSettings phoneNumbersSettings = PhoneNumbersSettings.newHttpJsonBuilder().build();
 PhoneNumbersClient phoneNumbersClient = PhoneNumbersClient.create(phoneNumbersSettings);

Please refer to the GitHub repository's samples for more quickstart code snippets.

Inheritance

java.lang.Object > PhoneNumbersClient

Static Methods

create()

public static final PhoneNumbersClient create()

Constructs an instance of PhoneNumbersClient with default settings.

Returns
Type Description
PhoneNumbersClient
Exceptions
Type Description
IOException

create(PhoneNumbersSettings settings)

public static final PhoneNumbersClient create(PhoneNumbersSettings settings)

Constructs an instance of PhoneNumbersClient, using the given settings. The channels are created based on the settings passed in, or defaults for any settings that are not set.

Parameter
Name Description
settings PhoneNumbersSettings
Returns
Type Description
PhoneNumbersClient
Exceptions
Type Description
IOException

create(PhoneNumbersStub stub)

public static final PhoneNumbersClient create(PhoneNumbersStub stub)

Constructs an instance of PhoneNumbersClient, using the given stub for making calls. This is for advanced usage - prefer using create(PhoneNumbersSettings).

Parameter
Name Description
stub PhoneNumbersStub
Returns
Type Description
PhoneNumbersClient

Constructors

PhoneNumbersClient(PhoneNumbersSettings settings)

protected PhoneNumbersClient(PhoneNumbersSettings settings)

Constructs an instance of PhoneNumbersClient, using the given settings. This is protected so that it is easy to make a subclass, but otherwise, the static factory methods should be preferred.

Parameter
Name Description
settings PhoneNumbersSettings

PhoneNumbersClient(PhoneNumbersStub stub)

protected PhoneNumbersClient(PhoneNumbersStub stub)
Parameter
Name Description
stub PhoneNumbersStub

Methods

awaitTermination(long duration, TimeUnit unit)

public boolean awaitTermination(long duration, TimeUnit unit)
Parameters
Name Description
duration long
unit TimeUnit
Returns
Type Description
boolean
Exceptions
Type Description
InterruptedException

close()

public final void close()

deletePhoneNumber(DeletePhoneNumberRequest request)

public final PhoneNumber deletePhoneNumber(DeletePhoneNumberRequest request)

Requests deletion of a PhoneNumber. The PhoneNumber is moved into the DELETE_REQUESTED state immediately, and is deleted approximately 30 days later. This method may only be called on a PhoneNumber in the ACTIVE state.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (PhoneNumbersClient phoneNumbersClient = PhoneNumbersClient.create()) {
   DeletePhoneNumberRequest request =
       DeletePhoneNumberRequest.newBuilder()
           .setName(
               PhoneNumberName.ofProjectPhoneNumberName("[PROJECT]", "[PHONE_NUMBER]")
                   .toString())
           .build();
   PhoneNumber response = phoneNumbersClient.deletePhoneNumber(request);
 }
Parameter
Name Description
request DeletePhoneNumberRequest

The request object containing all of the parameters for the API call.
Returns
Type Description
PhoneNumber

deletePhoneNumber(PhoneNumberName name)

public final PhoneNumber deletePhoneNumber(PhoneNumberName name)

Requests deletion of a PhoneNumber. The PhoneNumber is moved into the DELETE_REQUESTED state immediately, and is deleted approximately 30 days later. This method may only be called on a PhoneNumber in the ACTIVE state.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (PhoneNumbersClient phoneNumbersClient = PhoneNumbersClient.create()) {
   PhoneNumberName name =
       PhoneNumberName.ofProjectPhoneNumberName("[PROJECT]", "[PHONE_NUMBER]");
   PhoneNumber response = phoneNumbersClient.deletePhoneNumber(name);
 }
Parameter
Name Description
name PhoneNumberName

Required. The unique identifier of the PhoneNumber to delete. Format: projects/<Project ID>/phoneNumbers/<PhoneNumber ID>. Format: projects/<Project ID>/locations/<Location ID>/phoneNumbers/<PhoneNumber ID>.
Returns
Type Description
PhoneNumber

deletePhoneNumber(String name)

public final PhoneNumber deletePhoneNumber(String name)

Requests deletion of a PhoneNumber. The PhoneNumber is moved into the DELETE_REQUESTED state immediately, and is deleted approximately 30 days later. This method may only be called on a PhoneNumber in the ACTIVE state.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (PhoneNumbersClient phoneNumbersClient = PhoneNumbersClient.create()) {
   String name =
       PhoneNumberName.ofProjectPhoneNumberName("[PROJECT]", "[PHONE_NUMBER]").toString();
   PhoneNumber response = phoneNumbersClient.deletePhoneNumber(name);
 }
Parameter
Name Description
name String

Required. The unique identifier of the PhoneNumber to delete. Format: projects/<Project ID>/phoneNumbers/<PhoneNumber ID>. Format: projects/<Project ID>/locations/<Location ID>/phoneNumbers/<PhoneNumber ID>.
Returns
Type Description
PhoneNumber

deletePhoneNumberCallable()

public final UnaryCallable<DeletePhoneNumberRequest,PhoneNumber> deletePhoneNumberCallable()

Requests deletion of a PhoneNumber. The PhoneNumber is moved into the DELETE_REQUESTED state immediately, and is deleted approximately 30 days later. This method may only be called on a PhoneNumber in the ACTIVE state.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (PhoneNumbersClient phoneNumbersClient = PhoneNumbersClient.create()) {
   DeletePhoneNumberRequest request =
       DeletePhoneNumberRequest.newBuilder()
           .setName(
               PhoneNumberName.ofProjectPhoneNumberName("[PROJECT]", "[PHONE_NUMBER]")
                   .toString())
           .build();
   ApiFuture<PhoneNumber> future =
       phoneNumbersClient.deletePhoneNumberCallable().futureCall(request);
   // Do something.
   PhoneNumber response = future.get();
 }
Returns
Type Description
UnaryCallable<DeletePhoneNumberRequest,PhoneNumber>

getLocation(GetLocationRequest request)

public final Location getLocation(GetLocationRequest request)

Gets information about a location.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (PhoneNumbersClient phoneNumbersClient = PhoneNumbersClient.create()) {
   GetLocationRequest request = GetLocationRequest.newBuilder().setName("name3373707").build();
   Location response = phoneNumbersClient.getLocation(request);
 }
Parameter
Name Description
request com.google.cloud.location.GetLocationRequest

The request object containing all of the parameters for the API call.
Returns
Type Description
com.google.cloud.location.Location

getLocationCallable()

public final UnaryCallable<GetLocationRequest,Location> getLocationCallable()

Gets information about a location.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (PhoneNumbersClient phoneNumbersClient = PhoneNumbersClient.create()) {
   GetLocationRequest request = GetLocationRequest.newBuilder().setName("name3373707").build();
   ApiFuture<Location> future = phoneNumbersClient.getLocationCallable().futureCall(request);
   // Do something.
   Location response = future.get();
 }
Returns
Type Description
UnaryCallable<com.google.cloud.location.GetLocationRequest,com.google.cloud.location.Location>

getSettings()

public final PhoneNumbersSettings getSettings()
Returns
Type Description
PhoneNumbersSettings

getStub()

public PhoneNumbersStub getStub()
Returns
Type Description
PhoneNumbersStub

isShutdown()

public boolean isShutdown()
Returns
Type Description
boolean

isTerminated()

public boolean isTerminated()
Returns
Type Description
boolean

listLocations(ListLocationsRequest request)

public final PhoneNumbersClient.ListLocationsPagedResponse listLocations(ListLocationsRequest request)

Lists information about the supported locations for this service.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (PhoneNumbersClient phoneNumbersClient = PhoneNumbersClient.create()) {
   ListLocationsRequest request =
       ListLocationsRequest.newBuilder()
           .setName("name3373707")
           .setFilter("filter-1274492040")
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .build();
   for (Location element : phoneNumbersClient.listLocations(request).iterateAll()) {
     // doThingsWith(element);
   }
 }
Parameter
Name Description
request com.google.cloud.location.ListLocationsRequest

The request object containing all of the parameters for the API call.
Returns
Type Description
PhoneNumbersClient.ListLocationsPagedResponse

listLocationsCallable()

public final UnaryCallable<ListLocationsRequest,ListLocationsResponse> listLocationsCallable()

Lists information about the supported locations for this service.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (PhoneNumbersClient phoneNumbersClient = PhoneNumbersClient.create()) {
   ListLocationsRequest request =
       ListLocationsRequest.newBuilder()
           .setName("name3373707")
           .setFilter("filter-1274492040")
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .build();
   while (true) {
     ListLocationsResponse response = phoneNumbersClient.listLocationsCallable().call(request);
     for (Location element : response.getLocationsList()) {
       // doThingsWith(element);
     }
     String nextPageToken = response.getNextPageToken();
     if (!Strings.isNullOrEmpty(nextPageToken)) {
       request = request.toBuilder().setPageToken(nextPageToken).build();
     } else {
       break;
     }
   }
 }
Returns
Type Description
UnaryCallable<com.google.cloud.location.ListLocationsRequest,com.google.cloud.location.ListLocationsResponse>

listLocationsPagedCallable()

public final UnaryCallable<ListLocationsRequest,PhoneNumbersClient.ListLocationsPagedResponse> listLocationsPagedCallable()

Lists information about the supported locations for this service.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (PhoneNumbersClient phoneNumbersClient = PhoneNumbersClient.create()) {
   ListLocationsRequest request =
       ListLocationsRequest.newBuilder()
           .setName("name3373707")
           .setFilter("filter-1274492040")
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .build();
   ApiFuture<Location> future =
       phoneNumbersClient.listLocationsPagedCallable().futureCall(request);
   // Do something.
   for (Location element : future.get().iterateAll()) {
     // doThingsWith(element);
   }
 }
Returns
Type Description
UnaryCallable<com.google.cloud.location.ListLocationsRequest,ListLocationsPagedResponse>

listPhoneNumbers(ListPhoneNumbersRequest request)

public final PhoneNumbersClient.ListPhoneNumbersPagedResponse listPhoneNumbers(ListPhoneNumbersRequest request)

Returns the list of all phone numbers in the specified project.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (PhoneNumbersClient phoneNumbersClient = PhoneNumbersClient.create()) {
   ListPhoneNumbersRequest request =
       ListPhoneNumbersRequest.newBuilder()
           .setParent(ProjectName.of("[PROJECT]").toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .setShowDeleted(true)
           .build();
   for (PhoneNumber element : phoneNumbersClient.listPhoneNumbers(request).iterateAll()) {
     // doThingsWith(element);
   }
 }
Parameter
Name Description
request ListPhoneNumbersRequest

The request object containing all of the parameters for the API call.
Returns
Type Description
PhoneNumbersClient.ListPhoneNumbersPagedResponse

listPhoneNumbers(LocationName parent)

public final PhoneNumbersClient.ListPhoneNumbersPagedResponse listPhoneNumbers(LocationName parent)

Returns the list of all phone numbers in the specified project.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (PhoneNumbersClient phoneNumbersClient = PhoneNumbersClient.create()) {
   LocationName parent = LocationName.of("[PROJECT]", "[LOCATION]");
   for (PhoneNumber element : phoneNumbersClient.listPhoneNumbers(parent).iterateAll()) {
     // doThingsWith(element);
   }
 }
Parameter
Name Description
parent LocationName

Required. The project to list all PhoneNumber resources from. Format: projects/<Project ID>. Format: projects/<Project ID>/locations/<Location ID>.
Returns
Type Description
PhoneNumbersClient.ListPhoneNumbersPagedResponse

listPhoneNumbers(ProjectName parent)

public final PhoneNumbersClient.ListPhoneNumbersPagedResponse listPhoneNumbers(ProjectName parent)

Returns the list of all phone numbers in the specified project.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (PhoneNumbersClient phoneNumbersClient = PhoneNumbersClient.create()) {
   ProjectName parent = ProjectName.of("[PROJECT]");
   for (PhoneNumber element : phoneNumbersClient.listPhoneNumbers(parent).iterateAll()) {
     // doThingsWith(element);
   }
 }
Parameter
Name Description
parent ProjectName

Required. The project to list all PhoneNumber resources from. Format: projects/<Project ID>. Format: projects/<Project ID>/locations/<Location ID>.
Returns
Type Description
PhoneNumbersClient.ListPhoneNumbersPagedResponse

listPhoneNumbers(String parent)

public final PhoneNumbersClient.ListPhoneNumbersPagedResponse listPhoneNumbers(String parent)

Returns the list of all phone numbers in the specified project.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (PhoneNumbersClient phoneNumbersClient = PhoneNumbersClient.create()) {
   String parent = ProjectName.of("[PROJECT]").toString();
   for (PhoneNumber element : phoneNumbersClient.listPhoneNumbers(parent).iterateAll()) {
     // doThingsWith(element);
   }
 }
Parameter
Name Description
parent String

Required. The project to list all PhoneNumber resources from. Format: projects/<Project ID>. Format: projects/<Project ID>/locations/<Location ID>.
Returns
Type Description
PhoneNumbersClient.ListPhoneNumbersPagedResponse

listPhoneNumbersCallable()

public final UnaryCallable<ListPhoneNumbersRequest,ListPhoneNumbersResponse> listPhoneNumbersCallable()

Returns the list of all phone numbers in the specified project.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (PhoneNumbersClient phoneNumbersClient = PhoneNumbersClient.create()) {
   ListPhoneNumbersRequest request =
       ListPhoneNumbersRequest.newBuilder()
           .setParent(ProjectName.of("[PROJECT]").toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .setShowDeleted(true)
           .build();
   while (true) {
     ListPhoneNumbersResponse response =
         phoneNumbersClient.listPhoneNumbersCallable().call(request);
     for (PhoneNumber element : response.getPhoneNumbersList()) {
       // doThingsWith(element);
     }
     String nextPageToken = response.getNextPageToken();
     if (!Strings.isNullOrEmpty(nextPageToken)) {
       request = request.toBuilder().setPageToken(nextPageToken).build();
     } else {
       break;
     }
   }
 }
Returns
Type Description
UnaryCallable<ListPhoneNumbersRequest,ListPhoneNumbersResponse>

listPhoneNumbersPagedCallable()

public final UnaryCallable<ListPhoneNumbersRequest,PhoneNumbersClient.ListPhoneNumbersPagedResponse> listPhoneNumbersPagedCallable()

Returns the list of all phone numbers in the specified project.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (PhoneNumbersClient phoneNumbersClient = PhoneNumbersClient.create()) {
   ListPhoneNumbersRequest request =
       ListPhoneNumbersRequest.newBuilder()
           .setParent(ProjectName.of("[PROJECT]").toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .setShowDeleted(true)
           .build();
   ApiFuture<PhoneNumber> future =
       phoneNumbersClient.listPhoneNumbersPagedCallable().futureCall(request);
   // Do something.
   for (PhoneNumber element : future.get().iterateAll()) {
     // doThingsWith(element);
   }
 }
Returns
Type Description
UnaryCallable<ListPhoneNumbersRequest,ListPhoneNumbersPagedResponse>

shutdown()

public void shutdown()

shutdownNow()

public void shutdownNow()

undeletePhoneNumber(PhoneNumberName name)

public final PhoneNumber undeletePhoneNumber(PhoneNumberName name)

Cancels the deletion request for a PhoneNumber. This method may only be called on a PhoneNumber in the DELETE_REQUESTED state.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (PhoneNumbersClient phoneNumbersClient = PhoneNumbersClient.create()) {
   PhoneNumberName name =
       PhoneNumberName.ofProjectPhoneNumberName("[PROJECT]", "[PHONE_NUMBER]");
   PhoneNumber response = phoneNumbersClient.undeletePhoneNumber(name);
 }
Parameter
Name Description
name PhoneNumberName

Required. The unique identifier of the PhoneNumber to delete. Format: projects/<Project ID>/phoneNumbers/<PhoneNumber ID>. Format: projects/<Project ID>/locations/<Location ID>/phoneNumbers/<PhoneNumber ID>.
Returns
Type Description
PhoneNumber

undeletePhoneNumber(UndeletePhoneNumberRequest request)

public final PhoneNumber undeletePhoneNumber(UndeletePhoneNumberRequest request)

Cancels the deletion request for a PhoneNumber. This method may only be called on a PhoneNumber in the DELETE_REQUESTED state.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (PhoneNumbersClient phoneNumbersClient = PhoneNumbersClient.create()) {
   UndeletePhoneNumberRequest request =
       UndeletePhoneNumberRequest.newBuilder()
           .setName(
               PhoneNumberName.ofProjectPhoneNumberName("[PROJECT]", "[PHONE_NUMBER]")
                   .toString())
           .build();
   PhoneNumber response = phoneNumbersClient.undeletePhoneNumber(request);
 }
Parameter
Name Description
request UndeletePhoneNumberRequest

The request object containing all of the parameters for the API call.
Returns
Type Description
PhoneNumber

undeletePhoneNumber(String name)

public final PhoneNumber undeletePhoneNumber(String name)

Cancels the deletion request for a PhoneNumber. This method may only be called on a PhoneNumber in the DELETE_REQUESTED state.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (PhoneNumbersClient phoneNumbersClient = PhoneNumbersClient.create()) {
   String name =
       PhoneNumberName.ofProjectPhoneNumberName("[PROJECT]", "[PHONE_NUMBER]").toString();
   PhoneNumber response = phoneNumbersClient.undeletePhoneNumber(name);
 }
Parameter
Name Description
name String

Required. The unique identifier of the PhoneNumber to delete. Format: projects/<Project ID>/phoneNumbers/<PhoneNumber ID>. Format: projects/<Project ID>/locations/<Location ID>/phoneNumbers/<PhoneNumber ID>.
Returns
Type Description
PhoneNumber

undeletePhoneNumberCallable()

public final UnaryCallable<UndeletePhoneNumberRequest,PhoneNumber> undeletePhoneNumberCallable()

Cancels the deletion request for a PhoneNumber. This method may only be called on a PhoneNumber in the DELETE_REQUESTED state.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (PhoneNumbersClient phoneNumbersClient = PhoneNumbersClient.create()) {
   UndeletePhoneNumberRequest request =
       UndeletePhoneNumberRequest.newBuilder()
           .setName(
               PhoneNumberName.ofProjectPhoneNumberName("[PROJECT]", "[PHONE_NUMBER]")
                   .toString())
           .build();
   ApiFuture<PhoneNumber> future =
       phoneNumbersClient.undeletePhoneNumberCallable().futureCall(request);
   // Do something.
   PhoneNumber response = future.get();
 }
Returns
Type Description
UnaryCallable<UndeletePhoneNumberRequest,PhoneNumber>

updatePhoneNumber(PhoneNumber phoneNumber, FieldMask updateMask)

public final PhoneNumber updatePhoneNumber(PhoneNumber phoneNumber, FieldMask updateMask)

Updates the specified PhoneNumber.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (PhoneNumbersClient phoneNumbersClient = PhoneNumbersClient.create()) {
   PhoneNumber phoneNumber = PhoneNumber.newBuilder().build();
   FieldMask updateMask = FieldMask.newBuilder().build();
   PhoneNumber response = phoneNumbersClient.updatePhoneNumber(phoneNumber, updateMask);
 }
Parameters
Name Description
phoneNumber PhoneNumber

Required. The PhoneNumber to update.
updateMask FieldMask

Optional. The mask to control which fields get updated.
Returns
Type Description
PhoneNumber

updatePhoneNumber(UpdatePhoneNumberRequest request)

public final PhoneNumber updatePhoneNumber(UpdatePhoneNumberRequest request)

Updates the specified PhoneNumber.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (PhoneNumbersClient phoneNumbersClient = PhoneNumbersClient.create()) {
   UpdatePhoneNumberRequest request =
       UpdatePhoneNumberRequest.newBuilder()
           .setPhoneNumber(PhoneNumber.newBuilder().build())
           .setUpdateMask(FieldMask.newBuilder().build())
           .build();
   PhoneNumber response = phoneNumbersClient.updatePhoneNumber(request);
 }
Parameter
Name Description
request UpdatePhoneNumberRequest

The request object containing all of the parameters for the API call.
Returns
Type Description
PhoneNumber

updatePhoneNumberCallable()

public final UnaryCallable<UpdatePhoneNumberRequest,PhoneNumber> updatePhoneNumberCallable()

Updates the specified PhoneNumber.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (PhoneNumbersClient phoneNumbersClient = PhoneNumbersClient.create()) {
   UpdatePhoneNumberRequest request =
       UpdatePhoneNumberRequest.newBuilder()
           .setPhoneNumber(PhoneNumber.newBuilder().build())
           .setUpdateMask(FieldMask.newBuilder().build())
           .build();
   ApiFuture<PhoneNumber> future =
       phoneNumbersClient.updatePhoneNumberCallable().futureCall(request);
   // Do something.
   PhoneNumber response = future.get();
 }
Returns
Type Description
UnaryCallable<UpdatePhoneNumberRequest,PhoneNumber>