Class NetworkAttachmentsClient (1.47.0)

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

Methods
Method	Description	Method Variants
AggregatedList	Retrieves the list of all NetworkAttachment resources, regional and global, available to the specified project. To prevent failure, Google recommends that you set the `returnPartialSuccess` parameter to `true`.	Request object method variants only take one parameter, a request object, which must be constructed before the call. aggregatedList(AggregatedListNetworkAttachmentsRequest request) "Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method. aggregatedList(String project) Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. aggregatedListPagedCallable() aggregatedListCallable()
Delete	Deletes the specified NetworkAttachment in the given scope	Request object method variants only take one parameter, a request object, which must be constructed before the call. deleteAsync(DeleteNetworkAttachmentRequest request) Methods that return long-running operations have "Async" method variants that return `OperationFuture`, which is used to track polling of the service. deleteAsync(String project, String region, String networkAttachment) Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. deleteOperationCallable() deleteCallable()
Get	Returns the specified NetworkAttachment resource in the given scope.	Request object method variants only take one parameter, a request object, which must be constructed before the call. get(GetNetworkAttachmentRequest request) "Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method. get(String project, String region, String networkAttachment) Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. getCallable()
GetIamPolicy	Gets the access control policy for a resource. May be empty if no such policy or resource exists.	Request object method variants only take one parameter, a request object, which must be constructed before the call. getIamPolicy(GetIamPolicyNetworkAttachmentRequest request) "Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method. getIamPolicy(String project, String region, String resource) Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. getIamPolicyCallable()
Insert	Creates a NetworkAttachment in the specified project in the given scope using the parameters that are included in the request.	Request object method variants only take one parameter, a request object, which must be constructed before the call. insertAsync(InsertNetworkAttachmentRequest request) Methods that return long-running operations have "Async" method variants that return `OperationFuture`, which is used to track polling of the service. insertAsync(String project, String region, NetworkAttachment networkAttachmentResource) Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. insertOperationCallable() insertCallable()
List	Lists the NetworkAttachments for a project in the given scope.	Request object method variants only take one parameter, a request object, which must be constructed before the call. list(ListNetworkAttachmentsRequest request) "Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method. list(String project, String region) Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. listPagedCallable() listCallable()
Patch	Patches the specified NetworkAttachment resource with the data included in the request. This method supports PATCH semantics and uses JSON merge patch format and processing rules.	Request object method variants only take one parameter, a request object, which must be constructed before the call. patchAsync(PatchNetworkAttachmentRequest request) Methods that return long-running operations have "Async" method variants that return `OperationFuture`, which is used to track polling of the service. patchAsync(String project, String region, String networkAttachment, NetworkAttachment networkAttachmentResource) Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. patchOperationCallable() patchCallable()
SetIamPolicy	Sets the access control policy on the specified resource. Replaces any existing policy.	Request object method variants only take one parameter, a request object, which must be constructed before the call. setIamPolicy(SetIamPolicyNetworkAttachmentRequest request) "Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method. setIamPolicy(String project, String region, String resource, RegionSetPolicyRequest regionSetPolicyRequestResource) Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. setIamPolicyCallable()
TestIamPermissions	Returns permissions that a caller has on the specified resource.	Request object method variants only take one parameter, a request object, which must be constructed before the call. testIamPermissions(TestIamPermissionsNetworkAttachmentRequest request) "Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method. testIamPermissions(String project, String region, String resource, TestPermissionsRequest testPermissionsRequestResource) Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. testIamPermissionsCallable()

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.

Inheritance

java.lang.Object > NetworkAttachmentsClient

Static Methods

create()

public static final NetworkAttachmentsClient create()

Constructs an instance of NetworkAttachmentsClient with default settings.

Returns
Type	Description
`NetworkAttachmentsClient`

Exceptions
Type	Description
`IOException`

create(NetworkAttachmentsSettings settings)

public static final NetworkAttachmentsClient create(NetworkAttachmentsSettings settings)

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.

Parameter
Name	Description
`settings`	`NetworkAttachmentsSettings`

Returns
Type	Description
`NetworkAttachmentsClient`

Exceptions
Type	Description
`IOException`

create(NetworkAttachmentsStub stub)

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

Parameter
Name	Description
`stub`	`NetworkAttachmentsStub`

Returns
Type	Description
`NetworkAttachmentsClient`

Constructors

NetworkAttachmentsClient(NetworkAttachmentsSettings settings)

protected NetworkAttachmentsClient(NetworkAttachmentsSettings settings)

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.

Parameter
Name	Description
`settings`	`NetworkAttachmentsSettings`

