Class PublicAdvertisedPrefixesClient (1.63.0)

GitHub RepositoryProduct Reference

Service Description: The PublicAdvertisedPrefixes API.

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 (PublicAdvertisedPrefixesClient publicAdvertisedPrefixesClient =
     PublicAdvertisedPrefixesClient.create()) {
   String project = "project-309310695";
   String publicAdvertisedPrefix = "publicAdvertisedPrefix1506440856";
   PublicAdvertisedPrefix response =
       publicAdvertisedPrefixesClient.get(project, publicAdvertisedPrefix);
 }

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

Announce

Announces the specified PublicAdvertisedPrefix

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

  • announceAsync(AnnouncePublicAdvertisedPrefixeRequest request)

Methods that return long-running operations have "Async" method variants that return OperationFuture, which is used to track polling of the service.

  • announceAsync(String project, String publicAdvertisedPrefix)

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

  • announceOperationCallable()

  • announceCallable()

Delete

Deletes the specified PublicAdvertisedPrefix

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

  • deleteAsync(DeletePublicAdvertisedPrefixeRequest request)

Methods that return long-running operations have "Async" method variants that return OperationFuture, which is used to track polling of the service.

  • deleteAsync(String project, String publicAdvertisedPrefix)

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

  • deleteOperationCallable()

  • deleteCallable()

Get

Returns the specified PublicAdvertisedPrefix resource.

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

  • get(GetPublicAdvertisedPrefixeRequest request)

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

  • get(String project, String publicAdvertisedPrefix)

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

  • getCallable()

Insert

Creates a PublicAdvertisedPrefix in the specified project using the parameters that are included in the request.

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

  • insertAsync(InsertPublicAdvertisedPrefixeRequest request)

Methods that return long-running operations have "Async" method variants that return OperationFuture, which is used to track polling of the service.

  • insertAsync(String project, PublicAdvertisedPrefix publicAdvertisedPrefixResource)

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

  • insertOperationCallable()

  • insertCallable()

List

Lists the PublicAdvertisedPrefixes for a project.

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

  • list(ListPublicAdvertisedPrefixesRequest request)

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

  • list(String project)

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

  • listPagedCallable()

  • listCallable()

Patch

Patches the specified Router resource with the data included in the request. This method supports PATCH semantics and uses JSON merge patch format and processing rules.

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

  • patchAsync(PatchPublicAdvertisedPrefixeRequest request)

Methods that return long-running operations have "Async" method variants that return OperationFuture, which is used to track polling of the service.

  • patchAsync(String project, String publicAdvertisedPrefix, PublicAdvertisedPrefix publicAdvertisedPrefixResource)

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

  • patchOperationCallable()

  • patchCallable()

Withdraw

Withdraws the specified PublicAdvertisedPrefix

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

  • withdrawAsync(WithdrawPublicAdvertisedPrefixeRequest request)

Methods that return long-running operations have "Async" method variants that return OperationFuture, which is used to track polling of the service.

  • withdrawAsync(String project, String publicAdvertisedPrefix)

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

  • withdrawOperationCallable()

  • withdrawCallable()

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 PublicAdvertisedPrefixesSettings 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
 PublicAdvertisedPrefixesSettings publicAdvertisedPrefixesSettings =
     PublicAdvertisedPrefixesSettings.newBuilder()
         .setCredentialsProvider(FixedCredentialsProvider.create(myCredentials))
         .build();
 PublicAdvertisedPrefixesClient publicAdvertisedPrefixesClient =
     PublicAdvertisedPrefixesClient.create(publicAdvertisedPrefixesSettings);

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
 PublicAdvertisedPrefixesSettings publicAdvertisedPrefixesSettings =
     PublicAdvertisedPrefixesSettings.newBuilder().setEndpoint(myEndpoint).build();
 PublicAdvertisedPrefixesClient publicAdvertisedPrefixesClient =
     PublicAdvertisedPrefixesClient.create(publicAdvertisedPrefixesSettings);

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

Inheritance

java.lang.Object > PublicAdvertisedPrefixesClient

Static Methods

