Class WireGroupsClient (1.92.0)

GitHub RepositoryProduct Reference

Service Description: The WireGroups 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 (WireGroupsClient wireGroupsClient = WireGroupsClient.create()) {
   String project = "project-309310695";
   String crossSiteNetwork = "crossSiteNetwork1009388679";
   String wireGroup = "wireGroup-970399494";
   WireGroup response = wireGroupsClient.get(project, crossSiteNetwork, wireGroup);
 }

Note: close() needs to be called on the WireGroupsClient 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

Delete

Deletes the specified wire group in the given scope.

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • deleteAsync(DeleteWireGroupRequest 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 crossSiteNetwork, String wireGroup)

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

Gets the specified wire group resource in the given scope.

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • get(GetWireGroupRequest 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 crossSiteNetwork, String wireGroup)

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 wire group 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(InsertWireGroupRequest 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 crossSiteNetwork, WireGroup wireGroupResource)

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 wire groups 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(ListWireGroupsRequest 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 crossSiteNetwork)

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

Updates the specified wire group resource with the data included in the request. This method supportsPATCH semantics and usesJSON 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(PatchWireGroupRequest 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 crossSiteNetwork, String wireGroup, WireGroup wireGroupResource)

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

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 WireGroupsSettings 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
 WireGroupsSettings wireGroupsSettings =
     WireGroupsSettings.newBuilder()
         .setCredentialsProvider(FixedCredentialsProvider.create(myCredentials))
         .build();
 WireGroupsClient wireGroupsClient = WireGroupsClient.create(wireGroupsSettings);

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
 WireGroupsSettings wireGroupsSettings =
     WireGroupsSettings.newBuilder().setEndpoint(myEndpoint).build();
 WireGroupsClient wireGroupsClient = WireGroupsClient.create(wireGroupsSettings);

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

Inheritance

java.lang.Object > WireGroupsClient

Static Methods

create()

public static final WireGroupsClient create()

Constructs an instance of WireGroupsClient with default settings.

Returns
Type Description
WireGroupsClient
Exceptions
Type Description
IOException

create(WireGroupsSettings settings)

public static final WireGroupsClient create(WireGroupsSettings settings)

Constructs an instance of WireGroupsClient, 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 WireGroupsSettings
Returns
Type Description
WireGroupsClient
Exceptions
Type Description
IOException

create(WireGroupsStub stub)

public static final WireGroupsClient create(WireGroupsStub stub)

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

Parameter
Name Description
stub WireGroupsStub
Returns
Type Description
WireGroupsClient

Constructors

WireGroupsClient(WireGroupsSettings settings)

protected WireGroupsClient(WireGroupsSettings settings)

Constructs an instance of WireGroupsClient, 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 WireGroupsSettings

WireGroupsClient(WireGroupsStub stub)

protected WireGroupsClient(WireGroupsStub stub)
Parameter
Name Description
stub WireGroupsStub

Methods

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(DeleteWireGroupRequest request)

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

Deletes the specified wire group 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 (WireGroupsClient wireGroupsClient = WireGroupsClient.create()) {
   DeleteWireGroupRequest request =
       DeleteWireGroupRequest.newBuilder()
           .setCrossSiteNetwork("crossSiteNetwork1009388679")
           .setProject("project-309310695")
           .setRequestId("requestId693933066")
           .setWireGroup("wireGroup-970399494")
           .build();
   Operation response = wireGroupsClient.deleteAsync(request).get();
 }
Parameter
Name Description
request DeleteWireGroupRequest

The request object containing all of the parameters for the API call.
Returns
Type Description
OperationFuture<Operation,Operation>

deleteAsync(String project, String crossSiteNetwork, String wireGroup)

public final OperationFuture<Operation,Operation> deleteAsync(String project, String crossSiteNetwork, String wireGroup)

Deletes the specified wire group 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 (WireGroupsClient wireGroupsClient = WireGroupsClient.create()) {
   String project = "project-309310695";
   String crossSiteNetwork = "crossSiteNetwork1009388679";
   String wireGroup = "wireGroup-970399494";
   Operation response = wireGroupsClient.deleteAsync(project, crossSiteNetwork, wireGroup).get();
 }
Parameters
Name Description
project String

Project ID for this request.
crossSiteNetwork String
wireGroup String

Name of the wire group resource to delete.
Returns
Type Description
OperationFuture<Operation,Operation>

deleteCallable()

public final UnaryCallable<DeleteWireGroupRequest,Operation> deleteCallable()