NetworkAttachmentsClient(NetworkAttachmentsStub stub)

protected NetworkAttachmentsClient(NetworkAttachmentsStub stub)

Parameter
Name	Description
`stub`	`NetworkAttachmentsStub`

Methods

aggregatedList(AggregatedListNetworkAttachmentsRequest request)

public final NetworkAttachmentsClient.AggregatedListPagedResponse aggregatedList(AggregatedListNetworkAttachmentsRequest request)

Retrieves the list of all NetworkAttachment resources, regional and global, available to the specified project. To prevent failure, Google recommends that you set the returnPartialSuccess parameter to true.

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)
           .setServiceProjectNumber(-1293855239)
           .build();
   for (Map.Entry<String, NetworkAttachmentsScopedList> element :
       networkAttachmentsClient.aggregatedList(request).iterateAll()) {
     // doThingsWith(element);
   }
 }

Parameter
Name	Description
`request`	`AggregatedListNetworkAttachmentsRequest` The request object containing all of the parameters for the API call.

Returns
Type	Description
`NetworkAttachmentsClient.AggregatedListPagedResponse`

aggregatedList(String project)

public final NetworkAttachmentsClient.AggregatedListPagedResponse aggregatedList(String 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);
   }
 }

Parameter
Name	Description
`project`	`String` Project ID for this request.

Returns
Type	Description
`NetworkAttachmentsClient.AggregatedListPagedResponse`

aggregatedListCallable()

public final UnaryCallable<AggregatedListNetworkAttachmentsRequest,NetworkAttachmentAggregatedList> aggregatedListCallable()

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)
           .setServiceProjectNumber(-1293855239)
           .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;
     }
   }
 }

Returns
Type	Description
`UnaryCallable<AggregatedListNetworkAttachmentsRequest,NetworkAttachmentAggregatedList>`

aggregatedListPagedCallable()

public final UnaryCallable<AggregatedListNetworkAttachmentsRequest,NetworkAttachmentsClient.AggregatedListPagedResponse> aggregatedListPagedCallable()

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)
           .setServiceProjectNumber(-1293855239)
           .build();
   ApiFuture<Map.Entry<String, NetworkAttachmentsScopedList>> future =
       networkAttachmentsClient.aggregatedListPagedCallable().futureCall(request);
   // Do something.
   for (Map.Entry<String, NetworkAttachmentsScopedList> element : future.get().iterateAll()) {
     // doThingsWith(element);
   }
 }

Returns
Type	Description
`UnaryCallable<AggregatedListNetworkAttachmentsRequest,AggregatedListPagedResponse>`

awaitTermination(long duration, TimeUnit unit)

public boolean awaitTermination(long duration, TimeUnit unit)

Parameters
Name	Description
`duration`	`long`
`unit`	`TimeUnit`

Returns
Type	Description
`boolean`

Exceptions
Type	Description
`InterruptedException`

close()

public final void close()

deleteAsync(DeleteNetworkAttachmentRequest request)

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

Deletes the specified NetworkAttachment 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()) {
   DeleteNetworkAttachmentRequest request =
       DeleteNetworkAttachmentRequest.newBuilder()
           .setNetworkAttachment("networkAttachment1918512625")
           .setProject("project-309310695")
           .setRegion("region-934795532")
           .setRequestId("requestId693933066")
           .build();
   Operation response = networkAttachmentsClient.deleteAsync(request).get();
 }

Parameter
Name	Description
`request`	`DeleteNetworkAttachmentRequest` The request object containing all of the parameters for the API call.

Returns
Type	Description
`OperationFuture<Operation,Operation>`

deleteAsync(String project, String region, String networkAttachment)

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

Deletes the specified NetworkAttachment 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";
   Operation response =
       networkAttachmentsClient.deleteAsync(project, region, networkAttachment).get();
 }

Parameters
Name	Description
`project`	`String` Project ID for this request.
`region`	`String` Name of the region of this request.
`networkAttachment`	`String` Name of the NetworkAttachment resource to delete.

Returns
Type	Description
`OperationFuture<Operation,Operation>`

deleteCallable()

public final UnaryCallable<DeleteNetworkAttachmentRequest,Operation> deleteCallable()

Deletes the specified NetworkAttachment 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()) {
   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();
 }

Returns
Type	Description
`UnaryCallable<DeleteNetworkAttachmentRequest,Operation>`

deleteOperationCallable()

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

Deletes the specified NetworkAttachment 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()) {
   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();
 }

