Class PublicDelegatedPrefixesClient (1.29.0)

public class PublicDelegatedPrefixesClient implements BackgroundResource

Service Description: The PublicDelegatedPrefixes 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 (PublicDelegatedPrefixesClient publicDelegatedPrefixesClient =
     PublicDelegatedPrefixesClient.create()) {
   String project = "project-309310695";
   String region = "region-934795532";
   String publicDelegatedPrefix = "publicDelegatedPrefix-663003832";
   PublicDelegatedPrefix response =
       publicDelegatedPrefixesClient.get(project, region, publicDelegatedPrefix);
 }
 

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

The surface of this class includes several types of Java methods for each of the API's methods:

  1. A "flattened" method. With this type of method, the fields of the request type have been converted into function parameters. It may be the case that not all fields are available as parameters, and not every API method will have a flattened method entry point.
  2. A "request object" method. This type of method only takes one parameter, a request object, which must be constructed before the call. Not every API method will have a request object method.
  3. A "callable" method. This type of method takes no parameters and returns an immutable API callable object, which can be used to initiate calls to the service.

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 PublicDelegatedPrefixesSettings 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
 PublicDelegatedPrefixesSettings publicDelegatedPrefixesSettings =
     PublicDelegatedPrefixesSettings.newBuilder()
         .setCredentialsProvider(FixedCredentialsProvider.create(myCredentials))
         .build();
 PublicDelegatedPrefixesClient publicDelegatedPrefixesClient =
     PublicDelegatedPrefixesClient.create(publicDelegatedPrefixesSettings);
 

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
 PublicDelegatedPrefixesSettings publicDelegatedPrefixesSettings =
     PublicDelegatedPrefixesSettings.newBuilder().setEndpoint(myEndpoint).build();
 PublicDelegatedPrefixesClient publicDelegatedPrefixesClient =
     PublicDelegatedPrefixesClient.create(publicDelegatedPrefixesSettings);
 

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

Inheritance

java.lang.Object > PublicDelegatedPrefixesClient

Implements

BackgroundResource

Static Methods

create()

public static final PublicDelegatedPrefixesClient create()

Constructs an instance of PublicDelegatedPrefixesClient with default settings.

Returns
TypeDescription
PublicDelegatedPrefixesClient
Exceptions
TypeDescription
IOException

create(PublicDelegatedPrefixesSettings settings)

public static final PublicDelegatedPrefixesClient create(PublicDelegatedPrefixesSettings settings)

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

Parameter
NameDescription
settingsPublicDelegatedPrefixesSettings
Returns
TypeDescription
PublicDelegatedPrefixesClient
Exceptions
TypeDescription
IOException

create(PublicDelegatedPrefixesStub stub)

public static final PublicDelegatedPrefixesClient create(PublicDelegatedPrefixesStub stub)

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

Parameter
NameDescription
stubPublicDelegatedPrefixesStub
Returns
TypeDescription
PublicDelegatedPrefixesClient

Constructors

PublicDelegatedPrefixesClient(PublicDelegatedPrefixesSettings settings)

protected PublicDelegatedPrefixesClient(PublicDelegatedPrefixesSettings settings)

Constructs an instance of PublicDelegatedPrefixesClient, 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
NameDescription
settingsPublicDelegatedPrefixesSettings

PublicDelegatedPrefixesClient(PublicDelegatedPrefixesStub stub)

protected PublicDelegatedPrefixesClient(PublicDelegatedPrefixesStub stub)
Parameter
NameDescription
stubPublicDelegatedPrefixesStub

Methods

aggregatedList(AggregatedListPublicDelegatedPrefixesRequest request)

public final PublicDelegatedPrefixesClient.AggregatedListPagedResponse aggregatedList(AggregatedListPublicDelegatedPrefixesRequest request)