create()

public static final PublicAdvertisedPrefixesClient create()

Constructs an instance of PublicAdvertisedPrefixesClient with default settings.

Returns
Type Description
PublicAdvertisedPrefixesClient
Exceptions
Type Description
IOException

create(PublicAdvertisedPrefixesSettings settings)

public static final PublicAdvertisedPrefixesClient create(PublicAdvertisedPrefixesSettings settings)

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

create(PublicAdvertisedPrefixesStub stub)

public static final PublicAdvertisedPrefixesClient create(PublicAdvertisedPrefixesStub stub)

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

Parameter
Name Description
stub PublicAdvertisedPrefixesStub
Returns
Type Description
PublicAdvertisedPrefixesClient

Constructors

PublicAdvertisedPrefixesClient(PublicAdvertisedPrefixesSettings settings)

protected PublicAdvertisedPrefixesClient(PublicAdvertisedPrefixesSettings settings)

Constructs an instance of PublicAdvertisedPrefixesClient, 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 PublicAdvertisedPrefixesSettings

PublicAdvertisedPrefixesClient(PublicAdvertisedPrefixesStub stub)

protected PublicAdvertisedPrefixesClient(PublicAdvertisedPrefixesStub stub)
Parameter
Name Description
stub PublicAdvertisedPrefixesStub

Methods

announceAsync(AnnouncePublicAdvertisedPrefixeRequest request)

public final OperationFuture<Operation,Operation> announceAsync(AnnouncePublicAdvertisedPrefixeRequest request)

Announces the specified PublicAdvertisedPrefix

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 (PublicAdvertisedPrefixesClient publicAdvertisedPrefixesClient =
     PublicAdvertisedPrefixesClient.create()) {
   AnnouncePublicAdvertisedPrefixeRequest request =
       AnnouncePublicAdvertisedPrefixeRequest.newBuilder()
           .setProject("project-309310695")
           .setPublicAdvertisedPrefix("publicAdvertisedPrefix1506440856")
           .setRequestId("requestId693933066")
           .build();
   Operation response = publicAdvertisedPrefixesClient.announceAsync(request).get();
 }
Parameter
Name Description
request AnnouncePublicAdvertisedPrefixeRequest

The request object containing all of the parameters for the API call.
Returns
Type Description
OperationFuture<Operation,Operation>

announceAsync(String project, String publicAdvertisedPrefix)

public final OperationFuture<Operation,Operation> announceAsync(String project, String publicAdvertisedPrefix)

Announces the specified PublicAdvertisedPrefix

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 (PublicAdvertisedPrefixesClient publicAdvertisedPrefixesClient =
     PublicAdvertisedPrefixesClient.create()) {
   String project = "project-309310695";
   String publicAdvertisedPrefix = "publicAdvertisedPrefix1506440856";
   Operation response =
       publicAdvertisedPrefixesClient.announceAsync(project, publicAdvertisedPrefix).get();
 }
Parameters
Name Description
project String

Project ID for this request.
publicAdvertisedPrefix String

The name of the public advertised prefix. It should comply with RFC1035.
Returns
Type Description
OperationFuture<Operation,Operation>

announceCallable()

public final UnaryCallable<AnnouncePublicAdvertisedPrefixeRequest,Operation> announceCallable()

Announces the specified PublicAdvertisedPrefix

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 (PublicAdvertisedPrefixesClient publicAdvertisedPrefixesClient =
     PublicAdvertisedPrefixesClient.create()) {
   AnnouncePublicAdvertisedPrefixeRequest request =
       AnnouncePublicAdvertisedPrefixeRequest.newBuilder()
           .setProject("project-309310695")
           .setPublicAdvertisedPrefix("publicAdvertisedPrefix1506440856")
           .setRequestId("requestId693933066")
           .build();
   ApiFuture<Operation> future =
       publicAdvertisedPrefixesClient.announceCallable().futureCall(request);
   // Do something.
   Operation response = future.get();
 }
Returns
Type Description
UnaryCallable<AnnouncePublicAdvertisedPrefixeRequest,Operation>

