Class PrivateAuctionServiceClient (0.27.0)

Service Description: Provides methods for handling PrivateAuction objects.

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 (PrivateAuctionServiceClient privateAuctionServiceClient =
     PrivateAuctionServiceClient.create()) {
   PrivateAuctionName name = PrivateAuctionName.of("[NETWORK_CODE]", "[PRIVATE_AUCTION]");
   PrivateAuction response = privateAuctionServiceClient.getPrivateAuction(name);
 }

Note: close() needs to be called on the PrivateAuctionServiceClient 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
GetPrivateAuction	API to retrieve a `PrivateAuction` object.	Request object method variants only take one parameter, a request object, which must be constructed before the call. getPrivateAuction(GetPrivateAuctionRequest request) "Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method. getPrivateAuction(PrivateAuctionName name) getPrivateAuction(String name) Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. getPrivateAuctionCallable()
ListPrivateAuctions	API to retrieve a list of `PrivateAuction` objects.	Request object method variants only take one parameter, a request object, which must be constructed before the call. listPrivateAuctions(ListPrivateAuctionsRequest request) "Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method. listPrivateAuctions(NetworkName parent) listPrivateAuctions(String parent) Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. listPrivateAuctionsPagedCallable() listPrivateAuctionsCallable()
CreatePrivateAuction	API to create a `PrivateAuction` object.	Request object method variants only take one parameter, a request object, which must be constructed before the call. createPrivateAuction(CreatePrivateAuctionRequest request) "Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method. createPrivateAuction(NetworkName parent, PrivateAuction privateAuction) createPrivateAuction(String parent, PrivateAuction privateAuction) Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. createPrivateAuctionCallable()
UpdatePrivateAuction	API to update a `PrivateAuction` object.	Request object method variants only take one parameter, a request object, which must be constructed before the call. updatePrivateAuction(UpdatePrivateAuctionRequest request) "Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method. updatePrivateAuction(PrivateAuction privateAuction, FieldMask updateMask) Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. updatePrivateAuctionCallable()

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 PrivateAuctionServiceSettings 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
 PrivateAuctionServiceSettings privateAuctionServiceSettings =
     PrivateAuctionServiceSettings.newBuilder()
         .setCredentialsProvider(FixedCredentialsProvider.create(myCredentials))
         .build();
 PrivateAuctionServiceClient privateAuctionServiceClient =
     PrivateAuctionServiceClient.create(privateAuctionServiceSettings);

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
 PrivateAuctionServiceSettings privateAuctionServiceSettings =
     PrivateAuctionServiceSettings.newBuilder().setEndpoint(myEndpoint).build();
 PrivateAuctionServiceClient privateAuctionServiceClient =
     PrivateAuctionServiceClient.create(privateAuctionServiceSettings);

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

Inheritance

java.lang.Object > PrivateAuctionServiceClient

Static Methods

create()

public static final PrivateAuctionServiceClient create()

Constructs an instance of PrivateAuctionServiceClient with default settings.

Returns
Type	Description
`PrivateAuctionServiceClient`

Exceptions
Type	Description
`IOException`

create(PrivateAuctionServiceSettings settings)

public static final PrivateAuctionServiceClient create(PrivateAuctionServiceSettings settings)

Constructs an instance of PrivateAuctionServiceClient, 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`	`PrivateAuctionServiceSettings`

Returns
Type	Description
`PrivateAuctionServiceClient`

Exceptions
Type	Description
`IOException`

create(PrivateAuctionServiceStub stub)

public static final PrivateAuctionServiceClient create(PrivateAuctionServiceStub stub)

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

Parameter
Name	Description
`stub`	`PrivateAuctionServiceStub`

Returns
Type	Description
`PrivateAuctionServiceClient`

Constructors

PrivateAuctionServiceClient(PrivateAuctionServiceSettings settings)

protected PrivateAuctionServiceClient(PrivateAuctionServiceSettings settings)

Constructs an instance of PrivateAuctionServiceClient, 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`	`PrivateAuctionServiceSettings`