Lists all PublicDelegatedPrefix resources owned by the specific project across all scopes.

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 (PublicDelegatedPrefixesClient publicDelegatedPrefixesClient =
     PublicDelegatedPrefixesClient.create()) {
   AggregatedListPublicDelegatedPrefixesRequest request =
       AggregatedListPublicDelegatedPrefixesRequest.newBuilder()
           .setFilter("filter-1274492040")
           .setIncludeAllScopes(true)
           .setMaxResults(1128457243)
           .setOrderBy("orderBy-1207110587")
           .setPageToken("pageToken873572522")
           .setProject("project-309310695")
           .setReturnPartialSuccess(true)
           .build();
   for (Map.Entry<String, PublicDelegatedPrefixesScopedList> element :
       publicDelegatedPrefixesClient.aggregatedList(request).iterateAll()) {
     // doThingsWith(element);
   }
 }
 
Parameter
NameDescription
requestAggregatedListPublicDelegatedPrefixesRequest

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

Returns
TypeDescription
PublicDelegatedPrefixesClient.AggregatedListPagedResponse

aggregatedList(String project)

public final PublicDelegatedPrefixesClient.AggregatedListPagedResponse aggregatedList(String project)

Lists all PublicDelegatedPrefix resources owned by the specific project across all scopes.

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 (PublicDelegatedPrefixesClient publicDelegatedPrefixesClient =
     PublicDelegatedPrefixesClient.create()) {
   String project = "project-309310695";
   for (Map.Entry<String, PublicDelegatedPrefixesScopedList> element :
       publicDelegatedPrefixesClient.aggregatedList(project).iterateAll()) {
     // doThingsWith(element);
   }
 }
 
Parameter
NameDescription
projectString

Name of the project scoping this request.

Returns
TypeDescription
PublicDelegatedPrefixesClient.AggregatedListPagedResponse

aggregatedListCallable()

public final UnaryCallable<AggregatedListPublicDelegatedPrefixesRequest,PublicDelegatedPrefixAggregatedList> aggregatedListCallable()

Lists all PublicDelegatedPrefix resources owned by the specific project across all scopes.

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 (PublicDelegatedPrefixesClient publicDelegatedPrefixesClient =
     PublicDelegatedPrefixesClient.create()) {
   AggregatedListPublicDelegatedPrefixesRequest request =
       AggregatedListPublicDelegatedPrefixesRequest.newBuilder()
           .setFilter("filter-1274492040")
           .setIncludeAllScopes(true)
           .setMaxResults(1128457243)
           .setOrderBy("orderBy-1207110587")
           .setPageToken("pageToken873572522")
           .setProject("project-309310695")
           .setReturnPartialSuccess(true)
           .build();
   while (true) {
     PublicDelegatedPrefixAggregatedList response =
         publicDelegatedPrefixesClient.aggregatedListCallable().call(request);
     for (Map.Entry<String, PublicDelegatedPrefixesScopedList> element :
         response.getItemsList()) {
       // doThingsWith(element);
     }
     String nextPageToken = response.getNextPageToken();
     if (!Strings.isNullOrEmpty(nextPageToken)) {
       request = request.toBuilder().setPageToken(nextPageToken).build();
     } else {
       break;
     }
   }
 }
 
Returns
TypeDescription
UnaryCallable<AggregatedListPublicDelegatedPrefixesRequest,PublicDelegatedPrefixAggregatedList>

aggregatedListPagedCallable()

public final UnaryCallable<AggregatedListPublicDelegatedPrefixesRequest,PublicDelegatedPrefixesClient.AggregatedListPagedResponse> aggregatedListPagedCallable()

Lists all PublicDelegatedPrefix resources owned by the specific project across all scopes.

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 (PublicDelegatedPrefixesClient publicDelegatedPrefixesClient =
     PublicDelegatedPrefixesClient.create()) {
   AggregatedListPublicDelegatedPrefixesRequest request =
       AggregatedListPublicDelegatedPrefixesRequest.newBuilder()
           .setFilter("filter-1274492040")
           .setIncludeAllScopes(true)
           .setMaxResults(1128457243)
           .setOrderBy("orderBy-1207110587")
           .setPageToken("pageToken873572522")
           .setProject("project-309310695")
           .setReturnPartialSuccess(true)
           .build();
   ApiFuture<Map.Entry<String, PublicDelegatedPrefixesScopedList>> future =
       publicDelegatedPrefixesClient.aggregatedListPagedCallable().futureCall(request);
   // Do something.
   for (Map.Entry<String, PublicDelegatedPrefixesScopedList> element :
       future.get().iterateAll()) {
     // doThingsWith(element);
   }
 }
 