announceOperationCallable()

public final OperationCallable<AnnouncePublicAdvertisedPrefixeRequest,Operation,Operation> announceOperationCallable()

Announces the specified PublicAdvertisedPrefix

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 (PublicAdvertisedPrefixesClient publicAdvertisedPrefixesClient =
     PublicAdvertisedPrefixesClient.create()) {
   AnnouncePublicAdvertisedPrefixeRequest request =
       AnnouncePublicAdvertisedPrefixeRequest.newBuilder()
           .setProject("project-309310695")
           .setPublicAdvertisedPrefix("publicAdvertisedPrefix1506440856")
           .setRequestId("requestId693933066")
           .build();
   OperationFuture<Operation, Operation> future =
       publicAdvertisedPrefixesClient.announceOperationCallable().futureCall(request);
   // Do something.
   Operation response = future.get();
 }
Returns
Type Description
OperationCallable<AnnouncePublicAdvertisedPrefixeRequest,Operation,Operation>

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

deleteAsync(DeletePublicAdvertisedPrefixeRequest request)

public final OperationFuture<Operation,Operation> deleteAsync(DeletePublicAdvertisedPrefixeRequest request)

Deletes the specified PublicAdvertisedPrefix

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 (PublicAdvertisedPrefixesClient publicAdvertisedPrefixesClient =
     PublicAdvertisedPrefixesClient.create()) {
   DeletePublicAdvertisedPrefixeRequest request =
       DeletePublicAdvertisedPrefixeRequest.newBuilder()
           .setProject("project-309310695")
           .setPublicAdvertisedPrefix("publicAdvertisedPrefix1506440856")
           .setRequestId("requestId693933066")
           .build();
   Operation response = publicAdvertisedPrefixesClient.deleteAsync(request).get();
 }
Parameter
Name Description
request DeletePublicAdvertisedPrefixeRequest

The request object containing all of the parameters for the API call.
Returns
Type Description
OperationFuture<Operation,Operation>

deleteAsync(String project, String publicAdvertisedPrefix)

public final OperationFuture<Operation,Operation> deleteAsync(String project, String publicAdvertisedPrefix)

Deletes the specified PublicAdvertisedPrefix

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 (PublicAdvertisedPrefixesClient publicAdvertisedPrefixesClient =
     PublicAdvertisedPrefixesClient.create()) {
   String project = "project-309310695";
   String publicAdvertisedPrefix = "publicAdvertisedPrefix1506440856";
   Operation response =
       publicAdvertisedPrefixesClient.deleteAsync(project, publicAdvertisedPrefix).get();
 }
Parameters
Name Description
project String

Project ID for this request.
publicAdvertisedPrefix String

Name of the PublicAdvertisedPrefix resource to delete.
Returns
Type Description
OperationFuture<Operation,Operation>

deleteCallable()

public final UnaryCallable<DeletePublicAdvertisedPrefixeRequest,Operation> deleteCallable()

Deletes the specified PublicAdvertisedPrefix

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 (PublicAdvertisedPrefixesClient publicAdvertisedPrefixesClient =
     PublicAdvertisedPrefixesClient.create()) {
   DeletePublicAdvertisedPrefixeRequest request =
       DeletePublicAdvertisedPrefixeRequest.newBuilder()
           .setProject("project-309310695")
           .setPublicAdvertisedPrefix("publicAdvertisedPrefix1506440856")
           .setRequestId("requestId693933066")
           .build();
   ApiFuture<Operation> future =
       publicAdvertisedPrefixesClient.deleteCallable().futureCall(request);
   // Do something.
   Operation response = future.get();
 }
Returns
Type Description
UnaryCallable<DeletePublicAdvertisedPrefixeRequest,Operation>

deleteOperationCallable()

public final OperationCallable<DeletePublicAdvertisedPrefixeRequest,Operation,Operation> deleteOperationCallable()