Returns
Type	Description
`OperationCallable<DeleteNetworkAttachmentRequest,Operation,Operation>`

get(GetNetworkAttachmentRequest request)

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);
 }

Parameter
Name	Description
`request`	`GetNetworkAttachmentRequest` The request object containing all of the parameters for the API call.

Returns
Type	Description
`NetworkAttachment`

get(String project, String region, String networkAttachment)

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
Name	Description
`project`	`String` Project ID for this request.
`region`	`String` Name of the region of this request.
`networkAttachment`	`String` Name of the NetworkAttachment resource to return.

Returns
Type	Description
`NetworkAttachment`

getCallable()

public final 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();
 }

Returns
Type	Description
`UnaryCallable<GetNetworkAttachmentRequest,NetworkAttachment>`

getIamPolicy(GetIamPolicyNetworkAttachmentRequest request)

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);
 }

Parameter
Name	Description
`request`	`GetIamPolicyNetworkAttachmentRequest` The request object containing all of the parameters for the API call.

Returns
Type	Description
`Policy`

getIamPolicy(String project, String region, String resource)

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
Name	Description
`project`	`String` Project ID for this request.
`region`	`String` The name of the region for this request.
`resource`	`String` Name or id of the resource for this request.

Returns
Type	Description
`Policy`

getIamPolicyCallable()

public final 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();
 }

Returns
Type	Description
`UnaryCallable<GetIamPolicyNetworkAttachmentRequest,Policy>`

getSettings()

public final NetworkAttachmentsSettings getSettings()

Returns
Type	Description
`NetworkAttachmentsSettings`

getStub()

public NetworkAttachmentsStub getStub()

Returns
Type	Description
`NetworkAttachmentsStub`

insertAsync(InsertNetworkAttachmentRequest request)

public final 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();
 }

Parameter
Name	Description
`request`	`InsertNetworkAttachmentRequest` The request object containing all of the parameters for the API call.

Returns
Type	Description
`OperationFuture<Operation,Operation>`

insertAsync(String project, String region, NetworkAttachment networkAttachmentResource)

public final 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
Name	Description
`project`	`String` Project ID for this request.
`region`	`String` Name of the region of this request.
`networkAttachmentResource`	`NetworkAttachment` The body resource for this request

Returns
Type	Description
`OperationFuture<Operation,Operation>`

insertCallable()

public final 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();
 }

Returns
Type	Description
`UnaryCallable<InsertNetworkAttachmentRequest,Operation>`

insertOperationCallable()

public final 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();
 }

Returns
Type	Description
`OperationCallable<InsertNetworkAttachmentRequest,Operation,Operation>`

isShutdown()

public boolean isShutdown()

Returns
Type	Description
`boolean`

isTerminated()

public boolean isTerminated()

Returns
Type	Description
`boolean`

list(ListNetworkAttachmentsRequest request)

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);
   }
 }

Parameter
Name	Description
`request`	`ListNetworkAttachmentsRequest` The request object containing all of the parameters for the API call.

Returns
Type	Description
`NetworkAttachmentsClient.ListPagedResponse`

list(String project, String region)

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
Name	Description
`project`	`String` Project ID for this request.
`region`	`String` Name of the region of this request.

Returns
Type	Description
`NetworkAttachmentsClient.ListPagedResponse`

listCallable()

public final 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;
     }
   }
 }

Returns
Type	Description
`UnaryCallable<ListNetworkAttachmentsRequest,NetworkAttachmentList>`

listPagedCallable()

public final 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);
   }
 }

Returns
Type	Description
`UnaryCallable<ListNetworkAttachmentsRequest,ListPagedResponse>`

patchAsync(PatchNetworkAttachmentRequest request)

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

Patches the specified NetworkAttachment 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 (NetworkAttachmentsClient networkAttachmentsClient = NetworkAttachmentsClient.create()) {
   PatchNetworkAttachmentRequest request =
       PatchNetworkAttachmentRequest.newBuilder()
           .setNetworkAttachment("networkAttachment1918512625")
           .setNetworkAttachmentResource(NetworkAttachment.newBuilder().build())
           .setProject("project-309310695")
           .setRegion("region-934795532")
           .setRequestId("requestId693933066")
           .build();
   Operation response = networkAttachmentsClient.patchAsync(request).get();
 }

Parameter
Name	Description
`request`	`PatchNetworkAttachmentRequest` The request object containing all of the parameters for the API call.

Returns
Type	Description
`OperationFuture<Operation,Operation>`

patchAsync(String project, String region, String networkAttachment, NetworkAttachment networkAttachmentResource)