PrivateAuctionServiceClient(PrivateAuctionServiceStub stub)

protected PrivateAuctionServiceClient(PrivateAuctionServiceStub stub)

Parameter
Name	Description
`stub`	`PrivateAuctionServiceStub`

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

createPrivateAuction(CreatePrivateAuctionRequest request)

public final PrivateAuction createPrivateAuction(CreatePrivateAuctionRequest request)

API to create a PrivateAuction object.

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 (PrivateAuctionServiceClient privateAuctionServiceClient =
     PrivateAuctionServiceClient.create()) {
   CreatePrivateAuctionRequest request =
       CreatePrivateAuctionRequest.newBuilder()
           .setParent(NetworkName.of("[NETWORK_CODE]").toString())
           .setPrivateAuction(PrivateAuction.newBuilder().build())
           .build();
   PrivateAuction response = privateAuctionServiceClient.createPrivateAuction(request);
 }

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

Returns
Type	Description
`PrivateAuction`

createPrivateAuction(NetworkName parent, PrivateAuction privateAuction)

public final PrivateAuction createPrivateAuction(NetworkName parent, PrivateAuction privateAuction)

API to create a PrivateAuction object.

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 (PrivateAuctionServiceClient privateAuctionServiceClient =
     PrivateAuctionServiceClient.create()) {
   NetworkName parent = NetworkName.of("[NETWORK_CODE]");
   PrivateAuction privateAuction = PrivateAuction.newBuilder().build();
   PrivateAuction response =
       privateAuctionServiceClient.createPrivateAuction(parent, privateAuction);
 }

Parameters
Name	Description
`parent`	`NetworkName` Required. The parent resource where this `PrivateAuction` will be created. Format: `networks/{network_code}`
`privateAuction`	`PrivateAuction` Required. The `PrivateAuction` to create.

Returns
Type	Description
`PrivateAuction`

createPrivateAuction(String parent, PrivateAuction privateAuction)

public final PrivateAuction createPrivateAuction(String parent, PrivateAuction privateAuction)

API to create a PrivateAuction object.

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 (PrivateAuctionServiceClient privateAuctionServiceClient =
     PrivateAuctionServiceClient.create()) {
   String parent = NetworkName.of("[NETWORK_CODE]").toString();
   PrivateAuction privateAuction = PrivateAuction.newBuilder().build();
   PrivateAuction response =
       privateAuctionServiceClient.createPrivateAuction(parent, privateAuction);
 }

Parameters
Name	Description
`parent`	`String` Required. The parent resource where this `PrivateAuction` will be created. Format: `networks/{network_code}`
`privateAuction`	`PrivateAuction` Required. The `PrivateAuction` to create.

Returns
Type	Description
`PrivateAuction`

createPrivateAuctionCallable()

public final UnaryCallable<CreatePrivateAuctionRequest,PrivateAuction> createPrivateAuctionCallable()

API to create a PrivateAuction object.

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 (PrivateAuctionServiceClient privateAuctionServiceClient =
     PrivateAuctionServiceClient.create()) {
   CreatePrivateAuctionRequest request =
       CreatePrivateAuctionRequest.newBuilder()
           .setParent(NetworkName.of("[NETWORK_CODE]").toString())
           .setPrivateAuction(PrivateAuction.newBuilder().build())
           .build();
   ApiFuture<PrivateAuction> future =
       privateAuctionServiceClient.createPrivateAuctionCallable().futureCall(request);
   // Do something.
   PrivateAuction response = future.get();
 }

Returns
Type	Description
`UnaryCallable<CreatePrivateAuctionRequest,PrivateAuction>`

getPrivateAuction(GetPrivateAuctionRequest request)

public final PrivateAuction getPrivateAuction(GetPrivateAuctionRequest request)

API to retrieve a PrivateAuction object.

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 (PrivateAuctionServiceClient privateAuctionServiceClient =
     PrivateAuctionServiceClient.create()) {
   GetPrivateAuctionRequest request =
       GetPrivateAuctionRequest.newBuilder()
           .setName(PrivateAuctionName.of("[NETWORK_CODE]", "[PRIVATE_AUCTION]").toString())
           .build();
   PrivateAuction response = privateAuctionServiceClient.getPrivateAuction(request);
 }

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