Deletes the specified PublicAdvertisedPrefix

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 (PublicAdvertisedPrefixesClient publicAdvertisedPrefixesClient =
     PublicAdvertisedPrefixesClient.create()) {
   DeletePublicAdvertisedPrefixeRequest request =
       DeletePublicAdvertisedPrefixeRequest.newBuilder()
           .setProject("project-309310695")
           .setPublicAdvertisedPrefix("publicAdvertisedPrefix1506440856")
           .setRequestId("requestId693933066")
           .build();
   OperationFuture<Operation, Operation> future =
       publicAdvertisedPrefixesClient.deleteOperationCallable().futureCall(request);
   // Do something.
   Operation response = future.get();
 }
Returns
Type Description
OperationCallable<DeletePublicAdvertisedPrefixeRequest,Operation,Operation>

get(GetPublicAdvertisedPrefixeRequest request)

public final PublicAdvertisedPrefix get(GetPublicAdvertisedPrefixeRequest request)

Returns the specified PublicAdvertisedPrefix resource.

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 (PublicAdvertisedPrefixesClient publicAdvertisedPrefixesClient =
     PublicAdvertisedPrefixesClient.create()) {
   GetPublicAdvertisedPrefixeRequest request =
       GetPublicAdvertisedPrefixeRequest.newBuilder()
           .setProject("project-309310695")
           .setPublicAdvertisedPrefix("publicAdvertisedPrefix1506440856")
           .build();
   PublicAdvertisedPrefix response = publicAdvertisedPrefixesClient.get(request);
 }
Parameter
Name Description
request GetPublicAdvertisedPrefixeRequest

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

get(String project, String publicAdvertisedPrefix)

public final PublicAdvertisedPrefix get(String project, String publicAdvertisedPrefix)

Returns the specified PublicAdvertisedPrefix resource.

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 (PublicAdvertisedPrefixesClient publicAdvertisedPrefixesClient =
     PublicAdvertisedPrefixesClient.create()) {
   String project = "project-309310695";
   String publicAdvertisedPrefix = "publicAdvertisedPrefix1506440856";
   PublicAdvertisedPrefix response =
       publicAdvertisedPrefixesClient.get(project, publicAdvertisedPrefix);
 }
Parameters
Name Description
project String

Project ID for this request.
publicAdvertisedPrefix String

Name of the PublicAdvertisedPrefix resource to return.
Returns
Type Description
PublicAdvertisedPrefix

getCallable()

public final UnaryCallable<GetPublicAdvertisedPrefixeRequest,PublicAdvertisedPrefix> getCallable()

Returns the specified PublicAdvertisedPrefix resource.

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 (PublicAdvertisedPrefixesClient publicAdvertisedPrefixesClient =
     PublicAdvertisedPrefixesClient.create()) {
   GetPublicAdvertisedPrefixeRequest request =
       GetPublicAdvertisedPrefixeRequest.newBuilder()
           .setProject("project-309310695")
           .setPublicAdvertisedPrefix("publicAdvertisedPrefix1506440856")
           .build();
   ApiFuture<PublicAdvertisedPrefix> future =
       publicAdvertisedPrefixesClient.getCallable().futureCall(request);
   // Do something.
   PublicAdvertisedPrefix response = future.get();
 }
Returns
Type Description
UnaryCallable<GetPublicAdvertisedPrefixeRequest,PublicAdvertisedPrefix>

getSettings()

public final PublicAdvertisedPrefixesSettings getSettings()
Returns
Type Description
PublicAdvertisedPrefixesSettings

getStub()

public PublicAdvertisedPrefixesStub getStub()
Returns
Type Description
PublicAdvertisedPrefixesStub

insertAsync(InsertPublicAdvertisedPrefixeRequest request)

public final OperationFuture<Operation,Operation> insertAsync(InsertPublicAdvertisedPrefixeRequest request)

Creates a PublicAdvertisedPrefix in the specified project using the parameters that are included in the request.

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 (PublicAdvertisedPrefixesClient publicAdvertisedPrefixesClient =
     PublicAdvertisedPrefixesClient.create()) {
   InsertPublicAdvertisedPrefixeRequest request =
       InsertPublicAdvertisedPrefixeRequest.newBuilder()
           .setProject("project-309310695")
           .setPublicAdvertisedPrefixResource(PublicAdvertisedPrefix.newBuilder().build())
           .setRequestId("requestId693933066")
           .build();
   Operation response = publicAdvertisedPrefixesClient.insertAsync(request).get();
 }
