Class GlobalPublicDelegatedPrefixesClient
- java.lang.Object
-
- com.google.cloud.compute.v1.GlobalPublicDelegatedPrefixesClient
-
- All Implemented Interfaces:
com.google.api.gax.core.BackgroundResource
,AutoCloseable
@Generated("by gapic-generator-java") public class GlobalPublicDelegatedPrefixesClient extends Object implements com.google.api.gax.core.BackgroundResource
Service Description: The GlobalPublicDelegatedPrefixes 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 (GlobalPublicDelegatedPrefixesClient globalPublicDelegatedPrefixesClient = GlobalPublicDelegatedPrefixesClient.create()) { String project = "project-309310695"; String publicDelegatedPrefix = "publicDelegatedPrefix-663003832"; PublicDelegatedPrefix response = globalPublicDelegatedPrefixesClient.get(project, publicDelegatedPrefix); }
Note: close() needs to be called on the GlobalPublicDelegatedPrefixesClient 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:
- 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.
- 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.
- 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 GlobalPublicDelegatedPrefixesSettings 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 GlobalPublicDelegatedPrefixesSettings globalPublicDelegatedPrefixesSettings = GlobalPublicDelegatedPrefixesSettings.newBuilder() .setCredentialsProvider(FixedCredentialsProvider.create(myCredentials)) .build(); GlobalPublicDelegatedPrefixesClient globalPublicDelegatedPrefixesClient = GlobalPublicDelegatedPrefixesClient.create(globalPublicDelegatedPrefixesSettings);
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 GlobalPublicDelegatedPrefixesSettings globalPublicDelegatedPrefixesSettings = GlobalPublicDelegatedPrefixesSettings.newBuilder().setEndpoint(myEndpoint).build(); GlobalPublicDelegatedPrefixesClient globalPublicDelegatedPrefixesClient = GlobalPublicDelegatedPrefixesClient.create(globalPublicDelegatedPrefixesSettings);
Please refer to the GitHub repository's samples for more quickstart code snippets.
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static class
GlobalPublicDelegatedPrefixesClient.ListFixedSizeCollection
static class
GlobalPublicDelegatedPrefixesClient.ListPage
static class
GlobalPublicDelegatedPrefixesClient.ListPagedResponse
-
Constructor Summary
Constructors Modifier Constructor Description protected
GlobalPublicDelegatedPrefixesClient(GlobalPublicDelegatedPrefixesSettings settings)
Constructs an instance of GlobalPublicDelegatedPrefixesClient, using the given settings.protected
GlobalPublicDelegatedPrefixesClient(GlobalPublicDelegatedPrefixesStub stub)
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description boolean
awaitTermination(long duration, TimeUnit unit)
void
close()
static GlobalPublicDelegatedPrefixesClient
create()
Constructs an instance of GlobalPublicDelegatedPrefixesClient with default settings.static GlobalPublicDelegatedPrefixesClient
create(GlobalPublicDelegatedPrefixesSettings settings)
Constructs an instance of GlobalPublicDelegatedPrefixesClient, using the given settings.static GlobalPublicDelegatedPrefixesClient
create(GlobalPublicDelegatedPrefixesStub stub)
Constructs an instance of GlobalPublicDelegatedPrefixesClient, using the given stub for making calls.com.google.api.gax.longrunning.OperationFuture<Operation,Operation>
deleteAsync(DeleteGlobalPublicDelegatedPrefixeRequest request)
Deletes the specified global PublicDelegatedPrefix.com.google.api.gax.longrunning.OperationFuture<Operation,Operation>
deleteAsync(String project, String publicDelegatedPrefix)
Deletes the specified global PublicDelegatedPrefix.com.google.api.gax.rpc.UnaryCallable<DeleteGlobalPublicDelegatedPrefixeRequest,Operation>
deleteCallable()
Deletes the specified global PublicDelegatedPrefix.com.google.api.gax.rpc.OperationCallable<DeleteGlobalPublicDelegatedPrefixeRequest,Operation,Operation>
deleteOperationCallable()
Deletes the specified global PublicDelegatedPrefix.PublicDelegatedPrefix
get(GetGlobalPublicDelegatedPrefixeRequest request)
Returns the specified global PublicDelegatedPrefix resource.PublicDelegatedPrefix
get(String project, String publicDelegatedPrefix)
Returns the specified global PublicDelegatedPrefix resource.com.google.api.gax.rpc.UnaryCallable<GetGlobalPublicDelegatedPrefixeRequest,PublicDelegatedPrefix>
getCallable()
Returns the specified global PublicDelegatedPrefix resource.GlobalPublicDelegatedPrefixesSettings
getSettings()
GlobalPublicDelegatedPrefixesStub
getStub()
com.google.api.gax.longrunning.OperationFuture<Operation,Operation>
insertAsync(InsertGlobalPublicDelegatedPrefixeRequest request)
Creates a global PublicDelegatedPrefix in the specified project using the parameters that are included in the request.com.google.api.gax.longrunning.OperationFuture<Operation,Operation>
insertAsync(String project, PublicDelegatedPrefix publicDelegatedPrefixResource)
Creates a global PublicDelegatedPrefix in the specified project using the parameters that are included in the request.com.google.api.gax.rpc.UnaryCallable<InsertGlobalPublicDelegatedPrefixeRequest,Operation>
insertCallable()
Creates a global PublicDelegatedPrefix in the specified project using the parameters that are included in the request.com.google.api.gax.rpc.OperationCallable<InsertGlobalPublicDelegatedPrefixeRequest,Operation,Operation>
insertOperationCallable()
Creates a global PublicDelegatedPrefix in the specified project using the parameters that are included in the request.boolean
isShutdown()
boolean
isTerminated()
GlobalPublicDelegatedPrefixesClient.ListPagedResponse
list(ListGlobalPublicDelegatedPrefixesRequest request)
Lists the global PublicDelegatedPrefixes for a project.GlobalPublicDelegatedPrefixesClient.ListPagedResponse
list(String project)
Lists the global PublicDelegatedPrefixes for a project.com.google.api.gax.rpc.UnaryCallable<ListGlobalPublicDelegatedPrefixesRequest,PublicDelegatedPrefixList>
listCallable()
Lists the global PublicDelegatedPrefixes for a project.com.google.api.gax.rpc.UnaryCallable<ListGlobalPublicDelegatedPrefixesRequest,GlobalPublicDelegatedPrefixesClient.ListPagedResponse>
listPagedCallable()
Lists the global PublicDelegatedPrefixes for a project.com.google.api.gax.longrunning.OperationFuture<Operation,Operation>
patchAsync(PatchGlobalPublicDelegatedPrefixeRequest request)
Patches the specified global PublicDelegatedPrefix resource with the data included in the request.com.google.api.gax.longrunning.OperationFuture<Operation,Operation>
patchAsync(String project, String publicDelegatedPrefix, PublicDelegatedPrefix publicDelegatedPrefixResource)
Patches the specified global PublicDelegatedPrefix resource with the data included in the request.com.google.api.gax.rpc.UnaryCallable<PatchGlobalPublicDelegatedPrefixeRequest,Operation>
patchCallable()
Patches the specified global PublicDelegatedPrefix resource with the data included in the request.com.google.api.gax.rpc.OperationCallable<PatchGlobalPublicDelegatedPrefixeRequest,Operation,Operation>
patchOperationCallable()
Patches the specified global PublicDelegatedPrefix resource with the data included in the request.void
shutdown()
void
shutdownNow()
-
-
-
Constructor Detail
-
GlobalPublicDelegatedPrefixesClient
protected GlobalPublicDelegatedPrefixesClient(GlobalPublicDelegatedPrefixesSettings settings) throws IOException
Constructs an instance of GlobalPublicDelegatedPrefixesClient, 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.- Throws:
IOException
-
GlobalPublicDelegatedPrefixesClient
protected GlobalPublicDelegatedPrefixesClient(GlobalPublicDelegatedPrefixesStub stub)
-
-
Method Detail
-
create
public static final GlobalPublicDelegatedPrefixesClient create() throws IOException
Constructs an instance of GlobalPublicDelegatedPrefixesClient with default settings.- Throws:
IOException
-
create
public static final GlobalPublicDelegatedPrefixesClient create(GlobalPublicDelegatedPrefixesSettings settings) throws IOException
Constructs an instance of GlobalPublicDelegatedPrefixesClient, using the given settings. The channels are created based on the settings passed in, or defaults for any settings that are not set.- Throws:
IOException
-
create
public static final GlobalPublicDelegatedPrefixesClient create(GlobalPublicDelegatedPrefixesStub stub)
Constructs an instance of GlobalPublicDelegatedPrefixesClient, using the given stub for making calls. This is for advanced usage - prefer using create(GlobalPublicDelegatedPrefixesSettings).
-
getSettings
public final GlobalPublicDelegatedPrefixesSettings getSettings()
-
getStub
public GlobalPublicDelegatedPrefixesStub getStub()
-
deleteAsync
public final com.google.api.gax.longrunning.OperationFuture<Operation,Operation> deleteAsync(String project, String publicDelegatedPrefix)
Deletes the specified global PublicDelegatedPrefix.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 (GlobalPublicDelegatedPrefixesClient globalPublicDelegatedPrefixesClient = GlobalPublicDelegatedPrefixesClient.create()) { String project = "project-309310695"; String publicDelegatedPrefix = "publicDelegatedPrefix-663003832"; Operation response = globalPublicDelegatedPrefixesClient.deleteAsync(project, publicDelegatedPrefix).get(); }
- Parameters:
project
- Project ID for this request.publicDelegatedPrefix
- Name of the PublicDelegatedPrefix resource to delete.- Throws:
com.google.api.gax.rpc.ApiException
- if the remote call fails
-
deleteAsync
@BetaApi("The surface for long-running operations is not stable yet and may change in the future.") public final com.google.api.gax.longrunning.OperationFuture<Operation,Operation> deleteAsync(DeleteGlobalPublicDelegatedPrefixeRequest request)
Deletes the specified global PublicDelegatedPrefix.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 (GlobalPublicDelegatedPrefixesClient globalPublicDelegatedPrefixesClient = GlobalPublicDelegatedPrefixesClient.create()) { DeleteGlobalPublicDelegatedPrefixeRequest request = DeleteGlobalPublicDelegatedPrefixeRequest.newBuilder() .setProject("project-309310695") .setPublicDelegatedPrefix("publicDelegatedPrefix-663003832") .setRequestId("requestId693933066") .build(); Operation response = globalPublicDelegatedPrefixesClient.deleteAsync(request).get(); }
- Parameters:
request
- The request object containing all of the parameters for the API call.- Throws:
com.google.api.gax.rpc.ApiException
- if the remote call fails
-
deleteOperationCallable
public final com.google.api.gax.rpc.OperationCallable<DeleteGlobalPublicDelegatedPrefixeRequest,Operation,Operation> deleteOperationCallable()
Deletes the specified global PublicDelegatedPrefix.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 (GlobalPublicDelegatedPrefixesClient globalPublicDelegatedPrefixesClient = GlobalPublicDelegatedPrefixesClient.create()) { DeleteGlobalPublicDelegatedPrefixeRequest request = DeleteGlobalPublicDelegatedPrefixeRequest.newBuilder() .setProject("project-309310695") .setPublicDelegatedPrefix("publicDelegatedPrefix-663003832") .setRequestId("requestId693933066") .build(); OperationFuture<Operation, Operation> future = globalPublicDelegatedPrefixesClient.deleteOperationCallable().futureCall(request); // Do something. Operation response = future.get(); }
-
deleteCallable
public final com.google.api.gax.rpc.UnaryCallable<DeleteGlobalPublicDelegatedPrefixeRequest,Operation> deleteCallable()
Deletes the specified global PublicDelegatedPrefix.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 (GlobalPublicDelegatedPrefixesClient globalPublicDelegatedPrefixesClient = GlobalPublicDelegatedPrefixesClient.create()) { DeleteGlobalPublicDelegatedPrefixeRequest request = DeleteGlobalPublicDelegatedPrefixeRequest.newBuilder() .setProject("project-309310695") .setPublicDelegatedPrefix("publicDelegatedPrefix-663003832") .setRequestId("requestId693933066") .build(); ApiFuture<Operation> future = globalPublicDelegatedPrefixesClient.deleteCallable().futureCall(request); // Do something. Operation response = future.get(); }
-
get
public final PublicDelegatedPrefix get(String project, String publicDelegatedPrefix)
Returns the specified global PublicDelegatedPrefix 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 (GlobalPublicDelegatedPrefixesClient globalPublicDelegatedPrefixesClient = GlobalPublicDelegatedPrefixesClient.create()) { String project = "project-309310695"; String publicDelegatedPrefix = "publicDelegatedPrefix-663003832"; PublicDelegatedPrefix response = globalPublicDelegatedPrefixesClient.get(project, publicDelegatedPrefix); }
- Parameters:
project
- Project ID for this request.publicDelegatedPrefix
- Name of the PublicDelegatedPrefix resource to return.- Throws:
com.google.api.gax.rpc.ApiException
- if the remote call fails
-
get
public final PublicDelegatedPrefix get(GetGlobalPublicDelegatedPrefixeRequest request)
Returns the specified global PublicDelegatedPrefix 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 (GlobalPublicDelegatedPrefixesClient globalPublicDelegatedPrefixesClient = GlobalPublicDelegatedPrefixesClient.create()) { GetGlobalPublicDelegatedPrefixeRequest request = GetGlobalPublicDelegatedPrefixeRequest.newBuilder() .setProject("project-309310695") .setPublicDelegatedPrefix("publicDelegatedPrefix-663003832") .build(); PublicDelegatedPrefix response = globalPublicDelegatedPrefixesClient.get(request); }
- Parameters:
request
- The request object containing all of the parameters for the API call.- Throws:
com.google.api.gax.rpc.ApiException
- if the remote call fails
-
getCallable
public final com.google.api.gax.rpc.UnaryCallable<GetGlobalPublicDelegatedPrefixeRequest,PublicDelegatedPrefix> getCallable()
Returns the specified global PublicDelegatedPrefix 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 (GlobalPublicDelegatedPrefixesClient globalPublicDelegatedPrefixesClient = GlobalPublicDelegatedPrefixesClient.create()) { GetGlobalPublicDelegatedPrefixeRequest request = GetGlobalPublicDelegatedPrefixeRequest.newBuilder() .setProject("project-309310695") .setPublicDelegatedPrefix("publicDelegatedPrefix-663003832") .build(); ApiFuture<PublicDelegatedPrefix> future = globalPublicDelegatedPrefixesClient.getCallable().futureCall(request); // Do something. PublicDelegatedPrefix response = future.get(); }
-
insertAsync
public final com.google.api.gax.longrunning.OperationFuture<Operation,Operation> insertAsync(String project, PublicDelegatedPrefix publicDelegatedPrefixResource)
Creates a global PublicDelegatedPrefix 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 (GlobalPublicDelegatedPrefixesClient globalPublicDelegatedPrefixesClient = GlobalPublicDelegatedPrefixesClient.create()) { String project = "project-309310695"; PublicDelegatedPrefix publicDelegatedPrefixResource = PublicDelegatedPrefix.newBuilder().build(); Operation response = globalPublicDelegatedPrefixesClient .insertAsync(project, publicDelegatedPrefixResource) .get(); }
- Parameters:
project
- Project ID for this request.publicDelegatedPrefixResource
- The body resource for this request- Throws:
com.google.api.gax.rpc.ApiException
- if the remote call fails
-
insertAsync
@BetaApi("The surface for long-running operations is not stable yet and may change in the future.") public final com.google.api.gax.longrunning.OperationFuture<Operation,Operation> insertAsync(InsertGlobalPublicDelegatedPrefixeRequest request)
Creates a global PublicDelegatedPrefix 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 (GlobalPublicDelegatedPrefixesClient globalPublicDelegatedPrefixesClient = GlobalPublicDelegatedPrefixesClient.create()) { InsertGlobalPublicDelegatedPrefixeRequest request = InsertGlobalPublicDelegatedPrefixeRequest.newBuilder() .setProject("project-309310695") .setPublicDelegatedPrefixResource(PublicDelegatedPrefix.newBuilder().build()) .setRequestId("requestId693933066") .build(); Operation response = globalPublicDelegatedPrefixesClient.insertAsync(request).get(); }
- Parameters:
request
- The request object containing all of the parameters for the API call.- Throws:
com.google.api.gax.rpc.ApiException
- if the remote call fails
-
insertOperationCallable
public final com.google.api.gax.rpc.OperationCallable<InsertGlobalPublicDelegatedPrefixeRequest,Operation,Operation> insertOperationCallable()
Creates a global PublicDelegatedPrefix 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 (GlobalPublicDelegatedPrefixesClient globalPublicDelegatedPrefixesClient = GlobalPublicDelegatedPrefixesClient.create()) { InsertGlobalPublicDelegatedPrefixeRequest request = InsertGlobalPublicDelegatedPrefixeRequest.newBuilder() .setProject("project-309310695") .setPublicDelegatedPrefixResource(PublicDelegatedPrefix.newBuilder().build()) .setRequestId("requestId693933066") .build(); OperationFuture<Operation, Operation> future = globalPublicDelegatedPrefixesClient.insertOperationCallable().futureCall(request); // Do something. Operation response = future.get(); }
-
insertCallable
public final com.google.api.gax.rpc.UnaryCallable<InsertGlobalPublicDelegatedPrefixeRequest,Operation> insertCallable()
Creates a global PublicDelegatedPrefix 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 (GlobalPublicDelegatedPrefixesClient globalPublicDelegatedPrefixesClient = GlobalPublicDelegatedPrefixesClient.create()) { InsertGlobalPublicDelegatedPrefixeRequest request = InsertGlobalPublicDelegatedPrefixeRequest.newBuilder() .setProject("project-309310695") .setPublicDelegatedPrefixResource(PublicDelegatedPrefix.newBuilder().build()) .setRequestId("requestId693933066") .build(); ApiFuture<Operation> future = globalPublicDelegatedPrefixesClient.insertCallable().futureCall(request); // Do something. Operation response = future.get(); }
-
list
public final GlobalPublicDelegatedPrefixesClient.ListPagedResponse list(String project)
Lists the global PublicDelegatedPrefixes 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 (GlobalPublicDelegatedPrefixesClient globalPublicDelegatedPrefixesClient = GlobalPublicDelegatedPrefixesClient.create()) { String project = "project-309310695"; for (PublicDelegatedPrefix element : globalPublicDelegatedPrefixesClient.list(project).iterateAll()) { // doThingsWith(element); } }
- Parameters:
project
- Project ID for this request.- Throws:
com.google.api.gax.rpc.ApiException
- if the remote call fails
-
list
public final GlobalPublicDelegatedPrefixesClient.ListPagedResponse list(ListGlobalPublicDelegatedPrefixesRequest request)
Lists the global PublicDelegatedPrefixes 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 (GlobalPublicDelegatedPrefixesClient globalPublicDelegatedPrefixesClient = GlobalPublicDelegatedPrefixesClient.create()) { ListGlobalPublicDelegatedPrefixesRequest request = ListGlobalPublicDelegatedPrefixesRequest.newBuilder() .setFilter("filter-1274492040") .setMaxResults(1128457243) .setOrderBy("orderBy-1207110587") .setPageToken("pageToken873572522") .setProject("project-309310695") .setReturnPartialSuccess(true) .build(); for (PublicDelegatedPrefix element : globalPublicDelegatedPrefixesClient.list(request).iterateAll()) { // doThingsWith(element); } }
- Parameters:
request
- The request object containing all of the parameters for the API call.- Throws:
com.google.api.gax.rpc.ApiException
- if the remote call fails
-
listPagedCallable
public final com.google.api.gax.rpc.UnaryCallable<ListGlobalPublicDelegatedPrefixesRequest,GlobalPublicDelegatedPrefixesClient.ListPagedResponse> listPagedCallable()
Lists the global PublicDelegatedPrefixes 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 (GlobalPublicDelegatedPrefixesClient globalPublicDelegatedPrefixesClient = GlobalPublicDelegatedPrefixesClient.create()) { ListGlobalPublicDelegatedPrefixesRequest request = ListGlobalPublicDelegatedPrefixesRequest.newBuilder() .setFilter("filter-1274492040") .setMaxResults(1128457243) .setOrderBy("orderBy-1207110587") .setPageToken("pageToken873572522") .setProject("project-309310695") .setReturnPartialSuccess(true) .build(); ApiFuture<PublicDelegatedPrefix> future = globalPublicDelegatedPrefixesClient.listPagedCallable().futureCall(request); // Do something. for (PublicDelegatedPrefix element : future.get().iterateAll()) { // doThingsWith(element); } }
-
listCallable
public final com.google.api.gax.rpc.UnaryCallable<ListGlobalPublicDelegatedPrefixesRequest,PublicDelegatedPrefixList> listCallable()
Lists the global PublicDelegatedPrefixes 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 (GlobalPublicDelegatedPrefixesClient globalPublicDelegatedPrefixesClient = GlobalPublicDelegatedPrefixesClient.create()) { ListGlobalPublicDelegatedPrefixesRequest request = ListGlobalPublicDelegatedPrefixesRequest.newBuilder() .setFilter("filter-1274492040") .setMaxResults(1128457243) .setOrderBy("orderBy-1207110587") .setPageToken("pageToken873572522") .setProject("project-309310695") .setReturnPartialSuccess(true) .build(); while (true) { PublicDelegatedPrefixList response = globalPublicDelegatedPrefixesClient.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; } } }
-
patchAsync
public final com.google.api.gax.longrunning.OperationFuture<Operation,Operation> patchAsync(String project, String publicDelegatedPrefix, PublicDelegatedPrefix publicDelegatedPrefixResource)
Patches the specified global 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 (GlobalPublicDelegatedPrefixesClient globalPublicDelegatedPrefixesClient = GlobalPublicDelegatedPrefixesClient.create()) { String project = "project-309310695"; String publicDelegatedPrefix = "publicDelegatedPrefix-663003832"; PublicDelegatedPrefix publicDelegatedPrefixResource = PublicDelegatedPrefix.newBuilder().build(); Operation response = globalPublicDelegatedPrefixesClient .patchAsync(project, publicDelegatedPrefix, publicDelegatedPrefixResource) .get(); }
- Parameters:
project
- Project ID for this request.publicDelegatedPrefix
- Name of the PublicDelegatedPrefix resource to patch.publicDelegatedPrefixResource
- The body resource for this request- Throws:
com.google.api.gax.rpc.ApiException
- if the remote call fails
-
patchAsync
@BetaApi("The surface for long-running operations is not stable yet and may change in the future.") public final com.google.api.gax.longrunning.OperationFuture<Operation,Operation> patchAsync(PatchGlobalPublicDelegatedPrefixeRequest request)
Patches the specified global 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 (GlobalPublicDelegatedPrefixesClient globalPublicDelegatedPrefixesClient = GlobalPublicDelegatedPrefixesClient.create()) { PatchGlobalPublicDelegatedPrefixeRequest request = PatchGlobalPublicDelegatedPrefixeRequest.newBuilder() .setProject("project-309310695") .setPublicDelegatedPrefix("publicDelegatedPrefix-663003832") .setPublicDelegatedPrefixResource(PublicDelegatedPrefix.newBuilder().build()) .setRequestId("requestId693933066") .build(); Operation response = globalPublicDelegatedPrefixesClient.patchAsync(request).get(); }
- Parameters:
request
- The request object containing all of the parameters for the API call.- Throws:
com.google.api.gax.rpc.ApiException
- if the remote call fails
-
patchOperationCallable
public final com.google.api.gax.rpc.OperationCallable<PatchGlobalPublicDelegatedPrefixeRequest,Operation,Operation> patchOperationCallable()
Patches the specified global 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 (GlobalPublicDelegatedPrefixesClient globalPublicDelegatedPrefixesClient = GlobalPublicDelegatedPrefixesClient.create()) { PatchGlobalPublicDelegatedPrefixeRequest request = PatchGlobalPublicDelegatedPrefixeRequest.newBuilder() .setProject("project-309310695") .setPublicDelegatedPrefix("publicDelegatedPrefix-663003832") .setPublicDelegatedPrefixResource(PublicDelegatedPrefix.newBuilder().build()) .setRequestId("requestId693933066") .build(); OperationFuture<Operation, Operation> future = globalPublicDelegatedPrefixesClient.patchOperationCallable().futureCall(request); // Do something. Operation response = future.get(); }
-
patchCallable
public final com.google.api.gax.rpc.UnaryCallable<PatchGlobalPublicDelegatedPrefixeRequest,Operation> patchCallable()
Patches the specified global 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 (GlobalPublicDelegatedPrefixesClient globalPublicDelegatedPrefixesClient = GlobalPublicDelegatedPrefixesClient.create()) { PatchGlobalPublicDelegatedPrefixeRequest request = PatchGlobalPublicDelegatedPrefixeRequest.newBuilder() .setProject("project-309310695") .setPublicDelegatedPrefix("publicDelegatedPrefix-663003832") .setPublicDelegatedPrefixResource(PublicDelegatedPrefix.newBuilder().build()) .setRequestId("requestId693933066") .build(); ApiFuture<Operation> future = globalPublicDelegatedPrefixesClient.patchCallable().futureCall(request); // Do something. Operation response = future.get(); }
-
close
public final void close()
- Specified by:
close
in interfaceAutoCloseable
-
shutdown
public void shutdown()
- Specified by:
shutdown
in interfacecom.google.api.gax.core.BackgroundResource
-
isShutdown
public boolean isShutdown()
- Specified by:
isShutdown
in interfacecom.google.api.gax.core.BackgroundResource
-
isTerminated
public boolean isTerminated()
- Specified by:
isTerminated
in interfacecom.google.api.gax.core.BackgroundResource
-
shutdownNow
public void shutdownNow()
- Specified by:
shutdownNow
in interfacecom.google.api.gax.core.BackgroundResource
-
awaitTermination
public boolean awaitTermination(long duration, TimeUnit unit) throws InterruptedException
- Specified by:
awaitTermination
in interfacecom.google.api.gax.core.BackgroundResource
- Throws:
InterruptedException
-
-