Returns
TypeDescription
UnaryCallable<AggregatedListPublicDelegatedPrefixesRequest,AggregatedListPagedResponse>

awaitTermination(long duration, TimeUnit unit)

public boolean awaitTermination(long duration, TimeUnit unit)
Parameters
NameDescription
durationlong
unitTimeUnit
Returns
TypeDescription
boolean
Exceptions
TypeDescription
InterruptedException

close()

public final void close()

deleteAsync(DeletePublicDelegatedPrefixeRequest request)

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

Deletes the specified PublicDelegatedPrefix in the given region.

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 (PublicDelegatedPrefixesClient publicDelegatedPrefixesClient =
     PublicDelegatedPrefixesClient.create()) {
   DeletePublicDelegatedPrefixeRequest request =
       DeletePublicDelegatedPrefixeRequest.newBuilder()
           .setProject("project-309310695")
           .setPublicDelegatedPrefix("publicDelegatedPrefix-663003832")
           .setRegion("region-934795532")
           .setRequestId("requestId693933066")
           .build();
   Operation response = publicDelegatedPrefixesClient.deleteAsync(request).get();
 }
 
Parameter
NameDescription
requestDeletePublicDelegatedPrefixeRequest

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

Returns
TypeDescription
OperationFuture<Operation,Operation>

deleteAsync(String project, String region, String publicDelegatedPrefix)

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

Deletes the specified PublicDelegatedPrefix in the given region.

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 (PublicDelegatedPrefixesClient publicDelegatedPrefixesClient =
     PublicDelegatedPrefixesClient.create()) {
   String project = "project-309310695";
   String region = "region-934795532";
   String publicDelegatedPrefix = "publicDelegatedPrefix-663003832";
   Operation response =
       publicDelegatedPrefixesClient.deleteAsync(project, region, publicDelegatedPrefix).get();
 }
 
Parameters
NameDescription
projectString

Project ID for this request.

regionString

Name of the region of this request.

publicDelegatedPrefixString

Name of the PublicDelegatedPrefix resource to delete.

Returns
TypeDescription
OperationFuture<Operation,Operation>

deleteCallable()

public final UnaryCallable<DeletePublicDelegatedPrefixeRequest,Operation> deleteCallable()

Deletes the specified PublicDelegatedPrefix in the given region.

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 (PublicDelegatedPrefixesClient publicDelegatedPrefixesClient =
     PublicDelegatedPrefixesClient.create()) {
   DeletePublicDelegatedPrefixeRequest request =
       DeletePublicDelegatedPrefixeRequest.newBuilder()
           .setProject("project-309310695")
           .setPublicDelegatedPrefix("publicDelegatedPrefix-663003832")
           .setRegion("region-934795532")
           .setRequestId("requestId693933066")
           .build();
   ApiFuture<Operation> future =
       publicDelegatedPrefixesClient.deleteCallable().futureCall(request);
   // Do something.
   Operation response = future.get();
 }
 
Returns
TypeDescription
UnaryCallable<DeletePublicDelegatedPrefixeRequest,Operation>

deleteOperationCallable()

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

Deletes the specified PublicDelegatedPrefix in the given region.

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 (PublicDelegatedPrefixesClient publicDelegatedPrefixesClient =
     PublicDelegatedPrefixesClient.create()) {
   DeletePublicDelegatedPrefixeRequest request =
       DeletePublicDelegatedPrefixeRequest.newBuilder()
           .setProject("project-309310695")
           .setPublicDelegatedPrefix("publicDelegatedPrefix-663003832")
           .setRegion("region-934795532")
           .setRequestId("requestId693933066")
           .build();
   OperationFuture<Operation, Operation> future =
       publicDelegatedPrefixesClient.deleteOperationCallable().futureCall(request);
   // Do something.
   Operation response = future.get();
 }
 