Parameter
Name Description
request InsertPublicAdvertisedPrefixeRequest

The request object containing all of the parameters for the API call.
Returns
Type Description
OperationFuture<Operation,Operation>

insertAsync(String project, PublicAdvertisedPrefix publicAdvertisedPrefixResource)

public final OperationFuture<Operation,Operation> insertAsync(String project, PublicAdvertisedPrefix publicAdvertisedPrefixResource)

Creates a PublicAdvertisedPrefix in the specified project using the parameters that are included in the request.

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 (PublicAdvertisedPrefixesClient publicAdvertisedPrefixesClient =
     PublicAdvertisedPrefixesClient.create()) {
   String project = "project-309310695";
   PublicAdvertisedPrefix publicAdvertisedPrefixResource =
       PublicAdvertisedPrefix.newBuilder().build();
   Operation response =
       publicAdvertisedPrefixesClient.insertAsync(project, publicAdvertisedPrefixResource).get();
 }
Parameters
Name Description
project String

Project ID for this request.
publicAdvertisedPrefixResource PublicAdvertisedPrefix

The body resource for this request
Returns
Type Description
OperationFuture<Operation,Operation>

insertCallable()

public final UnaryCallable<InsertPublicAdvertisedPrefixeRequest,Operation> insertCallable()

Creates a PublicAdvertisedPrefix in the specified project using the parameters that are included in the request.

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 (PublicAdvertisedPrefixesClient publicAdvertisedPrefixesClient =
     PublicAdvertisedPrefixesClient.create()) {
   InsertPublicAdvertisedPrefixeRequest request =
       InsertPublicAdvertisedPrefixeRequest.newBuilder()
           .setProject("project-309310695")
           .setPublicAdvertisedPrefixResource(PublicAdvertisedPrefix.newBuilder().build())
           .setRequestId("requestId693933066")
           .build();
   ApiFuture<Operation> future =
       publicAdvertisedPrefixesClient.insertCallable().futureCall(request);
   // Do something.
   Operation response = future.get();
 }
Returns
Type Description
UnaryCallable<InsertPublicAdvertisedPrefixeRequest,Operation>

insertOperationCallable()

public final OperationCallable<InsertPublicAdvertisedPrefixeRequest,Operation,Operation> insertOperationCallable()

Creates a PublicAdvertisedPrefix in the specified project using the parameters that are included in the request.

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 (PublicAdvertisedPrefixesClient publicAdvertisedPrefixesClient =
     PublicAdvertisedPrefixesClient.create()) {
   InsertPublicAdvertisedPrefixeRequest request =
       InsertPublicAdvertisedPrefixeRequest.newBuilder()
           .setProject("project-309310695")
           .setPublicAdvertisedPrefixResource(PublicAdvertisedPrefix.newBuilder().build())
           .setRequestId("requestId693933066")
           .build();
   OperationFuture<Operation, Operation> future =
       publicAdvertisedPrefixesClient.insertOperationCallable().futureCall(request);
   // Do something.
   Operation response = future.get();
 }
Returns
Type Description
OperationCallable<InsertPublicAdvertisedPrefixeRequest,Operation,Operation>

isShutdown()

public boolean isShutdown()
Returns
Type Description
boolean

isTerminated()

public boolean isTerminated()
Returns
Type Description
boolean

list(ListPublicAdvertisedPrefixesRequest request)

public final PublicAdvertisedPrefixesClient.ListPagedResponse list(ListPublicAdvertisedPrefixesRequest request)

