Class NetworkAttachmentsClient
- java.lang.Object
-
- com.google.cloud.compute.v1.NetworkAttachmentsClient
-
- All Implemented Interfaces:
com.google.api.gax.core.BackgroundResource
,AutoCloseable
@Generated("by gapic-generator-java") public class NetworkAttachmentsClient extends Object implements com.google.api.gax.core.BackgroundResource
Service Description: The NetworkAttachments 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 (NetworkAttachmentsClient networkAttachmentsClient = NetworkAttachmentsClient.create()) { String project = "project-309310695"; String region = "region-934795532"; String networkAttachment = "networkAttachment1918512625"; NetworkAttachment response = networkAttachmentsClient.get(project, region, networkAttachment); }
Note: close() needs to be called on the NetworkAttachmentsClient 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 NetworkAttachmentsSettings 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 NetworkAttachmentsSettings networkAttachmentsSettings = NetworkAttachmentsSettings.newBuilder() .setCredentialsProvider(FixedCredentialsProvider.create(myCredentials)) .build(); NetworkAttachmentsClient networkAttachmentsClient = NetworkAttachmentsClient.create(networkAttachmentsSettings);
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 NetworkAttachmentsSettings networkAttachmentsSettings = NetworkAttachmentsSettings.newBuilder().setEndpoint(myEndpoint).build(); NetworkAttachmentsClient networkAttachmentsClient = NetworkAttachmentsClient.create(networkAttachmentsSettings);
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
NetworkAttachmentsClient.AggregatedListFixedSizeCollection
static class
NetworkAttachmentsClient.AggregatedListPage
static class
NetworkAttachmentsClient.AggregatedListPagedResponse
static class
NetworkAttachmentsClient.ListFixedSizeCollection
static class
NetworkAttachmentsClient.ListPage
static class
NetworkAttachmentsClient.ListPagedResponse
-
Constructor Summary
Constructors Modifier Constructor Description protected
NetworkAttachmentsClient(NetworkAttachmentsSettings settings)
Constructs an instance of NetworkAttachmentsClient, using the given settings.protected
NetworkAttachmentsClient(NetworkAttachmentsStub stub)
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description NetworkAttachmentsClient.AggregatedListPagedResponse
aggregatedList(AggregatedListNetworkAttachmentsRequest request)
Retrieves the list of all NetworkAttachment resources, regional and global, available to the specified project.NetworkAttachmentsClient.AggregatedListPagedResponse
aggregatedList(String project)
Retrieves the list of all NetworkAttachment resources, regional and global, available to the specified project.com.google.api.gax.rpc.UnaryCallable<AggregatedListNetworkAttachmentsRequest,NetworkAttachmentAggregatedList>
aggregatedListCallable()
Retrieves the list of all NetworkAttachment resources, regional and global, available to the specified project.com.google.api.gax.rpc.UnaryCallable<AggregatedListNetworkAttachmentsRequest,NetworkAttachmentsClient.AggregatedListPagedResponse>
aggregatedListPagedCallable()
Retrieves the list of all NetworkAttachment resources, regional and global, available to the specified project.boolean
awaitTermination(long duration, TimeUnit unit)
void
close()
static NetworkAttachmentsClient
create()
Constructs an instance of NetworkAttachmentsClient with default settings.static NetworkAttachmentsClient
create(NetworkAttachmentsSettings settings)
Constructs an instance of NetworkAttachmentsClient, using the given settings.static NetworkAttachmentsClient
create(NetworkAttachmentsStub stub)
Constructs an instance of NetworkAttachmentsClient, using the given stub for making calls.com.google.api.gax.longrunning.OperationFuture<Operation,Operation>
deleteAsync(DeleteNetworkAttachmentRequest request)
Deletes the specified NetworkAttachment in the given scopecom.google.api.gax.longrunning.OperationFuture<Operation,Operation>
deleteAsync(String project, String region, String networkAttachment)
Deletes the specified NetworkAttachment in the given scopecom.google.api.gax.rpc.UnaryCallable<DeleteNetworkAttachmentRequest,Operation>
deleteCallable()
Deletes the specified NetworkAttachment in the given scopecom.google.api.gax.rpc.OperationCallable<DeleteNetworkAttachmentRequest,Operation,Operation>
deleteOperationCallable()
Deletes the specified NetworkAttachment in the given scopeNetworkAttachment
get(GetNetworkAttachmentRequest request)
Returns the specified NetworkAttachment resource in the given scope.NetworkAttachment
get(String project, String region, String networkAttachment)
Returns the specified NetworkAttachment resource in the given scope.com.google.api.gax.rpc.UnaryCallable<GetNetworkAttachmentRequest,NetworkAttachment>
getCallable()
Returns the specified NetworkAttachment resource in the given scope.Policy
getIamPolicy(GetIamPolicyNetworkAttachmentRequest request)
Gets the access control policy for a resource.Policy
getIamPolicy(String project, String region, String resource)
Gets the access control policy for a resource.com.google.api.gax.rpc.UnaryCallable<GetIamPolicyNetworkAttachmentRequest,Policy>
getIamPolicyCallable()
Gets the access control policy for a resource.NetworkAttachmentsSettings
getSettings()
NetworkAttachmentsStub
getStub()
com.google.api.gax.longrunning.OperationFuture<Operation,Operation>
insertAsync(InsertNetworkAttachmentRequest request)
Creates a NetworkAttachment in the specified project in the given scope using the parameters that are included in the request.com.google.api.gax.longrunning.OperationFuture<Operation,Operation>
insertAsync(String project, String region, NetworkAttachment networkAttachmentResource)
Creates a NetworkAttachment in the specified project in the given scope using the parameters that are included in the request.com.google.api.gax.rpc.UnaryCallable<InsertNetworkAttachmentRequest,Operation>
insertCallable()
Creates a NetworkAttachment in the specified project in the given scope using the parameters that are included in the request.com.google.api.gax.rpc.OperationCallable<InsertNetworkAttachmentRequest,Operation,Operation>
insertOperationCallable()
Creates a NetworkAttachment in the specified project in the given scope using the parameters that are included in the request.boolean
isShutdown()
boolean
isTerminated()
NetworkAttachmentsClient.ListPagedResponse
list(ListNetworkAttachmentsRequest request)
Lists the NetworkAttachments for a project in the given scope.NetworkAttachmentsClient.ListPagedResponse
list(String project, String region)
Lists the NetworkAttachments for a project in the given scope.com.google.api.gax.rpc.UnaryCallable<ListNetworkAttachmentsRequest,NetworkAttachmentList>
listCallable()
Lists the NetworkAttachments for a project in the given scope.com.google.api.gax.rpc.UnaryCallable<ListNetworkAttachmentsRequest,NetworkAttachmentsClient.ListPagedResponse>
listPagedCallable()
Lists the NetworkAttachments for a project in the given scope.Policy
setIamPolicy(SetIamPolicyNetworkAttachmentRequest request)
Sets the access control policy on the specified resource.Policy
setIamPolicy(String project, String region, String resource, RegionSetPolicyRequest regionSetPolicyRequestResource)
Sets the access control policy on the specified resource.com.google.api.gax.rpc.UnaryCallable<SetIamPolicyNetworkAttachmentRequest,Policy>
setIamPolicyCallable()
Sets the access control policy on the specified resource.void
shutdown()
void
shutdownNow()
TestPermissionsResponse
testIamPermissions(TestIamPermissionsNetworkAttachmentRequest request)
Returns permissions that a caller has on the specified resource.TestPermissionsResponse
testIamPermissions(String project, String region, String resource, TestPermissionsRequest testPermissionsRequestResource)
Returns permissions that a caller has on the specified resource.com.google.api.gax.rpc.UnaryCallable<TestIamPermissionsNetworkAttachmentRequest,TestPermissionsResponse>
testIamPermissionsCallable()
Returns permissions that a caller has on the specified resource.
-
-
-
Constructor Detail
-
NetworkAttachmentsClient
protected NetworkAttachmentsClient(NetworkAttachmentsSettings settings) throws IOException
Constructs an instance of NetworkAttachmentsClient, 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
-
NetworkAttachmentsClient
protected NetworkAttachmentsClient(NetworkAttachmentsStub stub)
-
-
Method Detail
-
create
public static final NetworkAttachmentsClient create() throws IOException
Constructs an instance of NetworkAttachmentsClient with default settings.- Throws:
IOException
-
create
public static final NetworkAttachmentsClient create(NetworkAttachmentsSettings settings) throws IOException
Constructs an instance of NetworkAttachmentsClient, 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 NetworkAttachmentsClient create(NetworkAttachmentsStub stub)
Constructs an instance of NetworkAttachmentsClient, using the given stub for making calls. This is for advanced usage - prefer using create(NetworkAttachmentsSettings).
-
getSettings
public final NetworkAttachmentsSettings getSettings()
-
getStub
public NetworkAttachmentsStub getStub()
-
aggregatedList
public final NetworkAttachmentsClient.AggregatedListPagedResponse aggregatedList(String project)
Retrieves the list of all NetworkAttachment resources, regional and global, available to the specified project.Sample code:
// This snippet has been automatically generated and should be regarded as a code template only. // It will require modifications to work: // - It may require correct/in-range values for request initialization. // - It may require specifying regional endpoints when creating the service client as shown in // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library try (NetworkAttachmentsClient networkAttachmentsClient = NetworkAttachmentsClient.create()) { String project = "project-309310695"; for (Map.Entry<String, NetworkAttachmentsScopedList> element : networkAttachmentsClient.aggregatedList(project).iterateAll()) { // doThingsWith(element); } }
- Parameters:
project
- Project ID for this request.- Throws:
com.google.api.gax.rpc.ApiException
- if the remote call fails
-
aggregatedList
public final NetworkAttachmentsClient.AggregatedListPagedResponse aggregatedList(AggregatedListNetworkAttachmentsRequest request)
Retrieves the list of all NetworkAttachment resources, regional and global, available to the specified project.Sample code:
// This snippet has been automatically generated and should be regarded as a code template only. // It will require modifications to work: // - It may require correct/in-range values for request initialization. // - It may require specifying regional endpoints when creating the service client as shown in // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library try (NetworkAttachmentsClient networkAttachmentsClient = NetworkAttachmentsClient.create()) { AggregatedListNetworkAttachmentsRequest request = AggregatedListNetworkAttachmentsRequest.newBuilder() .setFilter("filter-1274492040") .setIncludeAllScopes(true) .setMaxResults(1128457243) .setOrderBy("orderBy-1207110587") .setPageToken("pageToken873572522") .setProject("project-309310695") .setReturnPartialSuccess(true) .build(); for (Map.Entry<String, NetworkAttachmentsScopedList> element : networkAttachmentsClient.aggregatedList(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
-
aggregatedListPagedCallable
public final com.google.api.gax.rpc.UnaryCallable<AggregatedListNetworkAttachmentsRequest,NetworkAttachmentsClient.AggregatedListPagedResponse> aggregatedListPagedCallable()
Retrieves the list of all NetworkAttachment resources, regional and global, available to the specified project.Sample code:
// This snippet has been automatically generated and should be regarded as a code template only. // It will require modifications to work: // - It may require correct/in-range values for request initialization. // - It may require specifying regional endpoints when creating the service client as shown in // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library try (NetworkAttachmentsClient networkAttachmentsClient = NetworkAttachmentsClient.create()) { AggregatedListNetworkAttachmentsRequest request = AggregatedListNetworkAttachmentsRequest.newBuilder() .setFilter("filter-1274492040") .setIncludeAllScopes(true) .setMaxResults(1128457243) .setOrderBy("orderBy-1207110587") .setPageToken("pageToken873572522") .setProject("project-309310695") .setReturnPartialSuccess(true) .build(); ApiFuture<Map.Entry<String, NetworkAttachmentsScopedList>> future = networkAttachmentsClient.aggregatedListPagedCallable().futureCall(request); // Do something. for (Map.Entry<String, NetworkAttachmentsScopedList> element : future.get().iterateAll()) { // doThingsWith(element); } }
-
aggregatedListCallable
public final com.google.api.gax.rpc.UnaryCallable<AggregatedListNetworkAttachmentsRequest,NetworkAttachmentAggregatedList> aggregatedListCallable()
Retrieves the list of all NetworkAttachment resources, regional and global, available to the specified project.Sample code:
// This snippet has been automatically generated and should be regarded as a code template only. // It will require modifications to work: // - It may require correct/in-range values for request initialization. // - It may require specifying regional endpoints when creating the service client as shown in // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library try (NetworkAttachmentsClient networkAttachmentsClient = NetworkAttachmentsClient.create()) { AggregatedListNetworkAttachmentsRequest request = AggregatedListNetworkAttachmentsRequest.newBuilder() .setFilter("filter-1274492040") .setIncludeAllScopes(true) .setMaxResults(1128457243) .setOrderBy("orderBy-1207110587") .setPageToken("pageToken873572522") .setProject("project-309310695") .setReturnPartialSuccess(true) .build(); while (true) { NetworkAttachmentAggregatedList response = networkAttachmentsClient.aggregatedListCallable().call(request); for (Map.Entry<String, NetworkAttachmentsScopedList> element : response.getItemsList()) { // doThingsWith(element); } String nextPageToken = response.getNextPageToken(); if (!Strings.isNullOrEmpty(nextPageToken)) { request = request.toBuilder().setPageToken(nextPageToken).build(); } else { break; } } }
-
deleteAsync
public final com.google.api.gax.longrunning.OperationFuture<Operation,Operation> deleteAsync(String project, String region, String networkAttachment)
Deletes the specified NetworkAttachment in the given scopeSample 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 (NetworkAttachmentsClient networkAttachmentsClient = NetworkAttachmentsClient.create()) { String project = "project-309310695"; String region = "region-934795532"; String networkAttachment = "networkAttachment1918512625"; Operation response = networkAttachmentsClient.deleteAsync(project, region, networkAttachment).get(); }
- Parameters:
project
- Project ID for this request.region
- Name of the region of this request.networkAttachment
- Name of the NetworkAttachment 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(DeleteNetworkAttachmentRequest request)
Deletes the specified NetworkAttachment in the given scopeSample 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 (NetworkAttachmentsClient networkAttachmentsClient = NetworkAttachmentsClient.create()) { DeleteNetworkAttachmentRequest request = DeleteNetworkAttachmentRequest.newBuilder() .setNetworkAttachment("networkAttachment1918512625") .setProject("project-309310695") .setRegion("region-934795532") .setRequestId("requestId693933066") .build(); Operation response = networkAttachmentsClient.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<DeleteNetworkAttachmentRequest,Operation,Operation> deleteOperationCallable()
Deletes the specified NetworkAttachment in the given scopeSample 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 (NetworkAttachmentsClient networkAttachmentsClient = NetworkAttachmentsClient.create()) { DeleteNetworkAttachmentRequest request = DeleteNetworkAttachmentRequest.newBuilder() .setNetworkAttachment("networkAttachment1918512625") .setProject("project-309310695") .setRegion("region-934795532") .setRequestId("requestId693933066") .build(); OperationFuture<Operation, Operation> future = networkAttachmentsClient.deleteOperationCallable().futureCall(request); // Do something. Operation response = future.get(); }
-
deleteCallable
public final com.google.api.gax.rpc.UnaryCallable<DeleteNetworkAttachmentRequest,Operation> deleteCallable()
Deletes the specified NetworkAttachment in the given scopeSample 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 (NetworkAttachmentsClient networkAttachmentsClient = NetworkAttachmentsClient.create()) { DeleteNetworkAttachmentRequest request = DeleteNetworkAttachmentRequest.newBuilder() .setNetworkAttachment("networkAttachment1918512625") .setProject("project-309310695") .setRegion("region-934795532") .setRequestId("requestId693933066") .build(); ApiFuture<Operation> future = networkAttachmentsClient.deleteCallable().futureCall(request); // Do something. Operation response = future.get(); }
-
get
public final NetworkAttachment get(String project, String region, String networkAttachment)
Returns the specified NetworkAttachment resource in the given scope.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 (NetworkAttachmentsClient networkAttachmentsClient = NetworkAttachmentsClient.create()) { String project = "project-309310695"; String region = "region-934795532"; String networkAttachment = "networkAttachment1918512625"; NetworkAttachment response = networkAttachmentsClient.get(project, region, networkAttachment); }
- Parameters:
project
- Project ID for this request.region
- Name of the region of this request.networkAttachment
- Name of the NetworkAttachment resource to return.- Throws:
com.google.api.gax.rpc.ApiException
- if the remote call fails
-
get
public final NetworkAttachment get(GetNetworkAttachmentRequest request)
Returns the specified NetworkAttachment resource in the given scope.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 (NetworkAttachmentsClient networkAttachmentsClient = NetworkAttachmentsClient.create()) { GetNetworkAttachmentRequest request = GetNetworkAttachmentRequest.newBuilder() .setNetworkAttachment("networkAttachment1918512625") .setProject("project-309310695") .setRegion("region-934795532") .build(); NetworkAttachment response = networkAttachmentsClient.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<GetNetworkAttachmentRequest,NetworkAttachment> getCallable()
Returns the specified NetworkAttachment resource in the given scope.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 (NetworkAttachmentsClient networkAttachmentsClient = NetworkAttachmentsClient.create()) { GetNetworkAttachmentRequest request = GetNetworkAttachmentRequest.newBuilder() .setNetworkAttachment("networkAttachment1918512625") .setProject("project-309310695") .setRegion("region-934795532") .build(); ApiFuture<NetworkAttachment> future = networkAttachmentsClient.getCallable().futureCall(request); // Do something. NetworkAttachment response = future.get(); }
-
getIamPolicy
public final Policy getIamPolicy(String project, String region, String resource)
Gets the access control policy for a resource. May be empty if no such policy or resource exists.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 (NetworkAttachmentsClient networkAttachmentsClient = NetworkAttachmentsClient.create()) { String project = "project-309310695"; String region = "region-934795532"; String resource = "resource-341064690"; Policy response = networkAttachmentsClient.getIamPolicy(project, region, resource); }
- Parameters:
project
- Project ID for this request.region
- The name of the region for this request.resource
- Name or id of the resource for this request.- Throws:
com.google.api.gax.rpc.ApiException
- if the remote call fails
-
getIamPolicy
public final Policy getIamPolicy(GetIamPolicyNetworkAttachmentRequest request)
Gets the access control policy for a resource. May be empty if no such policy or resource exists.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 (NetworkAttachmentsClient networkAttachmentsClient = NetworkAttachmentsClient.create()) { GetIamPolicyNetworkAttachmentRequest request = GetIamPolicyNetworkAttachmentRequest.newBuilder() .setOptionsRequestedPolicyVersion(-574521795) .setProject("project-309310695") .setRegion("region-934795532") .setResource("resource-341064690") .build(); Policy response = networkAttachmentsClient.getIamPolicy(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
-
getIamPolicyCallable
public final com.google.api.gax.rpc.UnaryCallable<GetIamPolicyNetworkAttachmentRequest,Policy> getIamPolicyCallable()
Gets the access control policy for a resource. May be empty if no such policy or resource exists.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 (NetworkAttachmentsClient networkAttachmentsClient = NetworkAttachmentsClient.create()) { GetIamPolicyNetworkAttachmentRequest request = GetIamPolicyNetworkAttachmentRequest.newBuilder() .setOptionsRequestedPolicyVersion(-574521795) .setProject("project-309310695") .setRegion("region-934795532") .setResource("resource-341064690") .build(); ApiFuture<Policy> future = networkAttachmentsClient.getIamPolicyCallable().futureCall(request); // Do something. Policy response = future.get(); }
-
insertAsync
public final com.google.api.gax.longrunning.OperationFuture<Operation,Operation> insertAsync(String project, String region, NetworkAttachment networkAttachmentResource)
Creates a NetworkAttachment in the specified project in the given scope 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 (NetworkAttachmentsClient networkAttachmentsClient = NetworkAttachmentsClient.create()) { String project = "project-309310695"; String region = "region-934795532"; NetworkAttachment networkAttachmentResource = NetworkAttachment.newBuilder().build(); Operation response = networkAttachmentsClient.insertAsync(project, region, networkAttachmentResource).get(); }
- Parameters:
project
- Project ID for this request.region
- Name of the region of this request.networkAttachmentResource
- 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(InsertNetworkAttachmentRequest request)
Creates a NetworkAttachment in the specified project in the given scope 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 (NetworkAttachmentsClient networkAttachmentsClient = NetworkAttachmentsClient.create()) { InsertNetworkAttachmentRequest request = InsertNetworkAttachmentRequest.newBuilder() .setNetworkAttachmentResource(NetworkAttachment.newBuilder().build()) .setProject("project-309310695") .setRegion("region-934795532") .setRequestId("requestId693933066") .build(); Operation response = networkAttachmentsClient.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<InsertNetworkAttachmentRequest,Operation,Operation> insertOperationCallable()
Creates a NetworkAttachment in the specified project in the given scope 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 (NetworkAttachmentsClient networkAttachmentsClient = NetworkAttachmentsClient.create()) { InsertNetworkAttachmentRequest request = InsertNetworkAttachmentRequest.newBuilder() .setNetworkAttachmentResource(NetworkAttachment.newBuilder().build()) .setProject("project-309310695") .setRegion("region-934795532") .setRequestId("requestId693933066") .build(); OperationFuture<Operation, Operation> future = networkAttachmentsClient.insertOperationCallable().futureCall(request); // Do something. Operation response = future.get(); }
-
insertCallable
public final com.google.api.gax.rpc.UnaryCallable<InsertNetworkAttachmentRequest,Operation> insertCallable()
Creates a NetworkAttachment in the specified project in the given scope 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 (NetworkAttachmentsClient networkAttachmentsClient = NetworkAttachmentsClient.create()) { InsertNetworkAttachmentRequest request = InsertNetworkAttachmentRequest.newBuilder() .setNetworkAttachmentResource(NetworkAttachment.newBuilder().build()) .setProject("project-309310695") .setRegion("region-934795532") .setRequestId("requestId693933066") .build(); ApiFuture<Operation> future = networkAttachmentsClient.insertCallable().futureCall(request); // Do something. Operation response = future.get(); }
-
list
public final NetworkAttachmentsClient.ListPagedResponse list(String project, String region)
Lists the NetworkAttachments for a project in the given scope.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 (NetworkAttachmentsClient networkAttachmentsClient = NetworkAttachmentsClient.create()) { String project = "project-309310695"; String region = "region-934795532"; for (NetworkAttachment element : networkAttachmentsClient.list(project, region).iterateAll()) { // doThingsWith(element); } }
- Parameters:
project
- Project ID for this request.region
- Name of the region of this request.- Throws:
com.google.api.gax.rpc.ApiException
- if the remote call fails
-
list
public final NetworkAttachmentsClient.ListPagedResponse list(ListNetworkAttachmentsRequest request)
Lists the NetworkAttachments for a project in the given scope.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 (NetworkAttachmentsClient networkAttachmentsClient = NetworkAttachmentsClient.create()) { ListNetworkAttachmentsRequest request = ListNetworkAttachmentsRequest.newBuilder() .setFilter("filter-1274492040") .setMaxResults(1128457243) .setOrderBy("orderBy-1207110587") .setPageToken("pageToken873572522") .setProject("project-309310695") .setRegion("region-934795532") .setReturnPartialSuccess(true) .build(); for (NetworkAttachment element : networkAttachmentsClient.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<ListNetworkAttachmentsRequest,NetworkAttachmentsClient.ListPagedResponse> listPagedCallable()
Lists the NetworkAttachments for a project in the given scope.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 (NetworkAttachmentsClient networkAttachmentsClient = NetworkAttachmentsClient.create()) { ListNetworkAttachmentsRequest request = ListNetworkAttachmentsRequest.newBuilder() .setFilter("filter-1274492040") .setMaxResults(1128457243) .setOrderBy("orderBy-1207110587") .setPageToken("pageToken873572522") .setProject("project-309310695") .setRegion("region-934795532") .setReturnPartialSuccess(true) .build(); ApiFuture<NetworkAttachment> future = networkAttachmentsClient.listPagedCallable().futureCall(request); // Do something. for (NetworkAttachment element : future.get().iterateAll()) { // doThingsWith(element); } }
-
listCallable
public final com.google.api.gax.rpc.UnaryCallable<ListNetworkAttachmentsRequest,NetworkAttachmentList> listCallable()
Lists the NetworkAttachments for a project in the given scope.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 (NetworkAttachmentsClient networkAttachmentsClient = NetworkAttachmentsClient.create()) { ListNetworkAttachmentsRequest request = ListNetworkAttachmentsRequest.newBuilder() .setFilter("filter-1274492040") .setMaxResults(1128457243) .setOrderBy("orderBy-1207110587") .setPageToken("pageToken873572522") .setProject("project-309310695") .setRegion("region-934795532") .setReturnPartialSuccess(true) .build(); while (true) { NetworkAttachmentList response = networkAttachmentsClient.listCallable().call(request); for (NetworkAttachment element : response.getItemsList()) { // doThingsWith(element); } String nextPageToken = response.getNextPageToken(); if (!Strings.isNullOrEmpty(nextPageToken)) { request = request.toBuilder().setPageToken(nextPageToken).build(); } else { break; } } }
-
setIamPolicy
public final Policy setIamPolicy(String project, String region, String resource, RegionSetPolicyRequest regionSetPolicyRequestResource)
Sets the access control policy on the specified resource. Replaces any existing policy.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 (NetworkAttachmentsClient networkAttachmentsClient = NetworkAttachmentsClient.create()) { String project = "project-309310695"; String region = "region-934795532"; String resource = "resource-341064690"; RegionSetPolicyRequest regionSetPolicyRequestResource = RegionSetPolicyRequest.newBuilder().build(); Policy response = networkAttachmentsClient.setIamPolicy( project, region, resource, regionSetPolicyRequestResource); }
- Parameters:
project
- Project ID for this request.region
- The name of the region for this request.resource
- Name or id of the resource for this request.regionSetPolicyRequestResource
- The body resource for this request- Throws:
com.google.api.gax.rpc.ApiException
- if the remote call fails
-
setIamPolicy
public final Policy setIamPolicy(SetIamPolicyNetworkAttachmentRequest request)
Sets the access control policy on the specified resource. Replaces any existing policy.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 (NetworkAttachmentsClient networkAttachmentsClient = NetworkAttachmentsClient.create()) { SetIamPolicyNetworkAttachmentRequest request = SetIamPolicyNetworkAttachmentRequest.newBuilder() .setProject("project-309310695") .setRegion("region-934795532") .setRegionSetPolicyRequestResource(RegionSetPolicyRequest.newBuilder().build()) .setResource("resource-341064690") .build(); Policy response = networkAttachmentsClient.setIamPolicy(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
-
setIamPolicyCallable
public final com.google.api.gax.rpc.UnaryCallable<SetIamPolicyNetworkAttachmentRequest,Policy> setIamPolicyCallable()
Sets the access control policy on the specified resource. Replaces any existing policy.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 (NetworkAttachmentsClient networkAttachmentsClient = NetworkAttachmentsClient.create()) { SetIamPolicyNetworkAttachmentRequest request = SetIamPolicyNetworkAttachmentRequest.newBuilder() .setProject("project-309310695") .setRegion("region-934795532") .setRegionSetPolicyRequestResource(RegionSetPolicyRequest.newBuilder().build()) .setResource("resource-341064690") .build(); ApiFuture<Policy> future = networkAttachmentsClient.setIamPolicyCallable().futureCall(request); // Do something. Policy response = future.get(); }
-
testIamPermissions
public final TestPermissionsResponse testIamPermissions(String project, String region, String resource, TestPermissionsRequest testPermissionsRequestResource)
Returns permissions that a caller has on the specified 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 (NetworkAttachmentsClient networkAttachmentsClient = NetworkAttachmentsClient.create()) { String project = "project-309310695"; String region = "region-934795532"; String resource = "resource-341064690"; TestPermissionsRequest testPermissionsRequestResource = TestPermissionsRequest.newBuilder().build(); TestPermissionsResponse response = networkAttachmentsClient.testIamPermissions( project, region, resource, testPermissionsRequestResource); }
- Parameters:
project
- Project ID for this request.region
- The name of the region for this request.resource
- Name or id of the resource for this request.testPermissionsRequestResource
- The body resource for this request- Throws:
com.google.api.gax.rpc.ApiException
- if the remote call fails
-
testIamPermissions
public final TestPermissionsResponse testIamPermissions(TestIamPermissionsNetworkAttachmentRequest request)
Returns permissions that a caller has on the specified 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 (NetworkAttachmentsClient networkAttachmentsClient = NetworkAttachmentsClient.create()) { TestIamPermissionsNetworkAttachmentRequest request = TestIamPermissionsNetworkAttachmentRequest.newBuilder() .setProject("project-309310695") .setRegion("region-934795532") .setResource("resource-341064690") .setTestPermissionsRequestResource(TestPermissionsRequest.newBuilder().build()) .build(); TestPermissionsResponse response = networkAttachmentsClient.testIamPermissions(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
-
testIamPermissionsCallable
public final com.google.api.gax.rpc.UnaryCallable<TestIamPermissionsNetworkAttachmentRequest,TestPermissionsResponse> testIamPermissionsCallable()
Returns permissions that a caller has on the specified 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 (NetworkAttachmentsClient networkAttachmentsClient = NetworkAttachmentsClient.create()) { TestIamPermissionsNetworkAttachmentRequest request = TestIamPermissionsNetworkAttachmentRequest.newBuilder() .setProject("project-309310695") .setRegion("region-934795532") .setResource("resource-341064690") .setTestPermissionsRequestResource(TestPermissionsRequest.newBuilder().build()) .build(); ApiFuture<TestPermissionsResponse> future = networkAttachmentsClient.testIamPermissionsCallable().futureCall(request); // Do something. TestPermissionsResponse 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
-
-