Returns
TypeDescription
OperationCallable<DeletePublicDelegatedPrefixeRequest,Operation,Operation>

get(GetPublicDelegatedPrefixeRequest request)

public final PublicDelegatedPrefix get(GetPublicDelegatedPrefixeRequest request)

Returns the specified PublicDelegatedPrefix resource in the given region.

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 (PublicDelegatedPrefixesClient publicDelegatedPrefixesClient =
     PublicDelegatedPrefixesClient.create()) {
   GetPublicDelegatedPrefixeRequest request =
       GetPublicDelegatedPrefixeRequest.newBuilder()
           .setProject("project-309310695")
           .setPublicDelegatedPrefix("publicDelegatedPrefix-663003832")
           .setRegion("region-934795532")
           .build();
   PublicDelegatedPrefix response = publicDelegatedPrefixesClient.get(request);
 }
 
Parameter
NameDescription
requestGetPublicDelegatedPrefixeRequest

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

Returns
TypeDescription
PublicDelegatedPrefix

get(String project, String region, String publicDelegatedPrefix)

public final PublicDelegatedPrefix get(String project, String region, String publicDelegatedPrefix)

Returns the specified PublicDelegatedPrefix resource in the given region.

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 (PublicDelegatedPrefixesClient publicDelegatedPrefixesClient =
     PublicDelegatedPrefixesClient.create()) {
   String project = "project-309310695";
   String region = "region-934795532";
   String publicDelegatedPrefix = "publicDelegatedPrefix-663003832";
   PublicDelegatedPrefix response =
       publicDelegatedPrefixesClient.get(project, region, publicDelegatedPrefix);
 }
 
Parameters
NameDescription
projectString

Project ID for this request.

regionString

Name of the region of this request.

publicDelegatedPrefixString

Name of the PublicDelegatedPrefix resource to return.

Returns
TypeDescription
PublicDelegatedPrefix

getCallable()

public final UnaryCallable<GetPublicDelegatedPrefixeRequest,PublicDelegatedPrefix> getCallable()

Returns the specified PublicDelegatedPrefix resource in the given region.

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 (PublicDelegatedPrefixesClient publicDelegatedPrefixesClient =
     PublicDelegatedPrefixesClient.create()) {
   GetPublicDelegatedPrefixeRequest request =
       GetPublicDelegatedPrefixeRequest.newBuilder()
           .setProject("project-309310695")
           .setPublicDelegatedPrefix("publicDelegatedPrefix-663003832")
           .setRegion("region-934795532")
           .build();
   ApiFuture<PublicDelegatedPrefix> future =
       publicDelegatedPrefixesClient.getCallable().futureCall(request);
   // Do something.
   PublicDelegatedPrefix response = future.get();
 }
 
Returns
TypeDescription
UnaryCallable<GetPublicDelegatedPrefixeRequest,PublicDelegatedPrefix>

getSettings()

public final PublicDelegatedPrefixesSettings getSettings()
Returns
TypeDescription
PublicDelegatedPrefixesSettings

getStub()

public PublicDelegatedPrefixesStub getStub()
Returns
TypeDescription
PublicDelegatedPrefixesStub

insertAsync(InsertPublicDelegatedPrefixeRequest request)

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

Creates a PublicDelegatedPrefix in the specified project in the given region 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 (PublicDelegatedPrefixesClient publicDelegatedPrefixesClient =
     PublicDelegatedPrefixesClient.create()) {
   InsertPublicDelegatedPrefixeRequest request =
       InsertPublicDelegatedPrefixeRequest.newBuilder()
           .setProject("project-309310695")
           .setPublicDelegatedPrefixResource(PublicDelegatedPrefix.newBuilder().build())
           .setRegion("region-934795532")
           .setRequestId("requestId693933066")
           .build();
   Operation response = publicDelegatedPrefixesClient.insertAsync(request).get();
 }
 