Lists the PublicAdvertisedPrefixes for a 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 (PublicAdvertisedPrefixesClient publicAdvertisedPrefixesClient =
     PublicAdvertisedPrefixesClient.create()) {
   ListPublicAdvertisedPrefixesRequest request =
       ListPublicAdvertisedPrefixesRequest.newBuilder()
           .setFilter("filter-1274492040")
           .setMaxResults(1128457243)
           .setOrderBy("orderBy-1207110587")
           .setPageToken("pageToken873572522")
           .setProject("project-309310695")
           .setReturnPartialSuccess(true)
           .build();
   for (PublicAdvertisedPrefix element :
       publicAdvertisedPrefixesClient.list(request).iterateAll()) {
     // doThingsWith(element);
   }
 }
Parameter
Name Description
request ListPublicAdvertisedPrefixesRequest

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

list(String project)

public final PublicAdvertisedPrefixesClient.ListPagedResponse list(String project)

Lists the PublicAdvertisedPrefixes for a 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 (PublicAdvertisedPrefixesClient publicAdvertisedPrefixesClient =
     PublicAdvertisedPrefixesClient.create()) {
   String project = "project-309310695";
   for (PublicAdvertisedPrefix element :
       publicAdvertisedPrefixesClient.list(project).iterateAll()) {
     // doThingsWith(element);
   }
 }
Parameter
Name Description
project String

Project ID for this request.
Returns
Type Description
PublicAdvertisedPrefixesClient.ListPagedResponse

listCallable()

public final UnaryCallable<ListPublicAdvertisedPrefixesRequest,PublicAdvertisedPrefixList> listCallable()

Lists the PublicAdvertisedPrefixes for a 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 (PublicAdvertisedPrefixesClient publicAdvertisedPrefixesClient =
     PublicAdvertisedPrefixesClient.create()) {
   ListPublicAdvertisedPrefixesRequest request =
       ListPublicAdvertisedPrefixesRequest.newBuilder()
           .setFilter("filter-1274492040")
           .setMaxResults(1128457243)
           .setOrderBy("orderBy-1207110587")
           .setPageToken("pageToken873572522")
           .setProject("project-309310695")
           .setReturnPartialSuccess(true)
           .build();
   while (true) {
     PublicAdvertisedPrefixList response =
         publicAdvertisedPrefixesClient.listCallable().call(request);
     for (PublicAdvertisedPrefix element : response.getItemsList()) {
       // doThingsWith(element);
     }
     String nextPageToken = response.getNextPageToken();
     if (!Strings.isNullOrEmpty(nextPageToken)) {
       request = request.toBuilder().setPageToken(nextPageToken).build();
     } else {
       break;
     }
   }
 }
Returns
Type Description
UnaryCallable<ListPublicAdvertisedPrefixesRequest,PublicAdvertisedPrefixList>

listPagedCallable()

public final UnaryCallable<ListPublicAdvertisedPrefixesRequest,PublicAdvertisedPrefixesClient.ListPagedResponse> listPagedCallable()

Lists the PublicAdvertisedPrefixes for a 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 (PublicAdvertisedPrefixesClient publicAdvertisedPrefixesClient =
     PublicAdvertisedPrefixesClient.create()) {
   ListPublicAdvertisedPrefixesRequest request =
       ListPublicAdvertisedPrefixesRequest.newBuilder()
           .setFilter("filter-1274492040")
           .setMaxResults(1128457243)
           .setOrderBy("orderBy-1207110587")
           .setPageToken("pageToken873572522")
           .setProject("project-309310695")
           .setReturnPartialSuccess(true)
           .build();
   ApiFuture<PublicAdvertisedPrefix> future =
       publicAdvertisedPrefixesClient.listPagedCallable().futureCall(request);
   // Do something.
   for (PublicAdvertisedPrefix element : future.get().iterateAll()) {
     // doThingsWith(element);
   }
 }
Returns
Type Description
UnaryCallable<ListPublicAdvertisedPrefixesRequest,ListPagedResponse>

patchAsync(PatchPublicAdvertisedPrefixeRequest request)

public final OperationFuture<Operation,Operation> patchAsync(PatchPublicAdvertisedPrefixeRequest request)