Deletes the specified wire group 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 (WireGroupsClient wireGroupsClient = WireGroupsClient.create()) {
   DeleteWireGroupRequest request =
       DeleteWireGroupRequest.newBuilder()
           .setCrossSiteNetwork("crossSiteNetwork1009388679")
           .setProject("project-309310695")
           .setRequestId("requestId693933066")
           .setWireGroup("wireGroup-970399494")
           .build();
   ApiFuture<Operation> future = wireGroupsClient.deleteCallable().futureCall(request);
   // Do something.
   Operation response = future.get();
 }
Returns
Type Description
UnaryCallable<DeleteWireGroupRequest,Operation>

deleteOperationCallable()

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

Deletes the specified wire group 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 (WireGroupsClient wireGroupsClient = WireGroupsClient.create()) {
   DeleteWireGroupRequest request =
       DeleteWireGroupRequest.newBuilder()
           .setCrossSiteNetwork("crossSiteNetwork1009388679")
           .setProject("project-309310695")
           .setRequestId("requestId693933066")
           .setWireGroup("wireGroup-970399494")
           .build();
   OperationFuture<Operation, Operation> future =
       wireGroupsClient.deleteOperationCallable().futureCall(request);
   // Do something.
   Operation response = future.get();
 }
Returns
Type Description
OperationCallable<DeleteWireGroupRequest,Operation,Operation>

get(GetWireGroupRequest request)

public final WireGroup get(GetWireGroupRequest request)

Gets the specified wire group 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 (WireGroupsClient wireGroupsClient = WireGroupsClient.create()) {
   GetWireGroupRequest request =
       GetWireGroupRequest.newBuilder()
           .setCrossSiteNetwork("crossSiteNetwork1009388679")
           .setProject("project-309310695")
           .setWireGroup("wireGroup-970399494")
           .build();
   WireGroup response = wireGroupsClient.get(request);
 }
Parameter
Name Description
request GetWireGroupRequest

The request object containing all of the parameters for the API call.
Returns
Type Description
WireGroup

get(String project, String crossSiteNetwork, String wireGroup)

public final WireGroup get(String project, String crossSiteNetwork, String wireGroup)

Gets the specified wire group 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 (WireGroupsClient wireGroupsClient = WireGroupsClient.create()) {
   String project = "project-309310695";
   String crossSiteNetwork = "crossSiteNetwork1009388679";
   String wireGroup = "wireGroup-970399494";
   WireGroup response = wireGroupsClient.get(project, crossSiteNetwork, wireGroup);
 }
Parameters
Name Description
project String

Project ID for this request.
crossSiteNetwork String
wireGroup String

Name of the wire group resource to return.
Returns
Type Description
WireGroup

getCallable()

public final UnaryCallable<GetWireGroupRequest,WireGroup> getCallable()

Gets the specified wire group 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 (WireGroupsClient wireGroupsClient = WireGroupsClient.create()) {
   GetWireGroupRequest request =
       GetWireGroupRequest.newBuilder()
           .setCrossSiteNetwork("crossSiteNetwork1009388679")
           .setProject("project-309310695")
           .setWireGroup("wireGroup-970399494")
           .build();
   ApiFuture<WireGroup> future = wireGroupsClient.getCallable().futureCall(request);
   // Do something.
   WireGroup response = future.get();
 }
Returns
Type Description
UnaryCallable<GetWireGroupRequest,WireGroup>

getSettings()

public final WireGroupsSettings getSettings()
Returns
Type Description
WireGroupsSettings

getStub()

public WireGroupsStub getStub()
Returns
Type Description
WireGroupsStub

insertAsync(InsertWireGroupRequest request)

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

Creates a wire group 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 (WireGroupsClient wireGroupsClient = WireGroupsClient.create()) {
   InsertWireGroupRequest request =
       InsertWireGroupRequest.newBuilder()
           .setCrossSiteNetwork("crossSiteNetwork1009388679")
           .setProject("project-309310695")
           .setRequestId("requestId693933066")
           .setValidateOnly(true)
           .setWireGroupResource(WireGroup.newBuilder().build())
           .build();
   Operation response = wireGroupsClient.insertAsync(request).get();
 }
Parameter
Name Description
request InsertWireGroupRequest

The request object containing all of the parameters for the API call.
Returns
Type Description
OperationFuture<Operation,Operation>

insertAsync(String project, String crossSiteNetwork, WireGroup wireGroupResource)

public final OperationFuture<Operation,Operation> insertAsync(String project, String crossSiteNetwork, WireGroup wireGroupResource)

Creates a wire group 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 (WireGroupsClient wireGroupsClient = WireGroupsClient.create()) {
   String project = "project-309310695";
   String crossSiteNetwork = "crossSiteNetwork1009388679";
   WireGroup wireGroupResource = WireGroup.newBuilder().build();
   Operation response =
       wireGroupsClient.insertAsync(project, crossSiteNetwork, wireGroupResource).get();
 }