Parameter
NameDescription
requestInsertPublicDelegatedPrefixeRequest

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

Returns
TypeDescription
OperationFuture<Operation,Operation>

insertAsync(String project, String region, PublicDelegatedPrefix publicDelegatedPrefixResource)

public final OperationFuture<Operation,Operation> insertAsync(String project, String region, PublicDelegatedPrefix publicDelegatedPrefixResource)

Creates a PublicDelegatedPrefix in the specified project in the given region 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 (PublicDelegatedPrefixesClient publicDelegatedPrefixesClient =
     PublicDelegatedPrefixesClient.create()) {
   String project = "project-309310695";
   String region = "region-934795532";
   PublicDelegatedPrefix publicDelegatedPrefixResource =
       PublicDelegatedPrefix.newBuilder().build();
   Operation response =
       publicDelegatedPrefixesClient
           .insertAsync(project, region, publicDelegatedPrefixResource)
           .get();
 }
 
Parameters
NameDescription
projectString

Project ID for this request.

regionString

Name of the region of this request.

publicDelegatedPrefixResourcePublicDelegatedPrefix

The body resource for this request

Returns
TypeDescription
OperationFuture<Operation,Operation>

insertCallable()

public final UnaryCallable<InsertPublicDelegatedPrefixeRequest,Operation> insertCallable()

Creates a PublicDelegatedPrefix in the specified project in the given region 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 (PublicDelegatedPrefixesClient publicDelegatedPrefixesClient =
     PublicDelegatedPrefixesClient.create()) {
   InsertPublicDelegatedPrefixeRequest request =
       InsertPublicDelegatedPrefixeRequest.newBuilder()
           .setProject("project-309310695")
           .setPublicDelegatedPrefixResource(PublicDelegatedPrefix.newBuilder().build())
           .setRegion("region-934795532")
           .setRequestId("requestId693933066")
           .build();
   ApiFuture<Operation> future =
       publicDelegatedPrefixesClient.insertCallable().futureCall(request);
   // Do something.
   Operation response = future.get();
 }
 
Returns
TypeDescription
UnaryCallable<InsertPublicDelegatedPrefixeRequest,Operation>

insertOperationCallable()

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

Creates a PublicDelegatedPrefix in the specified project in the given region 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 (PublicDelegatedPrefixesClient publicDelegatedPrefixesClient =
     PublicDelegatedPrefixesClient.create()) {
   InsertPublicDelegatedPrefixeRequest request =
       InsertPublicDelegatedPrefixeRequest.newBuilder()
           .setProject("project-309310695")
           .setPublicDelegatedPrefixResource(PublicDelegatedPrefix.newBuilder().build())
           .setRegion("region-934795532")
           .setRequestId("requestId693933066")
           .build();
   OperationFuture<Operation, Operation> future =
       publicDelegatedPrefixesClient.insertOperationCallable().futureCall(request);
   // Do something.
   Operation response = future.get();
 }
 
Returns
TypeDescription
OperationCallable<InsertPublicDelegatedPrefixeRequest,Operation,Operation>

isShutdown()

public boolean isShutdown()
Returns
TypeDescription
boolean

isTerminated()

public boolean isTerminated()
Returns
TypeDescription
boolean

list(ListPublicDelegatedPrefixesRequest request)

public final PublicDelegatedPrefixesClient.ListPagedResponse list(ListPublicDelegatedPrefixesRequest request)

Lists the PublicDelegatedPrefixes for a project in the given region.

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 (PublicDelegatedPrefixesClient publicDelegatedPrefixesClient =
     PublicDelegatedPrefixesClient.create()) {
   ListPublicDelegatedPrefixesRequest request =
       ListPublicDelegatedPrefixesRequest.newBuilder()
           .setFilter("filter-1274492040")
           .setMaxResults(1128457243)
           .setOrderBy("orderBy-1207110587")
           .setPageToken("pageToken873572522")
           .setProject("project-309310695")
           .setRegion("region-934795532")
           .setReturnPartialSuccess(true)
           .build();
   for (PublicDelegatedPrefix element :
       publicDelegatedPrefixesClient.list(request).iterateAll()) {
     // doThingsWith(element);
   }
 }
 
