Class PacketMirroringsClient (1.46.0)

Version 1.46.0

• 1.63.0 (latest)
• 1.62.0
• 1.61.0
• 1.59.0
• 1.58.0
• 1.57.0
• 1.56.0
• 1.55.0
• 1.54.0
• 1.53.0
• 1.52.0
• 1.51.0
• 1.50.0
• 1.49.0
• 1.47.0
• 1.46.0
• 1.45.0
• 1.44.0
• 1.43.0
• 1.42.0
• 1.41.0
• 1.40.0
• 1.39.0
• 1.38.0
• 1.37.0
• 1.34.0
• 1.33.0
• 1.32.0
• 1.31.0
• 1.30.0
• 1.29.0
• 1.28.0
• 1.27.0
• 1.26.0
• 1.25.0
• 1.24.0
• 1.23.0
• 1.22.0
• 1.21.0
• 1.20.0
• 1.19.0
• 1.18.0
• 1.17.0
• 1.16.0
• 1.15.0
• 1.14.0
• 1.13.0
• 1.12.1
• 1.11.0
• 1.9.1
• 1.8.1
• 1.7.2
• 1.6.0-beta

GitHub Repository

Product Reference

Service Description: The PacketMirrorings 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 (PacketMirroringsClient packetMirroringsClient = PacketMirroringsClient.create()) {
   String project = "project-309310695";
   String region = "region-934795532";
   String packetMirroring = "packetMirroring1405520923";
   PacketMirroring response = packetMirroringsClient.get(project, region, packetMirroring);
 }
 