Parameters
Name Description
project String

Project ID for this request.
crossSiteNetwork String
wireGroupResource WireGroup

The body resource for this request
Returns
Type Description
OperationFuture<Operation,Operation>

insertCallable()

public final UnaryCallable<InsertWireGroupRequest,Operation> insertCallable()

Creates a wire group 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 (WireGroupsClient wireGroupsClient = WireGroupsClient.create()) {
   InsertWireGroupRequest request =
       InsertWireGroupRequest.newBuilder()
           .setCrossSiteNetwork("crossSiteNetwork1009388679")
           .setProject("project-309310695")
           .setRequestId("requestId693933066")
           .setValidateOnly(true)
           .setWireGroupResource(WireGroup.newBuilder().build())
           .build();
   ApiFuture<Operation> future = wireGroupsClient.insertCallable().futureCall(request);
   // Do something.
   Operation response = future.get();
 }
Returns
Type Description
UnaryCallable<InsertWireGroupRequest,Operation>

insertOperationCallable()

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

Creates a wire group 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 (WireGroupsClient wireGroupsClient = WireGroupsClient.create()) {
   InsertWireGroupRequest request =
       InsertWireGroupRequest.newBuilder()
           .setCrossSiteNetwork("crossSiteNetwork1009388679")
           .setProject("project-309310695")
           .setRequestId("requestId693933066")
           .setValidateOnly(true)
           .setWireGroupResource(WireGroup.newBuilder().build())
           .build();
   OperationFuture<Operation, Operation> future =
       wireGroupsClient.insertOperationCallable().futureCall(request);
   // Do something.
   Operation response = future.get();
 }
Returns
Type Description
OperationCallable<InsertWireGroupRequest,Operation,Operation>

isShutdown()

public boolean isShutdown()
Returns
Type Description
boolean

isTerminated()

public boolean isTerminated()
Returns
Type Description
boolean

list(ListWireGroupsRequest request)

public final WireGroupsClient.ListPagedResponse list(ListWireGroupsRequest request)

Lists the wire groups 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 (WireGroupsClient wireGroupsClient = WireGroupsClient.create()) {
   ListWireGroupsRequest request =
       ListWireGroupsRequest.newBuilder()
           .setCrossSiteNetwork("crossSiteNetwork1009388679")
           .setFilter("filter-1274492040")
           .setMaxResults(1128457243)
           .setOrderBy("orderBy-1207110587")
           .setPageToken("pageToken873572522")
           .setProject("project-309310695")
           .setReturnPartialSuccess(true)
           .build();
   for (WireGroup element : wireGroupsClient.list(request).iterateAll()) {
     // doThingsWith(element);
   }
 }
Parameter
Name Description
request ListWireGroupsRequest

The request object containing all of the parameters for the API call.
Returns
Type Description
WireGroupsClient.ListPagedResponse

list(String project, String crossSiteNetwork)

public final WireGroupsClient.ListPagedResponse list(String project, String crossSiteNetwork)

Lists the wire groups 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 (WireGroupsClient wireGroupsClient = WireGroupsClient.create()) {
   String project = "project-309310695";
   String crossSiteNetwork = "crossSiteNetwork1009388679";
   for (WireGroup element : wireGroupsClient.list(project, crossSiteNetwork).iterateAll()) {
     // doThingsWith(element);
   }
 }
Parameters
Name Description
project String

Project ID for this request.
crossSiteNetwork String
Returns
Type Description
WireGroupsClient.ListPagedResponse

listCallable()

public final UnaryCallable<ListWireGroupsRequest,WireGroupList> listCallable()