Parameter
NameDescription
requestListPublicDelegatedPrefixesRequest

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

Returns
TypeDescription
PublicDelegatedPrefixesClient.ListPagedResponse

list(String project, String region)

public final PublicDelegatedPrefixesClient.ListPagedResponse list(String project, String region)

Lists the PublicDelegatedPrefixes for a project in the given region.

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 (PublicDelegatedPrefixesClient publicDelegatedPrefixesClient =
     PublicDelegatedPrefixesClient.create()) {
   String project = "project-309310695";
   String region = "region-934795532";
   for (PublicDelegatedPrefix element :
       publicDelegatedPrefixesClient.list(project, region).iterateAll()) {
     // doThingsWith(element);
   }
 }
 
Parameters
NameDescription
projectString

Project ID for this request.

regionString

Name of the region of this request.

Returns
TypeDescription
PublicDelegatedPrefixesClient.ListPagedResponse

listCallable()

public final UnaryCallable<ListPublicDelegatedPrefixesRequest,PublicDelegatedPrefixList> listCallable()

Lists the PublicDelegatedPrefixes for a project in the given region.

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 (PublicDelegatedPrefixesClient publicDelegatedPrefixesClient =
     PublicDelegatedPrefixesClient.create()) {
   ListPublicDelegatedPrefixesRequest request =
       ListPublicDelegatedPrefixesRequest.newBuilder()
           .setFilter("filter-1274492040")
           .setMaxResults(1128457243)
           .setOrderBy("orderBy-1207110587")
           .setPageToken("pageToken873572522")
           .setProject("project-309310695")
           .setRegion("region-934795532")
           .setReturnPartialSuccess(true)
           .build();
   while (true) {
     PublicDelegatedPrefixList response =
         publicDelegatedPrefixesClient.listCallable().call(request);
     for (PublicDelegatedPrefix element : response.getItemsList()) {
       // doThingsWith(element);
     }
     String nextPageToken = response.getNextPageToken();
     if (!Strings.isNullOrEmpty(nextPageToken)) {
       request = request.toBuilder().setPageToken(nextPageToken).build();
     } else {
       break;
     }
   }
 }
 
Returns
TypeDescription
UnaryCallable<ListPublicDelegatedPrefixesRequest,PublicDelegatedPrefixList>

listPagedCallable()

public final UnaryCallable<ListPublicDelegatedPrefixesRequest,PublicDelegatedPrefixesClient.ListPagedResponse> listPagedCallable()

Lists the PublicDelegatedPrefixes for a project in the given region.

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 (PublicDelegatedPrefixesClient publicDelegatedPrefixesClient =
     PublicDelegatedPrefixesClient.create()) {
   ListPublicDelegatedPrefixesRequest request =
       ListPublicDelegatedPrefixesRequest.newBuilder()
           .setFilter("filter-1274492040")
           .setMaxResults(1128457243)
           .setOrderBy("orderBy-1207110587")
           .setPageToken("pageToken873572522")
           .setProject("project-309310695")
           .setRegion("region-934795532")
           .setReturnPartialSuccess(true)
           .build();
   ApiFuture<PublicDelegatedPrefix> future =
       publicDelegatedPrefixesClient.listPagedCallable().futureCall(request);
   // Do something.
   for (PublicDelegatedPrefix element : future.get().iterateAll()) {
     // doThingsWith(element);
   }
 }
 
Returns
TypeDescription
UnaryCallable<ListPublicDelegatedPrefixesRequest,ListPagedResponse>

patchAsync(PatchPublicDelegatedPrefixeRequest request)

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

