Class SipTrunksClient (4.60.0)

GitHub RepositoryProduct Reference

Service Description: Service for managing SipTrunks.

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 (SipTrunksClient sipTrunksClient = SipTrunksClient.create()) {
   LocationName parent = LocationName.of("[PROJECT]", "[LOCATION]");
   SipTrunk sipTrunk = SipTrunk.newBuilder().build();
   SipTrunk response = sipTrunksClient.createSipTrunk(parent, sipTrunk);
 }

Note: close() needs to be called on the SipTrunksClient 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

CreateSipTrunk

Creates a SipTrunk for a specified location.

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

  • createSipTrunk(CreateSipTrunkRequest request)

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

  • createSipTrunk(LocationName parent, SipTrunk sipTrunk)

  • createSipTrunk(String parent, SipTrunk sipTrunk)

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

  • createSipTrunkCallable()

DeleteSipTrunk

Deletes a specified SipTrunk.

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

  • deleteSipTrunk(DeleteSipTrunkRequest request)

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

  • deleteSipTrunk(SipTrunkName name)

  • deleteSipTrunk(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.

  • deleteSipTrunkCallable()

ListSipTrunks

Returns a list of SipTrunks in the specified location.

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

  • listSipTrunks(ListSipTrunksRequest request)

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

  • listSipTrunks(LocationName parent)

  • listSipTrunks(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.

  • listSipTrunksPagedCallable()

  • listSipTrunksCallable()

GetSipTrunk

Retrieves the specified SipTrunk.

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

  • getSipTrunk(GetSipTrunkRequest request)

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

  • getSipTrunk(SipTrunkName name)

  • getSipTrunk(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.

  • getSipTrunkCallable()

UpdateSipTrunk

Updates the specified SipTrunk.

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

  • updateSipTrunk(UpdateSipTrunkRequest request)

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

  • updateSipTrunk(SipTrunk sipTrunk, 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.

  • updateSipTrunkCallable()

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 SipTrunksSettings 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
 SipTrunksSettings sipTrunksSettings =
     SipTrunksSettings.newBuilder()
         .setCredentialsProvider(FixedCredentialsProvider.create(myCredentials))
         .build();
 SipTrunksClient sipTrunksClient = SipTrunksClient.create(sipTrunksSettings);

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
 SipTrunksSettings sipTrunksSettings =
     SipTrunksSettings.newBuilder().setEndpoint(myEndpoint).build();
 SipTrunksClient sipTrunksClient = SipTrunksClient.create(sipTrunksSettings);

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
 SipTrunksSettings sipTrunksSettings = SipTrunksSettings.newHttpJsonBuilder().build();
 SipTrunksClient sipTrunksClient = SipTrunksClient.create(sipTrunksSettings);

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

Inheritance

java.lang.Object > SipTrunksClient

Static Methods

create()

public static final SipTrunksClient create()

Constructs an instance of SipTrunksClient with default settings.

Returns
Type Description
SipTrunksClient
Exceptions
Type Description
IOException

create(SipTrunksSettings settings)

public static final SipTrunksClient create(SipTrunksSettings settings)

Constructs an instance of SipTrunksClient, 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 SipTrunksSettings
Returns
Type Description
SipTrunksClient
Exceptions
Type Description
IOException

create(SipTrunksStub stub)

public static final SipTrunksClient create(SipTrunksStub stub)

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

Parameter
Name Description
stub SipTrunksStub
Returns
Type Description
SipTrunksClient

Constructors

SipTrunksClient(SipTrunksSettings settings)

protected SipTrunksClient(SipTrunksSettings settings)

Constructs an instance of SipTrunksClient, 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 SipTrunksSettings

SipTrunksClient(SipTrunksStub stub)

protected SipTrunksClient(SipTrunksStub stub)
Parameter
Name Description
stub SipTrunksStub

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()

createSipTrunk(CreateSipTrunkRequest request)

public final SipTrunk createSipTrunk(CreateSipTrunkRequest request)

Creates a SipTrunk for a specified 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 (SipTrunksClient sipTrunksClient = SipTrunksClient.create()) {
   CreateSipTrunkRequest request =
       CreateSipTrunkRequest.newBuilder()
           .setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
           .setSipTrunk(SipTrunk.newBuilder().build())
           .build();
   SipTrunk response = sipTrunksClient.createSipTrunk(request);
 }
Parameter
Name Description
request CreateSipTrunkRequest

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

createSipTrunk(LocationName parent, SipTrunk sipTrunk)

public final SipTrunk createSipTrunk(LocationName parent, SipTrunk sipTrunk)

Creates a SipTrunk for a specified 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 (SipTrunksClient sipTrunksClient = SipTrunksClient.create()) {
   LocationName parent = LocationName.of("[PROJECT]", "[LOCATION]");
   SipTrunk sipTrunk = SipTrunk.newBuilder().build();
   SipTrunk response = sipTrunksClient.createSipTrunk(parent, sipTrunk);
 }
Parameters
Name Description
parent LocationName

Required. The location to create a SIP trunk for. Format: projects/<Project ID>/locations/<Location ID>.
sipTrunk SipTrunk

Required. The SIP trunk to create.
Returns
Type Description
SipTrunk

createSipTrunk(String parent, SipTrunk sipTrunk)

public final SipTrunk createSipTrunk(String parent, SipTrunk sipTrunk)

Creates a SipTrunk for a specified 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 (SipTrunksClient sipTrunksClient = SipTrunksClient.create()) {
   String parent = LocationName.of("[PROJECT]", "[LOCATION]").toString();
   SipTrunk sipTrunk = SipTrunk.newBuilder().build();
   SipTrunk response = sipTrunksClient.createSipTrunk(parent, sipTrunk);
 }
Parameters
Name Description
parent String

Required. The location to create a SIP trunk for. Format: projects/<Project ID>/locations/<Location ID>.
sipTrunk SipTrunk

Required. The SIP trunk to create.
Returns
Type Description
SipTrunk

createSipTrunkCallable()

public final UnaryCallable<CreateSipTrunkRequest,SipTrunk> createSipTrunkCallable()

Creates a SipTrunk for a specified 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 (SipTrunksClient sipTrunksClient = SipTrunksClient.create()) {
   CreateSipTrunkRequest request =
       CreateSipTrunkRequest.newBuilder()
           .setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
           .setSipTrunk(SipTrunk.newBuilder().build())
           .build();
   ApiFuture<SipTrunk> future = sipTrunksClient.createSipTrunkCallable().futureCall(request);
   // Do something.
   SipTrunk response = future.get();
 }
Returns
Type Description
UnaryCallable<CreateSipTrunkRequest,SipTrunk>

deleteSipTrunk(DeleteSipTrunkRequest request)

public final void deleteSipTrunk(DeleteSipTrunkRequest request)

Deletes a specified SipTrunk.

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 (SipTrunksClient sipTrunksClient = SipTrunksClient.create()) {
   DeleteSipTrunkRequest request =
       DeleteSipTrunkRequest.newBuilder()
           .setName(SipTrunkName.of("[PROJECT]", "[LOCATION]", "[SIPTRUNK]").toString())
           .build();
   sipTrunksClient.deleteSipTrunk(request);
 }
Parameter
Name Description
request DeleteSipTrunkRequest

The request object containing all of the parameters for the API call.

deleteSipTrunk(SipTrunkName name)

public final void deleteSipTrunk(SipTrunkName name)

Deletes a specified SipTrunk.

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 (SipTrunksClient sipTrunksClient = SipTrunksClient.create()) {
   SipTrunkName name = SipTrunkName.of("[PROJECT]", "[LOCATION]", "[SIPTRUNK]");
   sipTrunksClient.deleteSipTrunk(name);
 }
Parameter
Name Description
name SipTrunkName

Required. The name of the SIP trunk to delete. Format: projects/<Project ID>/locations/<Location ID>/sipTrunks/<SipTrunk ID>.

deleteSipTrunk(String name)

public final void deleteSipTrunk(String name)

Deletes a specified SipTrunk.

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 (SipTrunksClient sipTrunksClient = SipTrunksClient.create()) {
   String name = SipTrunkName.of("[PROJECT]", "[LOCATION]", "[SIPTRUNK]").toString();
   sipTrunksClient.deleteSipTrunk(name);
 }
Parameter
Name Description
name String

Required. The name of the SIP trunk to delete. Format: projects/<Project ID>/locations/<Location ID>/sipTrunks/<SipTrunk ID>.

deleteSipTrunkCallable()

public final UnaryCallable<DeleteSipTrunkRequest,Empty> deleteSipTrunkCallable()

Deletes a specified SipTrunk.

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 (SipTrunksClient sipTrunksClient = SipTrunksClient.create()) {
   DeleteSipTrunkRequest request =
       DeleteSipTrunkRequest.newBuilder()
           .setName(SipTrunkName.of("[PROJECT]", "[LOCATION]", "[SIPTRUNK]").toString())
           .build();
   ApiFuture<Empty> future = sipTrunksClient.deleteSipTrunkCallable().futureCall(request);
   // Do something.
   future.get();
 }
Returns
Type Description
UnaryCallable<DeleteSipTrunkRequest,Empty>

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 (SipTrunksClient sipTrunksClient = SipTrunksClient.create()) {
   GetLocationRequest request = GetLocationRequest.newBuilder().setName("name3373707").build();
   Location response = sipTrunksClient.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 (SipTrunksClient sipTrunksClient = SipTrunksClient.create()) {
   GetLocationRequest request = GetLocationRequest.newBuilder().setName("name3373707").build();
   ApiFuture<Location> future = sipTrunksClient.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 SipTrunksSettings getSettings()
Returns
Type Description
SipTrunksSettings

getSipTrunk(GetSipTrunkRequest request)

public final SipTrunk getSipTrunk(GetSipTrunkRequest request)

Retrieves the specified SipTrunk.

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 (SipTrunksClient sipTrunksClient = SipTrunksClient.create()) {
   GetSipTrunkRequest request =
       GetSipTrunkRequest.newBuilder()
           .setName(SipTrunkName.of("[PROJECT]", "[LOCATION]", "[SIPTRUNK]").toString())
           .build();
   SipTrunk response = sipTrunksClient.getSipTrunk(request);
 }
Parameter
Name Description
request GetSipTrunkRequest

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

getSipTrunk(SipTrunkName name)

public final SipTrunk getSipTrunk(SipTrunkName name)

Retrieves the specified SipTrunk.

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 (SipTrunksClient sipTrunksClient = SipTrunksClient.create()) {
   SipTrunkName name = SipTrunkName.of("[PROJECT]", "[LOCATION]", "[SIPTRUNK]");
   SipTrunk response = sipTrunksClient.getSipTrunk(name);
 }
Parameter
Name Description
name SipTrunkName

Required. The name of the SIP trunk to delete. Format: projects/<Project ID>/locations/<Location ID>/sipTrunks/<SipTrunk ID>.
Returns
Type Description
SipTrunk

getSipTrunk(String name)

public final SipTrunk getSipTrunk(String name)

Retrieves the specified SipTrunk.

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 (SipTrunksClient sipTrunksClient = SipTrunksClient.create()) {
   String name = SipTrunkName.of("[PROJECT]", "[LOCATION]", "[SIPTRUNK]").toString();
   SipTrunk response = sipTrunksClient.getSipTrunk(name);
 }
Parameter
Name Description
name String

Required. The name of the SIP trunk to delete. Format: projects/<Project ID>/locations/<Location ID>/sipTrunks/<SipTrunk ID>.
Returns
Type Description
SipTrunk

getSipTrunkCallable()

public final UnaryCallable<GetSipTrunkRequest,SipTrunk> getSipTrunkCallable()

Retrieves the specified SipTrunk.

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 (SipTrunksClient sipTrunksClient = SipTrunksClient.create()) {
   GetSipTrunkRequest request =
       GetSipTrunkRequest.newBuilder()
           .setName(SipTrunkName.of("[PROJECT]", "[LOCATION]", "[SIPTRUNK]").toString())
           .build();
   ApiFuture<SipTrunk> future = sipTrunksClient.getSipTrunkCallable().futureCall(request);
   // Do something.
   SipTrunk response = future.get();
 }
Returns
Type Description
UnaryCallable<GetSipTrunkRequest,SipTrunk>

getStub()

public SipTrunksStub getStub()
Returns
Type Description
SipTrunksStub

isShutdown()

public boolean isShutdown()
Returns
Type Description
boolean

isTerminated()

public boolean isTerminated()
Returns
Type Description
boolean

listLocations(ListLocationsRequest request)

public final SipTrunksClient.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 (SipTrunksClient sipTrunksClient = SipTrunksClient.create()) {
   ListLocationsRequest request =
       ListLocationsRequest.newBuilder()
           .setName("name3373707")
           .setFilter("filter-1274492040")
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .build();
   for (Location element : sipTrunksClient.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
SipTrunksClient.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 (SipTrunksClient sipTrunksClient = SipTrunksClient.create()) {
   ListLocationsRequest request =
       ListLocationsRequest.newBuilder()
           .setName("name3373707")
           .setFilter("filter-1274492040")
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .build();
   while (true) {
     ListLocationsResponse response = sipTrunksClient.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,SipTrunksClient.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 (SipTrunksClient sipTrunksClient = SipTrunksClient.create()) {
   ListLocationsRequest request =
       ListLocationsRequest.newBuilder()
           .setName("name3373707")
           .setFilter("filter-1274492040")
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .build();
   ApiFuture<Location> future = sipTrunksClient.listLocationsPagedCallable().futureCall(request);
   // Do something.
   for (Location element : future.get().iterateAll()) {
     // doThingsWith(element);
   }
 }
Returns
Type Description
UnaryCallable<com.google.cloud.location.ListLocationsRequest,ListLocationsPagedResponse>

listSipTrunks(ListSipTrunksRequest request)

public final SipTrunksClient.ListSipTrunksPagedResponse listSipTrunks(ListSipTrunksRequest request)

Returns a list of SipTrunks in the specified 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 (SipTrunksClient sipTrunksClient = SipTrunksClient.create()) {
   ListSipTrunksRequest request =
       ListSipTrunksRequest.newBuilder()
           .setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .build();
   for (SipTrunk element : sipTrunksClient.listSipTrunks(request).iterateAll()) {
     // doThingsWith(element);
   }
 }
Parameter
Name Description
request ListSipTrunksRequest

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

listSipTrunks(LocationName parent)

public final SipTrunksClient.ListSipTrunksPagedResponse listSipTrunks(LocationName parent)

Returns a list of SipTrunks in the specified 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 (SipTrunksClient sipTrunksClient = SipTrunksClient.create()) {
   LocationName parent = LocationName.of("[PROJECT]", "[LOCATION]");
   for (SipTrunk element : sipTrunksClient.listSipTrunks(parent).iterateAll()) {
     // doThingsWith(element);
   }
 }
Parameter
Name Description
parent LocationName

Required. The location to list SIP trunks from. Format: projects/<Project ID>/locations/<Location ID>.
Returns
Type Description
SipTrunksClient.ListSipTrunksPagedResponse

listSipTrunks(String parent)

public final SipTrunksClient.ListSipTrunksPagedResponse listSipTrunks(String parent)

Returns a list of SipTrunks in the specified 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 (SipTrunksClient sipTrunksClient = SipTrunksClient.create()) {
   String parent = LocationName.of("[PROJECT]", "[LOCATION]").toString();
   for (SipTrunk element : sipTrunksClient.listSipTrunks(parent).iterateAll()) {
     // doThingsWith(element);
   }
 }
Parameter
Name Description
parent String

Required. The location to list SIP trunks from. Format: projects/<Project ID>/locations/<Location ID>.
Returns
Type Description
SipTrunksClient.ListSipTrunksPagedResponse

listSipTrunksCallable()

public final UnaryCallable<ListSipTrunksRequest,ListSipTrunksResponse> listSipTrunksCallable()

Returns a list of SipTrunks in the specified 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 (SipTrunksClient sipTrunksClient = SipTrunksClient.create()) {
   ListSipTrunksRequest request =
       ListSipTrunksRequest.newBuilder()
           .setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .build();
   while (true) {
     ListSipTrunksResponse response = sipTrunksClient.listSipTrunksCallable().call(request);
     for (SipTrunk element : response.getSipTrunksList()) {
       // doThingsWith(element);
     }
     String nextPageToken = response.getNextPageToken();
     if (!Strings.isNullOrEmpty(nextPageToken)) {
       request = request.toBuilder().setPageToken(nextPageToken).build();
     } else {
       break;
     }
   }
 }
Returns
Type Description
UnaryCallable<ListSipTrunksRequest,ListSipTrunksResponse>

listSipTrunksPagedCallable()

public final UnaryCallable<ListSipTrunksRequest,SipTrunksClient.ListSipTrunksPagedResponse> listSipTrunksPagedCallable()

Returns a list of SipTrunks in the specified 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 (SipTrunksClient sipTrunksClient = SipTrunksClient.create()) {
   ListSipTrunksRequest request =
       ListSipTrunksRequest.newBuilder()
           .setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .build();
   ApiFuture<SipTrunk> future = sipTrunksClient.listSipTrunksPagedCallable().futureCall(request);
   // Do something.
   for (SipTrunk element : future.get().iterateAll()) {
     // doThingsWith(element);
   }
 }
Returns
Type Description
UnaryCallable<ListSipTrunksRequest,ListSipTrunksPagedResponse>

shutdown()

public void shutdown()

shutdownNow()

public void shutdownNow()

updateSipTrunk(SipTrunk sipTrunk, FieldMask updateMask)

public final SipTrunk updateSipTrunk(SipTrunk sipTrunk, FieldMask updateMask)

Updates the specified SipTrunk.

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 (SipTrunksClient sipTrunksClient = SipTrunksClient.create()) {
   SipTrunk sipTrunk = SipTrunk.newBuilder().build();
   FieldMask updateMask = FieldMask.newBuilder().build();
   SipTrunk response = sipTrunksClient.updateSipTrunk(sipTrunk, updateMask);
 }
Parameters
Name Description
sipTrunk SipTrunk

Required. The SipTrunk to update.
updateMask FieldMask

Optional. The mask to control which fields get updated. If the mask is not present, all fields will be updated.
Returns
Type Description
SipTrunk

updateSipTrunk(UpdateSipTrunkRequest request)

public final SipTrunk updateSipTrunk(UpdateSipTrunkRequest request)

Updates the specified SipTrunk.

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 (SipTrunksClient sipTrunksClient = SipTrunksClient.create()) {
   UpdateSipTrunkRequest request =
       UpdateSipTrunkRequest.newBuilder()
           .setSipTrunk(SipTrunk.newBuilder().build())
           .setUpdateMask(FieldMask.newBuilder().build())
           .build();
   SipTrunk response = sipTrunksClient.updateSipTrunk(request);
 }
Parameter
Name Description
request UpdateSipTrunkRequest

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

updateSipTrunkCallable()

public final UnaryCallable<UpdateSipTrunkRequest,SipTrunk> updateSipTrunkCallable()

Updates the specified SipTrunk.

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 (SipTrunksClient sipTrunksClient = SipTrunksClient.create()) {
   UpdateSipTrunkRequest request =
       UpdateSipTrunkRequest.newBuilder()
           .setSipTrunk(SipTrunk.newBuilder().build())
           .setUpdateMask(FieldMask.newBuilder().build())
           .build();
   ApiFuture<SipTrunk> future = sipTrunksClient.updateSipTrunkCallable().futureCall(request);
   // Do something.
   SipTrunk response = future.get();
 }
Returns
Type Description
UnaryCallable<UpdateSipTrunkRequest,SipTrunk>