Lists the wire groups 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 (WireGroupsClient wireGroupsClient = WireGroupsClient.create()) {
   ListWireGroupsRequest request =
       ListWireGroupsRequest.newBuilder()
           .setCrossSiteNetwork("crossSiteNetwork1009388679")
           .setFilter("filter-1274492040")
           .setMaxResults(1128457243)
           .setOrderBy("orderBy-1207110587")
           .setPageToken("pageToken873572522")
           .setProject("project-309310695")
           .setReturnPartialSuccess(true)
           .build();
   while (true) {
     WireGroupList response = wireGroupsClient.listCallable().call(request);
     for (WireGroup 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<ListWireGroupsRequest,WireGroupList>

listPagedCallable()

public final UnaryCallable<ListWireGroupsRequest,WireGroupsClient.ListPagedResponse> listPagedCallable()

Lists the wire groups 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 (WireGroupsClient wireGroupsClient = WireGroupsClient.create()) {
   ListWireGroupsRequest request =
       ListWireGroupsRequest.newBuilder()
           .setCrossSiteNetwork("crossSiteNetwork1009388679")
           .setFilter("filter-1274492040")
           .setMaxResults(1128457243)
           .setOrderBy("orderBy-1207110587")
           .setPageToken("pageToken873572522")
           .setProject("project-309310695")
           .setReturnPartialSuccess(true)
           .build();
   ApiFuture<WireGroup> future = wireGroupsClient.listPagedCallable().futureCall(request);
   // Do something.
   for (WireGroup element : future.get().iterateAll()) {
     // doThingsWith(element);
   }
 }
Returns
Type Description
UnaryCallable<ListWireGroupsRequest,ListPagedResponse>

patchAsync(PatchWireGroupRequest request)

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

Updates the specified wire group resource with the data included in the request. This method supportsPATCH semantics and usesJSON 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 (WireGroupsClient wireGroupsClient = WireGroupsClient.create()) {
   PatchWireGroupRequest request =
       PatchWireGroupRequest.newBuilder()
           .setCrossSiteNetwork("crossSiteNetwork1009388679")
           .setProject("project-309310695")
           .setRequestId("requestId693933066")
           .setUpdateMask("updateMask-296147115")
           .setValidateOnly(true)
           .setWireGroup("wireGroup-970399494")
           .setWireGroupResource(WireGroup.newBuilder().build())
           .build();
   Operation response = wireGroupsClient.patchAsync(request).get();
 }
Parameter
Name Description
request PatchWireGroupRequest

The request object containing all of the parameters for the API call.
Returns
Type Description
OperationFuture<Operation,Operation>

patchAsync(String project, String crossSiteNetwork, String wireGroup, WireGroup wireGroupResource)

public final OperationFuture<Operation,Operation> patchAsync(String project, String crossSiteNetwork, String wireGroup, WireGroup wireGroupResource)

Updates the specified wire group resource with the data included in the request. This method supportsPATCH semantics and usesJSON 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 (WireGroupsClient wireGroupsClient = WireGroupsClient.create()) {
   String project = "project-309310695";
   String crossSiteNetwork = "crossSiteNetwork1009388679";
   String wireGroup = "wireGroup-970399494";
   WireGroup wireGroupResource = WireGroup.newBuilder().build();
   Operation response =
       wireGroupsClient
           .patchAsync(project, crossSiteNetwork, wireGroup, wireGroupResource)
           .get();
 }
Parameters
Name Description
project String

Project ID for this request.
crossSiteNetwork String
wireGroup String

Name of the WireGroups resource to patch.
wireGroupResource WireGroup

The body resource for this request
Returns
Type Description
OperationFuture<Operation,Operation>

patchCallable()

public final UnaryCallable<PatchWireGroupRequest,Operation> patchCallable()

Updates the specified wire group resource with the data included in the request. This method supportsPATCH semantics and usesJSON 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 (WireGroupsClient wireGroupsClient = WireGroupsClient.create()) {
   PatchWireGroupRequest request =
       PatchWireGroupRequest.newBuilder()
           .setCrossSiteNetwork("crossSiteNetwork1009388679")
           .setProject("project-309310695")
           .setRequestId("requestId693933066")
           .setUpdateMask("updateMask-296147115")
           .setValidateOnly(true)
           .setWireGroup("wireGroup-970399494")
           .setWireGroupResource(WireGroup.newBuilder().build())
           .build();
   ApiFuture<Operation> future = wireGroupsClient.patchCallable().futureCall(request);
   // Do something.
   Operation response = future.get();
 }
Returns
Type Description
UnaryCallable<PatchWireGroupRequest,Operation>

patchOperationCallable()

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

Updates the specified wire group resource with the data included in the request. This method supportsPATCH semantics and usesJSON 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 (WireGroupsClient wireGroupsClient = WireGroupsClient.create()) {
   PatchWireGroupRequest request =
       PatchWireGroupRequest.newBuilder()
           .setCrossSiteNetwork("crossSiteNetwork1009388679")
           .setProject("project-309310695")
           .setRequestId("requestId693933066")
           .setUpdateMask("updateMask-296147115")
           .setValidateOnly(true)
           .setWireGroup("wireGroup-970399494")
           .setWireGroupResource(WireGroup.newBuilder().build())
           .build();
   OperationFuture<Operation, Operation> future =
       wireGroupsClient.patchOperationCallable().futureCall(request);
   // Do something.
   Operation response = future.get();
 }
Returns
Type Description
OperationCallable<PatchWireGroupRequest,Operation,Operation>

shutdown()

public void shutdown()

shutdownNow()

public void shutdownNow()