public final OperationFuture<Operation,Operation> patchAsync(String project, String region, String networkAttachment, NetworkAttachment networkAttachmentResource)

Patches the specified NetworkAttachment 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 (NetworkAttachmentsClient networkAttachmentsClient = NetworkAttachmentsClient.create()) {
   String project = "project-309310695";
   String region = "region-934795532";
   String networkAttachment = "networkAttachment1918512625";
   NetworkAttachment networkAttachmentResource = NetworkAttachment.newBuilder().build();
   Operation response =
       networkAttachmentsClient
           .patchAsync(project, region, networkAttachment, networkAttachmentResource)
           .get();
 }

Parameters
Name	Description
`project`	`String` Project ID for this request.
`region`	`String` Name of the region for this request.
`networkAttachment`	`String` Name of the NetworkAttachment resource to patch.
`networkAttachmentResource`	`NetworkAttachment` The body resource for this request

Returns
Type	Description
`OperationFuture<Operation,Operation>`

patchCallable()

public final UnaryCallable<PatchNetworkAttachmentRequest,Operation> patchCallable()

Patches the specified NetworkAttachment 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 (NetworkAttachmentsClient networkAttachmentsClient = NetworkAttachmentsClient.create()) {
   PatchNetworkAttachmentRequest request =
       PatchNetworkAttachmentRequest.newBuilder()
           .setNetworkAttachment("networkAttachment1918512625")
           .setNetworkAttachmentResource(NetworkAttachment.newBuilder().build())
           .setProject("project-309310695")
           .setRegion("region-934795532")
           .setRequestId("requestId693933066")
           .build();
   ApiFuture<Operation> future = networkAttachmentsClient.patchCallable().futureCall(request);
   // Do something.
   Operation response = future.get();
 }

Returns
Type	Description
`UnaryCallable<PatchNetworkAttachmentRequest,Operation>`

patchOperationCallable()

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

Patches the specified NetworkAttachment 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 (NetworkAttachmentsClient networkAttachmentsClient = NetworkAttachmentsClient.create()) {
   PatchNetworkAttachmentRequest request =
       PatchNetworkAttachmentRequest.newBuilder()
           .setNetworkAttachment("networkAttachment1918512625")
           .setNetworkAttachmentResource(NetworkAttachment.newBuilder().build())
           .setProject("project-309310695")
           .setRegion("region-934795532")
           .setRequestId("requestId693933066")
           .build();
   OperationFuture<Operation, Operation> future =
       networkAttachmentsClient.patchOperationCallable().futureCall(request);
   // Do something.
   Operation response = future.get();
 }

Returns
Type	Description
`OperationCallable<PatchNetworkAttachmentRequest,Operation,Operation>`

setIamPolicy(SetIamPolicyNetworkAttachmentRequest request)

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);
 }

Parameter
Name	Description
`request`	`SetIamPolicyNetworkAttachmentRequest` The request object containing all of the parameters for the API call.

Returns
Type	Description
`Policy`

setIamPolicy(String project, String region, String resource, RegionSetPolicyRequest regionSetPolicyRequestResource)

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
Name	Description
`project`	`String` Project ID for this request.
`region`	`String` The name of the region for this request.
`resource`	`String` Name or id of the resource for this request.
`regionSetPolicyRequestResource`	`RegionSetPolicyRequest` The body resource for this request

Returns
Type	Description
`Policy`

setIamPolicyCallable()

public final 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();
 }

Returns
Type	Description
`UnaryCallable<SetIamPolicyNetworkAttachmentRequest,Policy>`

shutdown()

public void shutdown()

shutdownNow()

public void shutdownNow()

testIamPermissions(TestIamPermissionsNetworkAttachmentRequest request)

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);
 }

Parameter
Name	Description
`request`	`TestIamPermissionsNetworkAttachmentRequest` The request object containing all of the parameters for the API call.

Returns
Type	Description
`TestPermissionsResponse`

testIamPermissions(String project, String region, String resource, TestPermissionsRequest testPermissionsRequestResource)

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
Name	Description
`project`	`String` Project ID for this request.
`region`	`String` The name of the region for this request.
`resource`	`String` Name or id of the resource for this request.
`testPermissionsRequestResource`	`TestPermissionsRequest` The body resource for this request

Returns
Type	Description
`TestPermissionsResponse`

testIamPermissionsCallable()

public final 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();
 }

Returns
Type	Description
`UnaryCallable<TestIamPermissionsNetworkAttachmentRequest,TestPermissionsResponse>`