Class PrivateAuctionDealServiceClient (0.27.0)

GitHub RepositoryProduct Reference

Service Description: Provides methods for handling PrivateAuctionDeal 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 (PrivateAuctionDealServiceClient privateAuctionDealServiceClient =
     PrivateAuctionDealServiceClient.create()) {
   PrivateAuctionDealName name =
       PrivateAuctionDealName.of("[NETWORK_CODE]", "[PRIVATE_AUCTION_DEAL]");
   PrivateAuctionDeal response = privateAuctionDealServiceClient.getPrivateAuctionDeal(name);
 }

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

GetPrivateAuctionDeal

API to retrieve a PrivateAuctionDeal object.

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

  • getPrivateAuctionDeal(GetPrivateAuctionDealRequest request)

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

  • getPrivateAuctionDeal(PrivateAuctionDealName name)

  • getPrivateAuctionDeal(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.

  • getPrivateAuctionDealCallable()

ListPrivateAuctionDeals

API to retrieve a list of PrivateAuctionDeal objects.

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

  • listPrivateAuctionDeals(ListPrivateAuctionDealsRequest request)

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

  • listPrivateAuctionDeals(NetworkName parent)

  • listPrivateAuctionDeals(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.

  • listPrivateAuctionDealsPagedCallable()

  • listPrivateAuctionDealsCallable()

CreatePrivateAuctionDeal

API to create a PrivateAuctionDeal object.

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

  • createPrivateAuctionDeal(CreatePrivateAuctionDealRequest request)

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

  • createPrivateAuctionDeal(NetworkName parent, PrivateAuctionDeal privateAuctionDeal)

  • createPrivateAuctionDeal(String parent, PrivateAuctionDeal privateAuctionDeal)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • createPrivateAuctionDealCallable()

UpdatePrivateAuctionDeal

API to update a PrivateAuctionDeal object.

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

  • updatePrivateAuctionDeal(UpdatePrivateAuctionDealRequest request)

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

  • updatePrivateAuctionDeal(PrivateAuctionDeal privateAuctionDeal, 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.

  • updatePrivateAuctionDealCallable()

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 PrivateAuctionDealServiceSettings 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
 PrivateAuctionDealServiceSettings privateAuctionDealServiceSettings =
     PrivateAuctionDealServiceSettings.newBuilder()
         .setCredentialsProvider(FixedCredentialsProvider.create(myCredentials))
         .build();
 PrivateAuctionDealServiceClient privateAuctionDealServiceClient =
     PrivateAuctionDealServiceClient.create(privateAuctionDealServiceSettings);

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
 PrivateAuctionDealServiceSettings privateAuctionDealServiceSettings =
     PrivateAuctionDealServiceSettings.newBuilder().setEndpoint(myEndpoint).build();
 PrivateAuctionDealServiceClient privateAuctionDealServiceClient =
     PrivateAuctionDealServiceClient.create(privateAuctionDealServiceSettings);

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

Inheritance

java.lang.Object > PrivateAuctionDealServiceClient

Static Methods

create()

public static final PrivateAuctionDealServiceClient create()

Constructs an instance of PrivateAuctionDealServiceClient with default settings.

Returns
Type Description
PrivateAuctionDealServiceClient
Exceptions
Type Description
IOException

create(PrivateAuctionDealServiceSettings settings)

public static final PrivateAuctionDealServiceClient create(PrivateAuctionDealServiceSettings settings)

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

create(PrivateAuctionDealServiceStub stub)

public static final PrivateAuctionDealServiceClient create(PrivateAuctionDealServiceStub stub)

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

Parameter
Name Description
stub PrivateAuctionDealServiceStub
Returns
Type Description
PrivateAuctionDealServiceClient

Constructors

PrivateAuctionDealServiceClient(PrivateAuctionDealServiceSettings settings)

protected PrivateAuctionDealServiceClient(PrivateAuctionDealServiceSettings settings)

Constructs an instance of PrivateAuctionDealServiceClient, 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 PrivateAuctionDealServiceSettings

PrivateAuctionDealServiceClient(PrivateAuctionDealServiceStub stub)

protected PrivateAuctionDealServiceClient(PrivateAuctionDealServiceStub stub)
Parameter
Name Description
stub PrivateAuctionDealServiceStub

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

createPrivateAuctionDeal(CreatePrivateAuctionDealRequest request)

public final PrivateAuctionDeal createPrivateAuctionDeal(CreatePrivateAuctionDealRequest request)

API to create a PrivateAuctionDeal 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 (PrivateAuctionDealServiceClient privateAuctionDealServiceClient =
     PrivateAuctionDealServiceClient.create()) {
   CreatePrivateAuctionDealRequest request =
       CreatePrivateAuctionDealRequest.newBuilder()
           .setParent(NetworkName.of("[NETWORK_CODE]").toString())
           .setPrivateAuctionDeal(PrivateAuctionDeal.newBuilder().build())
           .build();
   PrivateAuctionDeal response =
       privateAuctionDealServiceClient.createPrivateAuctionDeal(request);
 }
Parameter
Name Description
request CreatePrivateAuctionDealRequest

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

createPrivateAuctionDeal(NetworkName parent, PrivateAuctionDeal privateAuctionDeal)

public final PrivateAuctionDeal createPrivateAuctionDeal(NetworkName parent, PrivateAuctionDeal privateAuctionDeal)

API to create a PrivateAuctionDeal 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 (PrivateAuctionDealServiceClient privateAuctionDealServiceClient =
     PrivateAuctionDealServiceClient.create()) {
   NetworkName parent = NetworkName.of("[NETWORK_CODE]");
   PrivateAuctionDeal privateAuctionDeal = PrivateAuctionDeal.newBuilder().build();
   PrivateAuctionDeal response =
       privateAuctionDealServiceClient.createPrivateAuctionDeal(parent, privateAuctionDeal);
 }
Parameters
Name Description
parent NetworkName

Required. The parent resource where this PrivateAuctionDeal will be created. Format: networks/{network_code}
privateAuctionDeal PrivateAuctionDeal

Required. The PrivateAuctionDeal to create.
Returns
Type Description
PrivateAuctionDeal

createPrivateAuctionDeal(String parent, PrivateAuctionDeal privateAuctionDeal)

public final PrivateAuctionDeal createPrivateAuctionDeal(String parent, PrivateAuctionDeal privateAuctionDeal)

API to create a PrivateAuctionDeal 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 (PrivateAuctionDealServiceClient privateAuctionDealServiceClient =
     PrivateAuctionDealServiceClient.create()) {
   String parent = NetworkName.of("[NETWORK_CODE]").toString();
   PrivateAuctionDeal privateAuctionDeal = PrivateAuctionDeal.newBuilder().build();
   PrivateAuctionDeal response =
       privateAuctionDealServiceClient.createPrivateAuctionDeal(parent, privateAuctionDeal);
 }
Parameters
Name Description
parent String

Required. The parent resource where this PrivateAuctionDeal will be created. Format: networks/{network_code}
privateAuctionDeal PrivateAuctionDeal

Required. The PrivateAuctionDeal to create.
Returns
Type Description
PrivateAuctionDeal

createPrivateAuctionDealCallable()

public final UnaryCallable<CreatePrivateAuctionDealRequest,PrivateAuctionDeal> createPrivateAuctionDealCallable()

API to create a PrivateAuctionDeal 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 (PrivateAuctionDealServiceClient privateAuctionDealServiceClient =
     PrivateAuctionDealServiceClient.create()) {
   CreatePrivateAuctionDealRequest request =
       CreatePrivateAuctionDealRequest.newBuilder()
           .setParent(NetworkName.of("[NETWORK_CODE]").toString())
           .setPrivateAuctionDeal(PrivateAuctionDeal.newBuilder().build())
           .build();
   ApiFuture<PrivateAuctionDeal> future =
       privateAuctionDealServiceClient.createPrivateAuctionDealCallable().futureCall(request);
   // Do something.
   PrivateAuctionDeal response = future.get();
 }
Returns
Type Description
UnaryCallable<CreatePrivateAuctionDealRequest,PrivateAuctionDeal>

getPrivateAuctionDeal(GetPrivateAuctionDealRequest request)

public final PrivateAuctionDeal getPrivateAuctionDeal(GetPrivateAuctionDealRequest request)

API to retrieve a PrivateAuctionDeal 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 (PrivateAuctionDealServiceClient privateAuctionDealServiceClient =
     PrivateAuctionDealServiceClient.create()) {
   GetPrivateAuctionDealRequest request =
       GetPrivateAuctionDealRequest.newBuilder()
           .setName(
               PrivateAuctionDealName.of("[NETWORK_CODE]", "[PRIVATE_AUCTION_DEAL]").toString())
           .build();
   PrivateAuctionDeal response = privateAuctionDealServiceClient.getPrivateAuctionDeal(request);
 }
Parameter
Name Description
request GetPrivateAuctionDealRequest

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

getPrivateAuctionDeal(PrivateAuctionDealName name)

public final PrivateAuctionDeal getPrivateAuctionDeal(PrivateAuctionDealName name)

API to retrieve a PrivateAuctionDeal 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 (PrivateAuctionDealServiceClient privateAuctionDealServiceClient =
     PrivateAuctionDealServiceClient.create()) {
   PrivateAuctionDealName name =
       PrivateAuctionDealName.of("[NETWORK_CODE]", "[PRIVATE_AUCTION_DEAL]");
   PrivateAuctionDeal response = privateAuctionDealServiceClient.getPrivateAuctionDeal(name);
 }
Parameter
Name Description
name PrivateAuctionDealName

Required. The resource name of the PrivateAuctionDeal. Format: networks/{network_code}/privateAuctionDeals/{private_auction_deal_id}
Returns
Type Description
PrivateAuctionDeal

getPrivateAuctionDeal(String name)

public final PrivateAuctionDeal getPrivateAuctionDeal(String name)

API to retrieve a PrivateAuctionDeal 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 (PrivateAuctionDealServiceClient privateAuctionDealServiceClient =
     PrivateAuctionDealServiceClient.create()) {
   String name =
       PrivateAuctionDealName.of("[NETWORK_CODE]", "[PRIVATE_AUCTION_DEAL]").toString();
   PrivateAuctionDeal response = privateAuctionDealServiceClient.getPrivateAuctionDeal(name);
 }
Parameter
Name Description
name String

Required. The resource name of the PrivateAuctionDeal. Format: networks/{network_code}/privateAuctionDeals/{private_auction_deal_id}
Returns
Type Description
PrivateAuctionDeal

getPrivateAuctionDealCallable()

public final UnaryCallable<GetPrivateAuctionDealRequest,PrivateAuctionDeal> getPrivateAuctionDealCallable()

API to retrieve a PrivateAuctionDeal 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 (PrivateAuctionDealServiceClient privateAuctionDealServiceClient =
     PrivateAuctionDealServiceClient.create()) {
   GetPrivateAuctionDealRequest request =
       GetPrivateAuctionDealRequest.newBuilder()
           .setName(
               PrivateAuctionDealName.of("[NETWORK_CODE]", "[PRIVATE_AUCTION_DEAL]").toString())
           .build();
   ApiFuture<PrivateAuctionDeal> future =
       privateAuctionDealServiceClient.getPrivateAuctionDealCallable().futureCall(request);
   // Do something.
   PrivateAuctionDeal response = future.get();
 }
Returns
Type Description
UnaryCallable<GetPrivateAuctionDealRequest,PrivateAuctionDeal>

getSettings()

public final PrivateAuctionDealServiceSettings getSettings()
Returns
Type Description
PrivateAuctionDealServiceSettings

getStub()

public PrivateAuctionDealServiceStub getStub()
Returns
Type Description
PrivateAuctionDealServiceStub

isShutdown()

public boolean isShutdown()
Returns
Type Description
boolean

isTerminated()

public boolean isTerminated()
Returns
Type Description
boolean

listPrivateAuctionDeals(ListPrivateAuctionDealsRequest request)

public final PrivateAuctionDealServiceClient.ListPrivateAuctionDealsPagedResponse listPrivateAuctionDeals(ListPrivateAuctionDealsRequest request)

API to retrieve a list of PrivateAuctionDeal 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 (PrivateAuctionDealServiceClient privateAuctionDealServiceClient =
     PrivateAuctionDealServiceClient.create()) {
   ListPrivateAuctionDealsRequest request =
       ListPrivateAuctionDealsRequest.newBuilder()
           .setParent(NetworkName.of("[NETWORK_CODE]").toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .setFilter("filter-1274492040")
           .setOrderBy("orderBy-1207110587")
           .setSkip(3532159)
           .build();
   for (PrivateAuctionDeal element :
       privateAuctionDealServiceClient.listPrivateAuctionDeals(request).iterateAll()) {
     // doThingsWith(element);
   }
 }
Parameter
Name Description
request ListPrivateAuctionDealsRequest

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

listPrivateAuctionDeals(NetworkName parent)

public final PrivateAuctionDealServiceClient.ListPrivateAuctionDealsPagedResponse listPrivateAuctionDeals(NetworkName parent)

API to retrieve a list of PrivateAuctionDeal 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 (PrivateAuctionDealServiceClient privateAuctionDealServiceClient =
     PrivateAuctionDealServiceClient.create()) {
   NetworkName parent = NetworkName.of("[NETWORK_CODE]");
   for (PrivateAuctionDeal element :
       privateAuctionDealServiceClient.listPrivateAuctionDeals(parent).iterateAll()) {
     // doThingsWith(element);
   }
 }
Parameter
Name Description
parent NetworkName

Required. The parent, which owns this collection of PrivateAuctionDeals. Format: networks/{network_code}
Returns
Type Description
PrivateAuctionDealServiceClient.ListPrivateAuctionDealsPagedResponse

listPrivateAuctionDeals(String parent)

public final PrivateAuctionDealServiceClient.ListPrivateAuctionDealsPagedResponse listPrivateAuctionDeals(String parent)

API to retrieve a list of PrivateAuctionDeal 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 (PrivateAuctionDealServiceClient privateAuctionDealServiceClient =
     PrivateAuctionDealServiceClient.create()) {
   String parent = NetworkName.of("[NETWORK_CODE]").toString();
   for (PrivateAuctionDeal element :
       privateAuctionDealServiceClient.listPrivateAuctionDeals(parent).iterateAll()) {
     // doThingsWith(element);
   }
 }
Parameter
Name Description
parent String

Required. The parent, which owns this collection of PrivateAuctionDeals. Format: networks/{network_code}
Returns
Type Description
PrivateAuctionDealServiceClient.ListPrivateAuctionDealsPagedResponse

listPrivateAuctionDealsCallable()

public final UnaryCallable<ListPrivateAuctionDealsRequest,ListPrivateAuctionDealsResponse> listPrivateAuctionDealsCallable()

API to retrieve a list of PrivateAuctionDeal 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 (PrivateAuctionDealServiceClient privateAuctionDealServiceClient =
     PrivateAuctionDealServiceClient.create()) {
   ListPrivateAuctionDealsRequest request =
       ListPrivateAuctionDealsRequest.newBuilder()
           .setParent(NetworkName.of("[NETWORK_CODE]").toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .setFilter("filter-1274492040")
           .setOrderBy("orderBy-1207110587")
           .setSkip(3532159)
           .build();
   while (true) {
     ListPrivateAuctionDealsResponse response =
         privateAuctionDealServiceClient.listPrivateAuctionDealsCallable().call(request);
     for (PrivateAuctionDeal element : response.getPrivateAuctionDealsList()) {
       // doThingsWith(element);
     }
     String nextPageToken = response.getNextPageToken();
     if (!Strings.isNullOrEmpty(nextPageToken)) {
       request = request.toBuilder().setPageToken(nextPageToken).build();
     } else {
       break;
     }
   }
 }
Returns
Type Description
UnaryCallable<ListPrivateAuctionDealsRequest,ListPrivateAuctionDealsResponse>

listPrivateAuctionDealsPagedCallable()

public final UnaryCallable<ListPrivateAuctionDealsRequest,PrivateAuctionDealServiceClient.ListPrivateAuctionDealsPagedResponse> listPrivateAuctionDealsPagedCallable()

API to retrieve a list of PrivateAuctionDeal 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 (PrivateAuctionDealServiceClient privateAuctionDealServiceClient =
     PrivateAuctionDealServiceClient.create()) {
   ListPrivateAuctionDealsRequest request =
       ListPrivateAuctionDealsRequest.newBuilder()
           .setParent(NetworkName.of("[NETWORK_CODE]").toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .setFilter("filter-1274492040")
           .setOrderBy("orderBy-1207110587")
           .setSkip(3532159)
           .build();
   ApiFuture<PrivateAuctionDeal> future =
       privateAuctionDealServiceClient
           .listPrivateAuctionDealsPagedCallable()
           .futureCall(request);
   // Do something.
   for (PrivateAuctionDeal element : future.get().iterateAll()) {
     // doThingsWith(element);
   }
 }
Returns
Type Description
UnaryCallable<ListPrivateAuctionDealsRequest,ListPrivateAuctionDealsPagedResponse>

shutdown()

public void shutdown()

shutdownNow()

public void shutdownNow()

updatePrivateAuctionDeal(PrivateAuctionDeal privateAuctionDeal, FieldMask updateMask)

public final PrivateAuctionDeal updatePrivateAuctionDeal(PrivateAuctionDeal privateAuctionDeal, FieldMask updateMask)

API to update a PrivateAuctionDeal 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 (PrivateAuctionDealServiceClient privateAuctionDealServiceClient =
     PrivateAuctionDealServiceClient.create()) {
   PrivateAuctionDeal privateAuctionDeal = PrivateAuctionDeal.newBuilder().build();
   FieldMask updateMask = FieldMask.newBuilder().build();
   PrivateAuctionDeal response =
       privateAuctionDealServiceClient.updatePrivateAuctionDeal(privateAuctionDeal, updateMask);
 }
Parameters
Name Description
privateAuctionDeal PrivateAuctionDeal

Required. The PrivateAuctionDeal to update.

The PrivateAuctionDeal's name is used to identify the PrivateAuctionDeal to update.
updateMask FieldMask

Required. The list of fields to update.
Returns
Type Description
PrivateAuctionDeal

updatePrivateAuctionDeal(UpdatePrivateAuctionDealRequest request)

public final PrivateAuctionDeal updatePrivateAuctionDeal(UpdatePrivateAuctionDealRequest request)

API to update a PrivateAuctionDeal 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 (PrivateAuctionDealServiceClient privateAuctionDealServiceClient =
     PrivateAuctionDealServiceClient.create()) {
   UpdatePrivateAuctionDealRequest request =
       UpdatePrivateAuctionDealRequest.newBuilder()
           .setPrivateAuctionDeal(PrivateAuctionDeal.newBuilder().build())
           .setUpdateMask(FieldMask.newBuilder().build())
           .build();
   PrivateAuctionDeal response =
       privateAuctionDealServiceClient.updatePrivateAuctionDeal(request);
 }
Parameter
Name Description
request UpdatePrivateAuctionDealRequest

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

updatePrivateAuctionDealCallable()

public final UnaryCallable<UpdatePrivateAuctionDealRequest,PrivateAuctionDeal> updatePrivateAuctionDealCallable()

API to update a PrivateAuctionDeal 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 (PrivateAuctionDealServiceClient privateAuctionDealServiceClient =
     PrivateAuctionDealServiceClient.create()) {
   UpdatePrivateAuctionDealRequest request =
       UpdatePrivateAuctionDealRequest.newBuilder()
           .setPrivateAuctionDeal(PrivateAuctionDeal.newBuilder().build())
           .setUpdateMask(FieldMask.newBuilder().build())
           .build();
   ApiFuture<PrivateAuctionDeal> future =
       privateAuctionDealServiceClient.updatePrivateAuctionDealCallable().futureCall(request);
   // Do something.
   PrivateAuctionDeal response = future.get();
 }
Returns
Type Description
UnaryCallable<UpdatePrivateAuctionDealRequest,PrivateAuctionDeal>