Returns
Type	Description
`PrivateAuction`

getPrivateAuction(PrivateAuctionName name)

public final PrivateAuction getPrivateAuction(PrivateAuctionName name)

API to retrieve a PrivateAuction object.

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 (PrivateAuctionServiceClient privateAuctionServiceClient =
     PrivateAuctionServiceClient.create()) {
   PrivateAuctionName name = PrivateAuctionName.of("[NETWORK_CODE]", "[PRIVATE_AUCTION]");
   PrivateAuction response = privateAuctionServiceClient.getPrivateAuction(name);
 }

Parameter
Name	Description
`name`	`PrivateAuctionName` Required. The resource name of the PrivateAuction. Format: `networks/{network_code}/privateAuctions/{private_auction_id}`

Returns
Type	Description
`PrivateAuction`

getPrivateAuction(String name)

public final PrivateAuction getPrivateAuction(String name)

API to retrieve a PrivateAuction object.

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 (PrivateAuctionServiceClient privateAuctionServiceClient =
     PrivateAuctionServiceClient.create()) {
   String name = PrivateAuctionName.of("[NETWORK_CODE]", "[PRIVATE_AUCTION]").toString();
   PrivateAuction response = privateAuctionServiceClient.getPrivateAuction(name);
 }

Parameter
Name	Description
`name`	`String` Required. The resource name of the PrivateAuction. Format: `networks/{network_code}/privateAuctions/{private_auction_id}`

Returns
Type	Description
`PrivateAuction`

getPrivateAuctionCallable()

public final UnaryCallable<GetPrivateAuctionRequest,PrivateAuction> getPrivateAuctionCallable()

API to retrieve a PrivateAuction object.

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 (PrivateAuctionServiceClient privateAuctionServiceClient =
     PrivateAuctionServiceClient.create()) {
   GetPrivateAuctionRequest request =
       GetPrivateAuctionRequest.newBuilder()
           .setName(PrivateAuctionName.of("[NETWORK_CODE]", "[PRIVATE_AUCTION]").toString())
           .build();
   ApiFuture<PrivateAuction> future =
       privateAuctionServiceClient.getPrivateAuctionCallable().futureCall(request);
   // Do something.
   PrivateAuction response = future.get();
 }

Returns
Type	Description
`UnaryCallable<GetPrivateAuctionRequest,PrivateAuction>`

getSettings()

public final PrivateAuctionServiceSettings getSettings()

Returns
Type	Description
`PrivateAuctionServiceSettings`

getStub()

public PrivateAuctionServiceStub getStub()

Returns
Type	Description
`PrivateAuctionServiceStub`

isShutdown()

public boolean isShutdown()

Returns
Type	Description
`boolean`

isTerminated()

public boolean isTerminated()

Returns
Type	Description
`boolean`

listPrivateAuctions(ListPrivateAuctionsRequest request)

public final PrivateAuctionServiceClient.ListPrivateAuctionsPagedResponse listPrivateAuctions(ListPrivateAuctionsRequest request)