Patches the specified PublicDelegatedPrefix 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 (PublicDelegatedPrefixesClient publicDelegatedPrefixesClient =
     PublicDelegatedPrefixesClient.create()) {
   PatchPublicDelegatedPrefixeRequest request =
       PatchPublicDelegatedPrefixeRequest.newBuilder()
           .setProject("project-309310695")
           .setPublicDelegatedPrefix("publicDelegatedPrefix-663003832")
           .setPublicDelegatedPrefixResource(PublicDelegatedPrefix.newBuilder().build())
           .setRegion("region-934795532")
           .setRequestId("requestId693933066")
           .build();
   Operation response = publicDelegatedPrefixesClient.patchAsync(request).get();
 }
 
Parameter
NameDescription
requestPatchPublicDelegatedPrefixeRequest

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

Returns
TypeDescription
OperationFuture<Operation,Operation>

patchAsync(String project, String region, String publicDelegatedPrefix, PublicDelegatedPrefix publicDelegatedPrefixResource)

public final OperationFuture<Operation,Operation> patchAsync(String project, String region, String publicDelegatedPrefix, PublicDelegatedPrefix publicDelegatedPrefixResource)

Patches the specified PublicDelegatedPrefix 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 (PublicDelegatedPrefixesClient publicDelegatedPrefixesClient =
     PublicDelegatedPrefixesClient.create()) {
   String project = "project-309310695";
   String region = "region-934795532";
   String publicDelegatedPrefix = "publicDelegatedPrefix-663003832";
   PublicDelegatedPrefix publicDelegatedPrefixResource =
       PublicDelegatedPrefix.newBuilder().build();
   Operation response =
       publicDelegatedPrefixesClient
           .patchAsync(project, region, publicDelegatedPrefix, publicDelegatedPrefixResource)
           .get();
 }
 
Parameters
NameDescription
projectString

Project ID for this request.

regionString

Name of the region for this request.

publicDelegatedPrefixString

Name of the PublicDelegatedPrefix resource to patch.

publicDelegatedPrefixResourcePublicDelegatedPrefix

The body resource for this request

Returns
TypeDescription
OperationFuture<Operation,Operation>

patchCallable()

public final UnaryCallable<PatchPublicDelegatedPrefixeRequest,Operation> patchCallable()

Patches the specified PublicDelegatedPrefix 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 (PublicDelegatedPrefixesClient publicDelegatedPrefixesClient =
     PublicDelegatedPrefixesClient.create()) {
   PatchPublicDelegatedPrefixeRequest request =
       PatchPublicDelegatedPrefixeRequest.newBuilder()
           .setProject("project-309310695")
           .setPublicDelegatedPrefix("publicDelegatedPrefix-663003832")
           .setPublicDelegatedPrefixResource(PublicDelegatedPrefix.newBuilder().build())
           .setRegion("region-934795532")
           .setRequestId("requestId693933066")
           .build();
   ApiFuture<Operation> future =
       publicDelegatedPrefixesClient.patchCallable().futureCall(request);
   // Do something.
   Operation response = future.get();
 }
 
Returns
TypeDescription
UnaryCallable<PatchPublicDelegatedPrefixeRequest,Operation>

patchOperationCallable()

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

Patches the specified PublicDelegatedPrefix 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 (PublicDelegatedPrefixesClient publicDelegatedPrefixesClient =
     PublicDelegatedPrefixesClient.create()) {
   PatchPublicDelegatedPrefixeRequest request =
       PatchPublicDelegatedPrefixeRequest.newBuilder()
           .setProject("project-309310695")
           .setPublicDelegatedPrefix("publicDelegatedPrefix-663003832")
           .setPublicDelegatedPrefixResource(PublicDelegatedPrefix.newBuilder().build())
           .setRegion("region-934795532")
           .setRequestId("requestId693933066")
           .build();
   OperationFuture<Operation, Operation> future =
       publicDelegatedPrefixesClient.patchOperationCallable().futureCall(request);
   // Do something.
   Operation response = future.get();
 }
 
Returns
TypeDescription
OperationCallable<PatchPublicDelegatedPrefixeRequest,Operation,Operation>

shutdown()

public void shutdown()

shutdownNow()

public void shutdownNow()