Patches the specified Router resource with the data included in the request. This method supports PATCH semantics and uses JSON merge patch format and processing rules.

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 (PublicAdvertisedPrefixesClient publicAdvertisedPrefixesClient =
     PublicAdvertisedPrefixesClient.create()) {
   PatchPublicAdvertisedPrefixeRequest request =
       PatchPublicAdvertisedPrefixeRequest.newBuilder()
           .setProject("project-309310695")
           .setPublicAdvertisedPrefix("publicAdvertisedPrefix1506440856")
           .setPublicAdvertisedPrefixResource(PublicAdvertisedPrefix.newBuilder().build())
           .setRequestId("requestId693933066")
           .build();
   Operation response = publicAdvertisedPrefixesClient.patchAsync(request).get();
 }
Parameter
Name Description
request PatchPublicAdvertisedPrefixeRequest

The request object containing all of the parameters for the API call.
Returns
Type Description
OperationFuture<Operation,Operation>

patchAsync(String project, String publicAdvertisedPrefix, PublicAdvertisedPrefix publicAdvertisedPrefixResource)

public final OperationFuture<Operation,Operation> patchAsync(String project, String publicAdvertisedPrefix, PublicAdvertisedPrefix publicAdvertisedPrefixResource)

Patches the specified Router resource with the data included in the request. This method supports PATCH semantics and uses JSON merge patch format and processing rules.

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 (PublicAdvertisedPrefixesClient publicAdvertisedPrefixesClient =
     PublicAdvertisedPrefixesClient.create()) {
   String project = "project-309310695";
   String publicAdvertisedPrefix = "publicAdvertisedPrefix1506440856";
   PublicAdvertisedPrefix publicAdvertisedPrefixResource =
       PublicAdvertisedPrefix.newBuilder().build();
   Operation response =
       publicAdvertisedPrefixesClient
           .patchAsync(project, publicAdvertisedPrefix, publicAdvertisedPrefixResource)
           .get();
 }
Parameters
Name Description
project String

Project ID for this request.
publicAdvertisedPrefix String

Name of the PublicAdvertisedPrefix resource to patch.
publicAdvertisedPrefixResource PublicAdvertisedPrefix

The body resource for this request
Returns
Type Description
OperationFuture<Operation,Operation>

patchCallable()

public final UnaryCallable<PatchPublicAdvertisedPrefixeRequest,Operation> patchCallable()

Patches the specified Router resource with the data included in the request. This method supports PATCH semantics and uses JSON merge patch format and processing rules.

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 (PublicAdvertisedPrefixesClient publicAdvertisedPrefixesClient =
     PublicAdvertisedPrefixesClient.create()) {
   PatchPublicAdvertisedPrefixeRequest request =
       PatchPublicAdvertisedPrefixeRequest.newBuilder()
           .setProject("project-309310695")
           .setPublicAdvertisedPrefix("publicAdvertisedPrefix1506440856")
           .setPublicAdvertisedPrefixResource(PublicAdvertisedPrefix.newBuilder().build())
           .setRequestId("requestId693933066")
           .build();
   ApiFuture<Operation> future =
       publicAdvertisedPrefixesClient.patchCallable().futureCall(request);
   // Do something.
   Operation response = future.get();
 }
Returns
Type Description
UnaryCallable<PatchPublicAdvertisedPrefixeRequest,Operation>

patchOperationCallable()

public final OperationCallable<PatchPublicAdvertisedPrefixeRequest,Operation,Operation> patchOperationCallable()

Patches the specified Router resource with the data included in the request. This method supports PATCH semantics and uses JSON merge patch format and processing rules.

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 (PublicAdvertisedPrefixesClient publicAdvertisedPrefixesClient =
     PublicAdvertisedPrefixesClient.create()) {
   PatchPublicAdvertisedPrefixeRequest request =
       PatchPublicAdvertisedPrefixeRequest.newBuilder()
           .setProject("project-309310695")
           .setPublicAdvertisedPrefix("publicAdvertisedPrefix1506440856")
           .setPublicAdvertisedPrefixResource(PublicAdvertisedPrefix.newBuilder().build())
           .setRequestId("requestId693933066")
           .build();
   OperationFuture<Operation, Operation> future =
       publicAdvertisedPrefixesClient.patchOperationCallable().futureCall(request);
   // Do something.
   Operation response = future.get();
 }