API to retrieve a list of PrivateAuction objects.

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 (PrivateAuctionServiceClient privateAuctionServiceClient =
     PrivateAuctionServiceClient.create()) {
   ListPrivateAuctionsRequest request =
       ListPrivateAuctionsRequest.newBuilder()
           .setParent(NetworkName.of("[NETWORK_CODE]").toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .setFilter("filter-1274492040")
           .setOrderBy("orderBy-1207110587")
           .setSkip(3532159)
           .build();
   for (PrivateAuction element :
       privateAuctionServiceClient.listPrivateAuctions(request).iterateAll()) {
     // doThingsWith(element);
   }
 }

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

Returns
Type	Description
`PrivateAuctionServiceClient.ListPrivateAuctionsPagedResponse`

listPrivateAuctions(NetworkName parent)

public final PrivateAuctionServiceClient.ListPrivateAuctionsPagedResponse listPrivateAuctions(NetworkName parent)

API to retrieve a list of PrivateAuction objects.

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 (PrivateAuctionServiceClient privateAuctionServiceClient =
     PrivateAuctionServiceClient.create()) {
   NetworkName parent = NetworkName.of("[NETWORK_CODE]");
   for (PrivateAuction element :
       privateAuctionServiceClient.listPrivateAuctions(parent).iterateAll()) {
     // doThingsWith(element);
   }
 }

Parameter
Name	Description
`parent`	`NetworkName` Required. The parent, which owns this collection of PrivateAuctions. Format: `networks/{network_code}`

Returns
Type	Description
`PrivateAuctionServiceClient.ListPrivateAuctionsPagedResponse`

listPrivateAuctions(String parent)

public final PrivateAuctionServiceClient.ListPrivateAuctionsPagedResponse listPrivateAuctions(String parent)

API to retrieve a list of PrivateAuction objects.

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 (PrivateAuctionServiceClient privateAuctionServiceClient =
     PrivateAuctionServiceClient.create()) {
   String parent = NetworkName.of("[NETWORK_CODE]").toString();
   for (PrivateAuction element :
       privateAuctionServiceClient.listPrivateAuctions(parent).iterateAll()) {
     // doThingsWith(element);
   }
 }

Parameter
Name	Description
`parent`	`String` Required. The parent, which owns this collection of PrivateAuctions. Format: `networks/{network_code}`

Returns
Type	Description
`PrivateAuctionServiceClient.ListPrivateAuctionsPagedResponse`

listPrivateAuctionsCallable()

public final UnaryCallable<ListPrivateAuctionsRequest,ListPrivateAuctionsResponse> listPrivateAuctionsCallable()

API to retrieve a list of PrivateAuction objects.

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 (PrivateAuctionServiceClient privateAuctionServiceClient =
     PrivateAuctionServiceClient.create()) {
   ListPrivateAuctionsRequest request =
       ListPrivateAuctionsRequest.newBuilder()
           .setParent(NetworkName.of("[NETWORK_CODE]").toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .setFilter("filter-1274492040")
           .setOrderBy("orderBy-1207110587")
           .setSkip(3532159)
           .build();
   while (true) {
     ListPrivateAuctionsResponse response =
         privateAuctionServiceClient.listPrivateAuctionsCallable().call(request);
     for (PrivateAuction element : response.getPrivateAuctionsList()) {
       // doThingsWith(element);
     }
     String nextPageToken = response.getNextPageToken();
     if (!Strings.isNullOrEmpty(nextPageToken)) {
       request = request.toBuilder().setPageToken(nextPageToken).build();
     } else {
       break;
     }
   }
 }

Returns
Type	Description
`UnaryCallable<ListPrivateAuctionsRequest,ListPrivateAuctionsResponse>`

listPrivateAuctionsPagedCallable()

public final UnaryCallable<ListPrivateAuctionsRequest,PrivateAuctionServiceClient.ListPrivateAuctionsPagedResponse> listPrivateAuctionsPagedCallable()

API to retrieve a list of PrivateAuction objects.

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 (PrivateAuctionServiceClient privateAuctionServiceClient =
     PrivateAuctionServiceClient.create()) {
   ListPrivateAuctionsRequest request =
       ListPrivateAuctionsRequest.newBuilder()
           .setParent(NetworkName.of("[NETWORK_CODE]").toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .setFilter("filter-1274492040")
           .setOrderBy("orderBy-1207110587")
           .setSkip(3532159)
           .build();
   ApiFuture<PrivateAuction> future =
       privateAuctionServiceClient.listPrivateAuctionsPagedCallable().futureCall(request);
   // Do something.
   for (PrivateAuction element : future.get().iterateAll()) {
     // doThingsWith(element);
   }
 }

Returns
Type	Description
`UnaryCallable<ListPrivateAuctionsRequest,ListPrivateAuctionsPagedResponse>`

shutdown()

public void shutdown()

shutdownNow()

public void shutdownNow()

updatePrivateAuction(PrivateAuction privateAuction, FieldMask updateMask)

public final PrivateAuction updatePrivateAuction(PrivateAuction privateAuction, FieldMask updateMask)

API to update a PrivateAuction object.

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 (PrivateAuctionServiceClient privateAuctionServiceClient =
     PrivateAuctionServiceClient.create()) {
   PrivateAuction privateAuction = PrivateAuction.newBuilder().build();
   FieldMask updateMask = FieldMask.newBuilder().build();
   PrivateAuction response =
       privateAuctionServiceClient.updatePrivateAuction(privateAuction, updateMask);
 }

Parameters

Name Description

privateAuction

PrivateAuction

Required. The PrivateAuction to update.

The PrivateAuction's name is used to identify the PrivateAuction to update.

updateMask

FieldMask

Required. The list of fields to update.

Returns
Type	Description
`PrivateAuction`

updatePrivateAuction(UpdatePrivateAuctionRequest request)

public final PrivateAuction updatePrivateAuction(UpdatePrivateAuctionRequest request)

API to update a PrivateAuction object.

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 (PrivateAuctionServiceClient privateAuctionServiceClient =
     PrivateAuctionServiceClient.create()) {
   UpdatePrivateAuctionRequest request =
       UpdatePrivateAuctionRequest.newBuilder()
           .setPrivateAuction(PrivateAuction.newBuilder().build())
           .setUpdateMask(FieldMask.newBuilder().build())
           .build();
   PrivateAuction response = privateAuctionServiceClient.updatePrivateAuction(request);
 }

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

Returns
Type	Description
`PrivateAuction`

updatePrivateAuctionCallable()

public final UnaryCallable<UpdatePrivateAuctionRequest,PrivateAuction> updatePrivateAuctionCallable()

API to update a PrivateAuction object.

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 (PrivateAuctionServiceClient privateAuctionServiceClient =
     PrivateAuctionServiceClient.create()) {
   UpdatePrivateAuctionRequest request =
       UpdatePrivateAuctionRequest.newBuilder()
           .setPrivateAuction(PrivateAuction.newBuilder().build())
           .setUpdateMask(FieldMask.newBuilder().build())
           .build();
   ApiFuture<PrivateAuction> future =
       privateAuctionServiceClient.updatePrivateAuctionCallable().futureCall(request);
   // Do something.
   PrivateAuction response = future.get();
 }

Returns
Type	Description
`UnaryCallable<UpdatePrivateAuctionRequest,PrivateAuction>`

Class PrivateAuctionServiceClient (0.27.0) Stay organized with collections Save and categorize content based on your preferences.

Inheritance

Static Methods

create()

create(PrivateAuctionServiceSettings settings)

create(PrivateAuctionServiceStub stub)

Constructors

PrivateAuctionServiceClient(PrivateAuctionServiceSettings settings)

PrivateAuctionServiceClient(PrivateAuctionServiceStub stub)

Methods

awaitTermination(long duration, TimeUnit unit)

close()

createPrivateAuction(CreatePrivateAuctionRequest request)

createPrivateAuction(NetworkName parent, PrivateAuction privateAuction)

createPrivateAuction(String parent, PrivateAuction privateAuction)

createPrivateAuctionCallable()

getPrivateAuction(GetPrivateAuctionRequest request)

getPrivateAuction(PrivateAuctionName name)

getPrivateAuction(String name)

getPrivateAuctionCallable()

getSettings()

getStub()

isShutdown()

isTerminated()

listPrivateAuctions(ListPrivateAuctionsRequest request)

listPrivateAuctions(NetworkName parent)

listPrivateAuctions(String parent)

listPrivateAuctionsCallable()

listPrivateAuctionsPagedCallable()

shutdown()

shutdownNow()

updatePrivateAuction(PrivateAuction privateAuction, FieldMask updateMask)

updatePrivateAuction(UpdatePrivateAuctionRequest request)

updatePrivateAuctionCallable()

Class PrivateAuctionServiceClient (0.27.0)