Note: close() needs to be called on the PacketMirroringsClient 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 an aggregated list of packetMirrorings.	Request object method variants only take one parameter, a request object, which must be constructed before the call. aggregatedList(AggregatedListPacketMirroringsRequest 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 PacketMirroring resource.	Request object method variants only take one parameter, a request object, which must be constructed before the call. deleteAsync(DeletePacketMirroringRequest 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 packetMirroring) 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 PacketMirroring resource.	Request object method variants only take one parameter, a request object, which must be constructed before the call. get(GetPacketMirroringRequest 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 packetMirroring) Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. getCallable()
Insert	Creates a PacketMirroring resource in the specified project and region using the data included in the request.	Request object method variants only take one parameter, a request object, which must be constructed before the call. insertAsync(InsertPacketMirroringRequest 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, PacketMirroring packetMirroringResource) 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	Retrieves a list of PacketMirroring resources available to the specified project and region.	Request object method variants only take one parameter, a request object, which must be constructed before the call. list(ListPacketMirroringsRequest 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 PacketMirroring 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(PatchPacketMirroringRequest 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 packetMirroring, PacketMirroring packetMirroringResource) 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()
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(TestIamPermissionsPacketMirroringRequest 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 PacketMirroringsSettings 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
 PacketMirroringsSettings packetMirroringsSettings =
     PacketMirroringsSettings.newBuilder()
         .setCredentialsProvider(FixedCredentialsProvider.create(myCredentials))
         .build();
 PacketMirroringsClient packetMirroringsClient =
     PacketMirroringsClient.create(packetMirroringsSettings);
 

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
 PacketMirroringsSettings packetMirroringsSettings =
     PacketMirroringsSettings.newBuilder().setEndpoint(myEndpoint).build();
 PacketMirroringsClient packetMirroringsClient =
     PacketMirroringsClient.create(packetMirroringsSettings);
 

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

Inheritance

java.lang.Object > PacketMirroringsClient

Static Methods

create()

public static final PacketMirroringsClient create()

Constructs an instance of PacketMirroringsClient with default settings.

Returns
Type	Description
PacketMirroringsClient

Exceptions
Type	Description
IOException

create(PacketMirroringsSettings settings)

public static final PacketMirroringsClient create(PacketMirroringsSettings settings)

Constructs an instance of PacketMirroringsClient, 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	PacketMirroringsSettings

Returns
Type	Description
PacketMirroringsClient

Exceptions
Type	Description
IOException

create(PacketMirroringsStub stub)

public static final PacketMirroringsClient create(PacketMirroringsStub stub)

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

Parameter
Name	Description
stub	PacketMirroringsStub

Returns
Type	Description
PacketMirroringsClient

Constructors

PacketMirroringsClient(PacketMirroringsSettings settings)

protected PacketMirroringsClient(PacketMirroringsSettings settings)

Constructs an instance of PacketMirroringsClient, 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	PacketMirroringsSettings

PacketMirroringsClient(PacketMirroringsStub stub)

protected PacketMirroringsClient(PacketMirroringsStub stub)

Parameter
Name	Description
stub	PacketMirroringsStub

Methods

aggregatedList(AggregatedListPacketMirroringsRequest request)

public final PacketMirroringsClient.AggregatedListPagedResponse aggregatedList(AggregatedListPacketMirroringsRequest request)

Retrieves an aggregated list of packetMirrorings.

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 (PacketMirroringsClient packetMirroringsClient = PacketMirroringsClient.create()) {
   AggregatedListPacketMirroringsRequest request =
       AggregatedListPacketMirroringsRequest.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, PacketMirroringsScopedList> element :
       packetMirroringsClient.aggregatedList(request).iterateAll()) {
     // doThingsWith(element);
   }
 }
 

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

Returns
Type	Description
PacketMirroringsClient.AggregatedListPagedResponse

aggregatedList(String project)

public final PacketMirroringsClient.AggregatedListPagedResponse aggregatedList(String project)

Retrieves an aggregated list of packetMirrorings.

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 (PacketMirroringsClient packetMirroringsClient = PacketMirroringsClient.create()) {
   String project = "project-309310695";
   for (Map.Entry<String, PacketMirroringsScopedList> element :
       packetMirroringsClient.aggregatedList(project).iterateAll()) {
     // doThingsWith(element);
   }
 }
 

Parameter
Name	Description
project	String Project ID for this request.

Returns
Type	Description
PacketMirroringsClient.AggregatedListPagedResponse

aggregatedListCallable()

public final UnaryCallable<AggregatedListPacketMirroringsRequest,PacketMirroringAggregatedList> aggregatedListCallable()

Retrieves an aggregated list of packetMirrorings.

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 (PacketMirroringsClient packetMirroringsClient = PacketMirroringsClient.create()) {
   AggregatedListPacketMirroringsRequest request =
       AggregatedListPacketMirroringsRequest.newBuilder()
           .setFilter("filter-1274492040")
           .setIncludeAllScopes(true)
           .setMaxResults(1128457243)
           .setOrderBy("orderBy-1207110587")
           .setPageToken("pageToken873572522")
           .setProject("project-309310695")
           .setReturnPartialSuccess(true)
           .setServiceProjectNumber(-1293855239)
           .build();
   while (true) {
     PacketMirroringAggregatedList response =
         packetMirroringsClient.aggregatedListCallable().call(request);
     for (Map.Entry<String, PacketMirroringsScopedList> 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<AggregatedListPacketMirroringsRequest,PacketMirroringAggregatedList>

aggregatedListPagedCallable()

public final UnaryCallable<AggregatedListPacketMirroringsRequest,PacketMirroringsClient.AggregatedListPagedResponse> aggregatedListPagedCallable()

Retrieves an aggregated list of packetMirrorings.

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 (PacketMirroringsClient packetMirroringsClient = PacketMirroringsClient.create()) {
   AggregatedListPacketMirroringsRequest request =
       AggregatedListPacketMirroringsRequest.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, PacketMirroringsScopedList>> future =
       packetMirroringsClient.aggregatedListPagedCallable().futureCall(request);
   // Do something.
   for (Map.Entry<String, PacketMirroringsScopedList> element : future.get().iterateAll()) {
     // doThingsWith(element);
   }
 }
 

Returns
Type	Description
UnaryCallable<AggregatedListPacketMirroringsRequest,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(DeletePacketMirroringRequest request)

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

Beta

The surface for long-running operations is not stable yet and may change in the future.

This feature is covered by the Pre-GA Offerings Terms of the Terms of Service. Pre-GA libraries might have limited support, and changes to pre-GA libraries might not be compatible with other pre-GA versions. For more information, see the launch stage descriptions.

Deletes the specified PacketMirroring 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 (PacketMirroringsClient packetMirroringsClient = PacketMirroringsClient.create()) {
   DeletePacketMirroringRequest request =
       DeletePacketMirroringRequest.newBuilder()
           .setPacketMirroring("packetMirroring1405520923")
           .setProject("project-309310695")
           .setRegion("region-934795532")
           .setRequestId("requestId693933066")
           .build();
   Operation response = packetMirroringsClient.deleteAsync(request).get();
 }
 

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

Returns
Type	Description
OperationFuture<Operation,Operation>

deleteAsync(String project, String region, String packetMirroring)

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

Deletes the specified PacketMirroring 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 (PacketMirroringsClient packetMirroringsClient = PacketMirroringsClient.create()) {
   String project = "project-309310695";
   String region = "region-934795532";
   String packetMirroring = "packetMirroring1405520923";
   Operation response =
       packetMirroringsClient.deleteAsync(project, region, packetMirroring).get();
 }
 

Parameters
Name	Description
project	String Project ID for this request.
region	String Name of the region for this request.
packetMirroring	String Name of the PacketMirroring resource to delete.

Returns
Type	Description
OperationFuture<Operation,Operation>

deleteCallable()

public final UnaryCallable<DeletePacketMirroringRequest,Operation> deleteCallable()

Deletes the specified PacketMirroring 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 (PacketMirroringsClient packetMirroringsClient = PacketMirroringsClient.create()) {
   DeletePacketMirroringRequest request =
       DeletePacketMirroringRequest.newBuilder()
           .setPacketMirroring("packetMirroring1405520923")
           .setProject("project-309310695")
           .setRegion("region-934795532")
           .setRequestId("requestId693933066")
           .build();
   ApiFuture<Operation> future = packetMirroringsClient.deleteCallable().futureCall(request);
   // Do something.
   Operation response = future.get();
 }
 

Returns
Type	Description
UnaryCallable<DeletePacketMirroringRequest,Operation>

deleteOperationCallable()

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

Deletes the specified PacketMirroring 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 (PacketMirroringsClient packetMirroringsClient = PacketMirroringsClient.create()) {
   DeletePacketMirroringRequest request =
       DeletePacketMirroringRequest.newBuilder()
           .setPacketMirroring("packetMirroring1405520923")
           .setProject("project-309310695")
           .setRegion("region-934795532")
           .setRequestId("requestId693933066")
           .build();
   OperationFuture<Operation, Operation> future =
       packetMirroringsClient.deleteOperationCallable().futureCall(request);
   // Do something.
   Operation response = future.get();
 }
 

Returns
Type	Description
OperationCallable<DeletePacketMirroringRequest,Operation,Operation>

get(GetPacketMirroringRequest request)

public final PacketMirroring get(GetPacketMirroringRequest request)

Returns the specified PacketMirroring 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 (PacketMirroringsClient packetMirroringsClient = PacketMirroringsClient.create()) {
   GetPacketMirroringRequest request =
       GetPacketMirroringRequest.newBuilder()
           .setPacketMirroring("packetMirroring1405520923")
           .setProject("project-309310695")
           .setRegion("region-934795532")
           .build();
   PacketMirroring response = packetMirroringsClient.get(request);
 }
 

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

Returns
Type	Description
PacketMirroring

get(String project, String region, String packetMirroring)

public final PacketMirroring get(String project, String region, String packetMirroring)

Returns the specified PacketMirroring 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 (PacketMirroringsClient packetMirroringsClient = PacketMirroringsClient.create()) {
   String project = "project-309310695";
   String region = "region-934795532";
   String packetMirroring = "packetMirroring1405520923";
   PacketMirroring response = packetMirroringsClient.get(project, region, packetMirroring);
 }
 

Parameters
Name	Description
project	String Project ID for this request.
region	String Name of the region for this request.
packetMirroring	String Name of the PacketMirroring resource to return.

Returns
Type	Description
PacketMirroring

getCallable()

public final UnaryCallable<GetPacketMirroringRequest,PacketMirroring> getCallable()

Returns the specified PacketMirroring 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 (PacketMirroringsClient packetMirroringsClient = PacketMirroringsClient.create()) {
   GetPacketMirroringRequest request =
       GetPacketMirroringRequest.newBuilder()
           .setPacketMirroring("packetMirroring1405520923")
           .setProject("project-309310695")
           .setRegion("region-934795532")
           .build();
   ApiFuture<PacketMirroring> future = packetMirroringsClient.getCallable().futureCall(request);
   // Do something.
   PacketMirroring response = future.get();
 }
 

Returns
Type	Description
UnaryCallable<GetPacketMirroringRequest,PacketMirroring>

getSettings()

public final PacketMirroringsSettings getSettings()

Returns
Type	Description
PacketMirroringsSettings

getStub()

public PacketMirroringsStub getStub()

Returns
Type	Description
PacketMirroringsStub

insertAsync(InsertPacketMirroringRequest request)

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

Beta

The surface for long-running operations is not stable yet and may change in the future.

This feature is covered by the Pre-GA Offerings Terms of the Terms of Service. Pre-GA libraries might have limited support, and changes to pre-GA libraries might not be compatible with other pre-GA versions. For more information, see the launch stage descriptions.

Creates a PacketMirroring resource in the specified project and region using the data 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 (PacketMirroringsClient packetMirroringsClient = PacketMirroringsClient.create()) {
   InsertPacketMirroringRequest request =
       InsertPacketMirroringRequest.newBuilder()
           .setPacketMirroringResource(PacketMirroring.newBuilder().build())
           .setProject("project-309310695")
           .setRegion("region-934795532")
           .setRequestId("requestId693933066")
           .build();
   Operation response = packetMirroringsClient.insertAsync(request).get();
 }
 

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

Returns
Type	Description
OperationFuture<Operation,Operation>

insertAsync(String project, String region, PacketMirroring packetMirroringResource)

public final OperationFuture<Operation,Operation> insertAsync(String project, String region, PacketMirroring packetMirroringResource)

Creates a PacketMirroring resource in the specified project and region using the data 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 (PacketMirroringsClient packetMirroringsClient = PacketMirroringsClient.create()) {
   String project = "project-309310695";
   String region = "region-934795532";
   PacketMirroring packetMirroringResource = PacketMirroring.newBuilder().build();
   Operation response =
       packetMirroringsClient.insertAsync(project, region, packetMirroringResource).get();
 }
 

Parameters
Name	Description
project	String Project ID for this request.
region	String Name of the region for this request.
packetMirroringResource	PacketMirroring The body resource for this request

Returns
Type	Description
OperationFuture<Operation,Operation>

insertCallable()

public final UnaryCallable<InsertPacketMirroringRequest,Operation> insertCallable()

Creates a PacketMirroring resource in the specified project and region using the data 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 (PacketMirroringsClient packetMirroringsClient = PacketMirroringsClient.create()) {
   InsertPacketMirroringRequest request =
       InsertPacketMirroringRequest.newBuilder()
           .setPacketMirroringResource(PacketMirroring.newBuilder().build())
           .setProject("project-309310695")
           .setRegion("region-934795532")
           .setRequestId("requestId693933066")
           .build();
   ApiFuture<Operation> future = packetMirroringsClient.insertCallable().futureCall(request);
   // Do something.
   Operation response = future.get();
 }
 

Returns
Type	Description
UnaryCallable<InsertPacketMirroringRequest,Operation>

insertOperationCallable()

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

Creates a PacketMirroring resource in the specified project and region using the data 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 (PacketMirroringsClient packetMirroringsClient = PacketMirroringsClient.create()) {
   InsertPacketMirroringRequest request =
       InsertPacketMirroringRequest.newBuilder()
           .setPacketMirroringResource(PacketMirroring.newBuilder().build())
           .setProject("project-309310695")
           .setRegion("region-934795532")
           .setRequestId("requestId693933066")
           .build();
   OperationFuture<Operation, Operation> future =
       packetMirroringsClient.insertOperationCallable().futureCall(request);
   // Do something.
   Operation response = future.get();
 }
 

Returns
Type	Description
OperationCallable<InsertPacketMirroringRequest,Operation,Operation>

isShutdown()

public boolean isShutdown()

Returns
Type	Description
boolean

isTerminated()

public boolean isTerminated()

Returns
Type	Description
boolean

list(ListPacketMirroringsRequest request)

public final PacketMirroringsClient.ListPagedResponse list(ListPacketMirroringsRequest request)

Retrieves a list of PacketMirroring resources available to the specified project and region.

Sample code:

 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (PacketMirroringsClient packetMirroringsClient = PacketMirroringsClient.create()) {
   ListPacketMirroringsRequest request =
       ListPacketMirroringsRequest.newBuilder()
           .setFilter("filter-1274492040")
           .setMaxResults(1128457243)
           .setOrderBy("orderBy-1207110587")
           .setPageToken("pageToken873572522")
           .setProject("project-309310695")
           .setRegion("region-934795532")
           .setReturnPartialSuccess(true)
           .build();
   for (PacketMirroring element : packetMirroringsClient.list(request).iterateAll()) {
     // doThingsWith(element);
   }
 }
 

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

Returns
Type	Description
PacketMirroringsClient.ListPagedResponse

list(String project, String region)

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

Retrieves a list of PacketMirroring resources available to the specified project and region.

Sample code:

 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (PacketMirroringsClient packetMirroringsClient = PacketMirroringsClient.create()) {
   String project = "project-309310695";
   String region = "region-934795532";
   for (PacketMirroring element : packetMirroringsClient.list(project, region).iterateAll()) {
     // doThingsWith(element);
   }
 }
 

Parameters
Name	Description
project	String Project ID for this request.
region	String Name of the region for this request.

Returns
Type	Description
PacketMirroringsClient.ListPagedResponse

listCallable()

public final UnaryCallable<ListPacketMirroringsRequest,PacketMirroringList> listCallable()

Retrieves a list of PacketMirroring resources available to the specified project and region.

Sample code:

 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (PacketMirroringsClient packetMirroringsClient = PacketMirroringsClient.create()) {
   ListPacketMirroringsRequest request =
       ListPacketMirroringsRequest.newBuilder()
           .setFilter("filter-1274492040")
           .setMaxResults(1128457243)
           .setOrderBy("orderBy-1207110587")
           .setPageToken("pageToken873572522")
           .setProject("project-309310695")
           .setRegion("region-934795532")
           .setReturnPartialSuccess(true)
           .build();
   while (true) {
     PacketMirroringList response = packetMirroringsClient.listCallable().call(request);
     for (PacketMirroring 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<ListPacketMirroringsRequest,PacketMirroringList>

listPagedCallable()

public final UnaryCallable<ListPacketMirroringsRequest,PacketMirroringsClient.ListPagedResponse> listPagedCallable()

Retrieves a list of PacketMirroring resources available to the specified project and region.

Sample code:

 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (PacketMirroringsClient packetMirroringsClient = PacketMirroringsClient.create()) {
   ListPacketMirroringsRequest request =
       ListPacketMirroringsRequest.newBuilder()
           .setFilter("filter-1274492040")
           .setMaxResults(1128457243)
           .setOrderBy("orderBy-1207110587")
           .setPageToken("pageToken873572522")
           .setProject("project-309310695")
           .setRegion("region-934795532")
           .setReturnPartialSuccess(true)
           .build();
   ApiFuture<PacketMirroring> future =
       packetMirroringsClient.listPagedCallable().futureCall(request);
   // Do something.
   for (PacketMirroring element : future.get().iterateAll()) {
     // doThingsWith(element);
   }
 }
 

Returns
Type	Description
UnaryCallable<ListPacketMirroringsRequest,ListPagedResponse>

patchAsync(PatchPacketMirroringRequest request)

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

Beta

The surface for long-running operations is not stable yet and may change in the future.

This feature is covered by the Pre-GA Offerings Terms of the Terms of Service. Pre-GA libraries might have limited support, and changes to pre-GA libraries might not be compatible with other pre-GA versions. For more information, see the launch stage descriptions.

Patches the specified PacketMirroring 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 (PacketMirroringsClient packetMirroringsClient = PacketMirroringsClient.create()) {
   PatchPacketMirroringRequest request =
       PatchPacketMirroringRequest.newBuilder()
           .setPacketMirroring("packetMirroring1405520923")
           .setPacketMirroringResource(PacketMirroring.newBuilder().build())
           .setProject("project-309310695")
           .setRegion("region-934795532")
           .setRequestId("requestId693933066")
           .build();
   Operation response = packetMirroringsClient.patchAsync(request).get();
 }
 

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

Returns
Type	Description
OperationFuture<Operation,Operation>

patchAsync(String project, String region, String packetMirroring, PacketMirroring packetMirroringResource)

public final OperationFuture<Operation,Operation> patchAsync(String project, String region, String packetMirroring, PacketMirroring packetMirroringResource)

Patches the specified PacketMirroring 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 (PacketMirroringsClient packetMirroringsClient = PacketMirroringsClient.create()) {
   String project = "project-309310695";
   String region = "region-934795532";
   String packetMirroring = "packetMirroring1405520923";
   PacketMirroring packetMirroringResource = PacketMirroring.newBuilder().build();
   Operation response =
       packetMirroringsClient
           .patchAsync(project, region, packetMirroring, packetMirroringResource)
           .get();
 }
 

Parameters
Name	Description
project	String Project ID for this request.
region	String Name of the region for this request.
packetMirroring	String Name of the PacketMirroring resource to patch.
packetMirroringResource	PacketMirroring The body resource for this request

Returns
Type	Description
OperationFuture<Operation,Operation>

patchCallable()

public final UnaryCallable<PatchPacketMirroringRequest,Operation> patchCallable()

Patches the specified PacketMirroring 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 (PacketMirroringsClient packetMirroringsClient = PacketMirroringsClient.create()) {
   PatchPacketMirroringRequest request =
       PatchPacketMirroringRequest.newBuilder()
           .setPacketMirroring("packetMirroring1405520923")
           .setPacketMirroringResource(PacketMirroring.newBuilder().build())
           .setProject("project-309310695")
           .setRegion("region-934795532")
           .setRequestId("requestId693933066")
           .build();
   ApiFuture<Operation> future = packetMirroringsClient.patchCallable().futureCall(request);
   // Do something.
   Operation response = future.get();
 }
 

Returns
Type	Description
UnaryCallable<PatchPacketMirroringRequest,Operation>

patchOperationCallable()

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

Patches the specified PacketMirroring 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 (PacketMirroringsClient packetMirroringsClient = PacketMirroringsClient.create()) {
   PatchPacketMirroringRequest request =
       PatchPacketMirroringRequest.newBuilder()
           .setPacketMirroring("packetMirroring1405520923")
           .setPacketMirroringResource(PacketMirroring.newBuilder().build())
           .setProject("project-309310695")
           .setRegion("region-934795532")
           .setRequestId("requestId693933066")
           .build();
   OperationFuture<Operation, Operation> future =
       packetMirroringsClient.patchOperationCallable().futureCall(request);
   // Do something.
   Operation response = future.get();
 }
 

Returns
Type	Description
OperationCallable<PatchPacketMirroringRequest,Operation,Operation>

shutdown()

public void shutdown()

shutdownNow()

public void shutdownNow()

testIamPermissions(TestIamPermissionsPacketMirroringRequest request)

public final TestPermissionsResponse testIamPermissions(TestIamPermissionsPacketMirroringRequest 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 (PacketMirroringsClient packetMirroringsClient = PacketMirroringsClient.create()) {
   TestIamPermissionsPacketMirroringRequest request =
       TestIamPermissionsPacketMirroringRequest.newBuilder()
           .setProject("project-309310695")
           .setRegion("region-934795532")
           .setResource("resource-341064690")
           .setTestPermissionsRequestResource(TestPermissionsRequest.newBuilder().build())
           .build();
   TestPermissionsResponse response = packetMirroringsClient.testIamPermissions(request);
 }
 

Parameter
Name	Description
request	TestIamPermissionsPacketMirroringRequest 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 (PacketMirroringsClient packetMirroringsClient = PacketMirroringsClient.create()) {
   String project = "project-309310695";
   String region = "region-934795532";
   String resource = "resource-341064690";
   TestPermissionsRequest testPermissionsRequestResource =
       TestPermissionsRequest.newBuilder().build();
   TestPermissionsResponse response =
       packetMirroringsClient.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<TestIamPermissionsPacketMirroringRequest,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 (PacketMirroringsClient packetMirroringsClient = PacketMirroringsClient.create()) {
   TestIamPermissionsPacketMirroringRequest request =
       TestIamPermissionsPacketMirroringRequest.newBuilder()
           .setProject("project-309310695")
           .setRegion("region-934795532")
           .setResource("resource-341064690")
           .setTestPermissionsRequestResource(TestPermissionsRequest.newBuilder().build())
           .build();
   ApiFuture<TestPermissionsResponse> future =
       packetMirroringsClient.testIamPermissionsCallable().futureCall(request);
   // Do something.
   TestPermissionsResponse response = future.get();
 }
 

Returns
Type	Description
UnaryCallable<TestIamPermissionsPacketMirroringRequest,TestPermissionsResponse>