Returns
Type Description
OperationCallable<PatchPublicAdvertisedPrefixeRequest,Operation,Operation>

shutdown()

public void shutdown()

shutdownNow()

public void shutdownNow()

withdrawAsync(WithdrawPublicAdvertisedPrefixeRequest request)

public final OperationFuture<Operation,Operation> withdrawAsync(WithdrawPublicAdvertisedPrefixeRequest request)

Withdraws the specified PublicAdvertisedPrefix

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 (PublicAdvertisedPrefixesClient publicAdvertisedPrefixesClient =
     PublicAdvertisedPrefixesClient.create()) {
   WithdrawPublicAdvertisedPrefixeRequest request =
       WithdrawPublicAdvertisedPrefixeRequest.newBuilder()
           .setProject("project-309310695")
           .setPublicAdvertisedPrefix("publicAdvertisedPrefix1506440856")
           .setRequestId("requestId693933066")
           .build();
   Operation response = publicAdvertisedPrefixesClient.withdrawAsync(request).get();
 }
Parameter
Name Description
request WithdrawPublicAdvertisedPrefixeRequest

The request object containing all of the parameters for the API call.
Returns
Type Description
OperationFuture<Operation,Operation>

withdrawAsync(String project, String publicAdvertisedPrefix)

public final OperationFuture<Operation,Operation> withdrawAsync(String project, String publicAdvertisedPrefix)

Withdraws the specified PublicAdvertisedPrefix

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 (PublicAdvertisedPrefixesClient publicAdvertisedPrefixesClient =
     PublicAdvertisedPrefixesClient.create()) {
   String project = "project-309310695";
   String publicAdvertisedPrefix = "publicAdvertisedPrefix1506440856";
   Operation response =
       publicAdvertisedPrefixesClient.withdrawAsync(project, publicAdvertisedPrefix).get();
 }
Parameters
Name Description
project String

Project ID for this request.
publicAdvertisedPrefix String

The name of the public advertised prefix. It should comply with RFC1035.
Returns
Type Description
OperationFuture<Operation,Operation>

withdrawCallable()

public final UnaryCallable<WithdrawPublicAdvertisedPrefixeRequest,Operation> withdrawCallable()

Withdraws the specified PublicAdvertisedPrefix

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 (PublicAdvertisedPrefixesClient publicAdvertisedPrefixesClient =
     PublicAdvertisedPrefixesClient.create()) {
   WithdrawPublicAdvertisedPrefixeRequest request =
       WithdrawPublicAdvertisedPrefixeRequest.newBuilder()
           .setProject("project-309310695")
           .setPublicAdvertisedPrefix("publicAdvertisedPrefix1506440856")
           .setRequestId("requestId693933066")
           .build();
   ApiFuture<Operation> future =
       publicAdvertisedPrefixesClient.withdrawCallable().futureCall(request);
   // Do something.
   Operation response = future.get();
 }
Returns
Type Description
UnaryCallable<WithdrawPublicAdvertisedPrefixeRequest,Operation>

withdrawOperationCallable()

public final OperationCallable<WithdrawPublicAdvertisedPrefixeRequest,Operation,Operation> withdrawOperationCallable()

Withdraws the specified PublicAdvertisedPrefix

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 (PublicAdvertisedPrefixesClient publicAdvertisedPrefixesClient =
     PublicAdvertisedPrefixesClient.create()) {
   WithdrawPublicAdvertisedPrefixeRequest request =
       WithdrawPublicAdvertisedPrefixeRequest.newBuilder()
           .setProject("project-309310695")
           .setPublicAdvertisedPrefix("publicAdvertisedPrefix1506440856")
           .setRequestId("requestId693933066")
           .build();
   OperationFuture<Operation, Operation> future =
       publicAdvertisedPrefixesClient.withdrawOperationCallable().futureCall(request);
   // Do something.
   Operation response = future.get();
 }
Returns
Type Description
OperationCallable<WithdrawPublicAdvertisedPrefixeRequest,Operation,Operation>