GitHub Repository | Product Reference |
Service Description: Service for supporting checkout settings.
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 (CheckoutSettingsServiceClient checkoutSettingsServiceClient =
CheckoutSettingsServiceClient.create()) {
CheckoutSettingsName name = CheckoutSettingsName.of("[ACCOUNT]", "[PROGRAM]");
CheckoutSettings response = checkoutSettingsServiceClient.getCheckoutSettings(name);
}
Note: close() needs to be called on the CheckoutSettingsServiceClient object to clean up resources such as threads. In the example above, try-with-resources is used, which automatically calls close().
Method | Description | Method Variants |
---|---|---|
GetCheckoutSettings |
Gets |
Request object method variants only take one parameter, a request object, which must be constructed before the call.
"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.
Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
|
CreateCheckoutSettings |
Creates |
Request object method variants only take one parameter, a request object, which must be constructed before the call.
"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.
Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
|
UpdateCheckoutSettings |
Updates |
Request object method variants only take one parameter, a request object, which must be constructed before the call.
"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.
Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
|
DeleteCheckoutSettings |
Deletes |
Request object method variants only take one parameter, a request object, which must be constructed before the call.
"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.
Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
|
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 CheckoutSettingsServiceSettings 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
CheckoutSettingsServiceSettings checkoutSettingsServiceSettings =
CheckoutSettingsServiceSettings.newBuilder()
.setCredentialsProvider(FixedCredentialsProvider.create(myCredentials))
.build();
CheckoutSettingsServiceClient checkoutSettingsServiceClient =
CheckoutSettingsServiceClient.create(checkoutSettingsServiceSettings);
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
CheckoutSettingsServiceSettings checkoutSettingsServiceSettings =
CheckoutSettingsServiceSettings.newBuilder().setEndpoint(myEndpoint).build();
CheckoutSettingsServiceClient checkoutSettingsServiceClient =
CheckoutSettingsServiceClient.create(checkoutSettingsServiceSettings);
To use REST (HTTP1.1/JSON) transport (instead of gRPC) for sending and receiving requests over the wire:
// 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
CheckoutSettingsServiceSettings checkoutSettingsServiceSettings =
CheckoutSettingsServiceSettings.newHttpJsonBuilder().build();
CheckoutSettingsServiceClient checkoutSettingsServiceClient =
CheckoutSettingsServiceClient.create(checkoutSettingsServiceSettings);
Please refer to the GitHub repository's samples for more quickstart code snippets.
Static Methods
create()
public static final CheckoutSettingsServiceClient create()
Constructs an instance of CheckoutSettingsServiceClient with default settings.
Returns | |
---|---|
Type | Description |
CheckoutSettingsServiceClient |
Exceptions | |
---|---|
Type | Description |
IOException |
create(CheckoutSettingsServiceSettings settings)
public static final CheckoutSettingsServiceClient create(CheckoutSettingsServiceSettings settings)
Constructs an instance of CheckoutSettingsServiceClient, 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 |
CheckoutSettingsServiceSettings |
Returns | |
---|---|
Type | Description |
CheckoutSettingsServiceClient |
Exceptions | |
---|---|
Type | Description |
IOException |
create(CheckoutSettingsServiceStub stub)
public static final CheckoutSettingsServiceClient create(CheckoutSettingsServiceStub stub)
Constructs an instance of CheckoutSettingsServiceClient, using the given stub for making calls. This is for advanced usage - prefer using create(CheckoutSettingsServiceSettings).
Parameter | |
---|---|
Name | Description |
stub |
CheckoutSettingsServiceStub |
Returns | |
---|---|
Type | Description |
CheckoutSettingsServiceClient |
Constructors
CheckoutSettingsServiceClient(CheckoutSettingsServiceSettings settings)
protected CheckoutSettingsServiceClient(CheckoutSettingsServiceSettings settings)
Constructs an instance of CheckoutSettingsServiceClient, 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 |
CheckoutSettingsServiceSettings |
CheckoutSettingsServiceClient(CheckoutSettingsServiceStub stub)
protected CheckoutSettingsServiceClient(CheckoutSettingsServiceStub stub)
Parameter | |
---|---|
Name | Description |
stub |
CheckoutSettingsServiceStub |
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()
createCheckoutSettings(CreateCheckoutSettingsRequest request)
public final CheckoutSettings createCheckoutSettings(CreateCheckoutSettingsRequest request)
Creates CheckoutSettings
for the given merchant.
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 (CheckoutSettingsServiceClient checkoutSettingsServiceClient =
CheckoutSettingsServiceClient.create()) {
CreateCheckoutSettingsRequest request =
CreateCheckoutSettingsRequest.newBuilder()
.setParent(ProgramName.of("[ACCOUNT]", "[PROGRAM]").toString())
.setCheckoutSettings(CheckoutSettings.newBuilder().build())
.build();
CheckoutSettings response = checkoutSettingsServiceClient.createCheckoutSettings(request);
}
Parameter | |
---|---|
Name | Description |
request |
CreateCheckoutSettingsRequest The request object containing all of the parameters for the API call. |
Returns | |
---|---|
Type | Description |
CheckoutSettings |
createCheckoutSettings(ProgramName parent, CheckoutSettings checkoutSettings)
public final CheckoutSettings createCheckoutSettings(ProgramName parent, CheckoutSettings checkoutSettings)
Creates CheckoutSettings
for the given merchant.
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 (CheckoutSettingsServiceClient checkoutSettingsServiceClient =
CheckoutSettingsServiceClient.create()) {
ProgramName parent = ProgramName.of("[ACCOUNT]", "[PROGRAM]");
CheckoutSettings checkoutSettings = CheckoutSettings.newBuilder().build();
CheckoutSettings response =
checkoutSettingsServiceClient.createCheckoutSettings(parent, checkoutSettings);
}
Parameters | |
---|---|
Name | Description |
parent |
ProgramName Required. The merchant account for which the |
checkoutSettings |
CheckoutSettings Required. The |
Returns | |
---|---|
Type | Description |
CheckoutSettings |
createCheckoutSettings(String parent, CheckoutSettings checkoutSettings)
public final CheckoutSettings createCheckoutSettings(String parent, CheckoutSettings checkoutSettings)
Creates CheckoutSettings
for the given merchant.
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 (CheckoutSettingsServiceClient checkoutSettingsServiceClient =
CheckoutSettingsServiceClient.create()) {
String parent = ProgramName.of("[ACCOUNT]", "[PROGRAM]").toString();
CheckoutSettings checkoutSettings = CheckoutSettings.newBuilder().build();
CheckoutSettings response =
checkoutSettingsServiceClient.createCheckoutSettings(parent, checkoutSettings);
}
Parameters | |
---|---|
Name | Description |
parent |
String Required. The merchant account for which the |
checkoutSettings |
CheckoutSettings Required. The |
Returns | |
---|---|
Type | Description |
CheckoutSettings |
createCheckoutSettingsCallable()
public final UnaryCallable<CreateCheckoutSettingsRequest,CheckoutSettings> createCheckoutSettingsCallable()
Creates CheckoutSettings
for the given merchant.
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 (CheckoutSettingsServiceClient checkoutSettingsServiceClient =
CheckoutSettingsServiceClient.create()) {
CreateCheckoutSettingsRequest request =
CreateCheckoutSettingsRequest.newBuilder()
.setParent(ProgramName.of("[ACCOUNT]", "[PROGRAM]").toString())
.setCheckoutSettings(CheckoutSettings.newBuilder().build())
.build();
ApiFuture<CheckoutSettings> future =
checkoutSettingsServiceClient.createCheckoutSettingsCallable().futureCall(request);
// Do something.
CheckoutSettings response = future.get();
}
Returns | |
---|---|
Type | Description |
UnaryCallable<CreateCheckoutSettingsRequest,CheckoutSettings> |
deleteCheckoutSettings(CheckoutSettingsName name)
public final void deleteCheckoutSettings(CheckoutSettingsName name)
Deletes CheckoutSettings
and unenrolls merchant from Checkout
program.
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 (CheckoutSettingsServiceClient checkoutSettingsServiceClient =
CheckoutSettingsServiceClient.create()) {
CheckoutSettingsName name = CheckoutSettingsName.of("[ACCOUNT]", "[PROGRAM]");
checkoutSettingsServiceClient.deleteCheckoutSettings(name);
}
Parameter | |
---|---|
Name | Description |
name |
CheckoutSettingsName Required. The name/identifier of the merchant account. Format:
|
deleteCheckoutSettings(DeleteCheckoutSettingsRequest request)
public final void deleteCheckoutSettings(DeleteCheckoutSettingsRequest request)
Deletes CheckoutSettings
and unenrolls merchant from Checkout
program.
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 (CheckoutSettingsServiceClient checkoutSettingsServiceClient =
CheckoutSettingsServiceClient.create()) {
DeleteCheckoutSettingsRequest request =
DeleteCheckoutSettingsRequest.newBuilder()
.setName(CheckoutSettingsName.of("[ACCOUNT]", "[PROGRAM]").toString())
.build();
checkoutSettingsServiceClient.deleteCheckoutSettings(request);
}
Parameter | |
---|---|
Name | Description |
request |
DeleteCheckoutSettingsRequest The request object containing all of the parameters for the API call. |
deleteCheckoutSettings(String name)
public final void deleteCheckoutSettings(String name)
Deletes CheckoutSettings
and unenrolls merchant from Checkout
program.
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 (CheckoutSettingsServiceClient checkoutSettingsServiceClient =
CheckoutSettingsServiceClient.create()) {
String name = CheckoutSettingsName.of("[ACCOUNT]", "[PROGRAM]").toString();
checkoutSettingsServiceClient.deleteCheckoutSettings(name);
}
Parameter | |
---|---|
Name | Description |
name |
String Required. The name/identifier of the merchant account. Format:
|
deleteCheckoutSettingsCallable()
public final UnaryCallable<DeleteCheckoutSettingsRequest,Empty> deleteCheckoutSettingsCallable()
Deletes CheckoutSettings
and unenrolls merchant from Checkout
program.
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 (CheckoutSettingsServiceClient checkoutSettingsServiceClient =
CheckoutSettingsServiceClient.create()) {
DeleteCheckoutSettingsRequest request =
DeleteCheckoutSettingsRequest.newBuilder()
.setName(CheckoutSettingsName.of("[ACCOUNT]", "[PROGRAM]").toString())
.build();
ApiFuture<Empty> future =
checkoutSettingsServiceClient.deleteCheckoutSettingsCallable().futureCall(request);
// Do something.
future.get();
}
Returns | |
---|---|
Type | Description |
UnaryCallable<DeleteCheckoutSettingsRequest,Empty> |
getCheckoutSettings(CheckoutSettingsName name)
public final CheckoutSettings getCheckoutSettings(CheckoutSettingsName name)
Gets CheckoutSettings
for the given merchant. This includes information about review state,
enrollment state and URL settings.
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 (CheckoutSettingsServiceClient checkoutSettingsServiceClient =
CheckoutSettingsServiceClient.create()) {
CheckoutSettingsName name = CheckoutSettingsName.of("[ACCOUNT]", "[PROGRAM]");
CheckoutSettings response = checkoutSettingsServiceClient.getCheckoutSettings(name);
}
Parameter | |
---|---|
Name | Description |
name |
CheckoutSettingsName Required. The name/identifier of the merchant account. Format:
|
Returns | |
---|---|
Type | Description |
CheckoutSettings |
getCheckoutSettings(GetCheckoutSettingsRequest request)
public final CheckoutSettings getCheckoutSettings(GetCheckoutSettingsRequest request)
Gets CheckoutSettings
for the given merchant. This includes information about review state,
enrollment state and URL settings.
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 (CheckoutSettingsServiceClient checkoutSettingsServiceClient =
CheckoutSettingsServiceClient.create()) {
GetCheckoutSettingsRequest request =
GetCheckoutSettingsRequest.newBuilder()
.setName(CheckoutSettingsName.of("[ACCOUNT]", "[PROGRAM]").toString())
.build();
CheckoutSettings response = checkoutSettingsServiceClient.getCheckoutSettings(request);
}
Parameter | |
---|---|
Name | Description |
request |
GetCheckoutSettingsRequest The request object containing all of the parameters for the API call. |
Returns | |
---|---|
Type | Description |
CheckoutSettings |
getCheckoutSettings(String name)
public final CheckoutSettings getCheckoutSettings(String name)
Gets CheckoutSettings
for the given merchant. This includes information about review state,
enrollment state and URL settings.
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 (CheckoutSettingsServiceClient checkoutSettingsServiceClient =
CheckoutSettingsServiceClient.create()) {
String name = CheckoutSettingsName.of("[ACCOUNT]", "[PROGRAM]").toString();
CheckoutSettings response = checkoutSettingsServiceClient.getCheckoutSettings(name);
}
Parameter | |
---|---|
Name | Description |
name |
String Required. The name/identifier of the merchant account. Format:
|
Returns | |
---|---|
Type | Description |
CheckoutSettings |
getCheckoutSettingsCallable()
public final UnaryCallable<GetCheckoutSettingsRequest,CheckoutSettings> getCheckoutSettingsCallable()
Gets CheckoutSettings
for the given merchant. This includes information about review state,
enrollment state and URL settings.
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 (CheckoutSettingsServiceClient checkoutSettingsServiceClient =
CheckoutSettingsServiceClient.create()) {
GetCheckoutSettingsRequest request =
GetCheckoutSettingsRequest.newBuilder()
.setName(CheckoutSettingsName.of("[ACCOUNT]", "[PROGRAM]").toString())
.build();
ApiFuture<CheckoutSettings> future =
checkoutSettingsServiceClient.getCheckoutSettingsCallable().futureCall(request);
// Do something.
CheckoutSettings response = future.get();
}
Returns | |
---|---|
Type | Description |
UnaryCallable<GetCheckoutSettingsRequest,CheckoutSettings> |
getSettings()
public final CheckoutSettingsServiceSettings getSettings()
Returns | |
---|---|
Type | Description |
CheckoutSettingsServiceSettings |
getStub()
public CheckoutSettingsServiceStub getStub()
Returns | |
---|---|
Type | Description |
CheckoutSettingsServiceStub |
isShutdown()
public boolean isShutdown()
Returns | |
---|---|
Type | Description |
boolean |
isTerminated()
public boolean isTerminated()
Returns | |
---|---|
Type | Description |
boolean |
shutdown()
public void shutdown()
shutdownNow()
public void shutdownNow()
updateCheckoutSettings(CheckoutSettings checkoutSettings, FieldMask updateMask)
public final CheckoutSettings updateCheckoutSettings(CheckoutSettings checkoutSettings, FieldMask updateMask)
Updates CheckoutSettings
for the given merchant.
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 (CheckoutSettingsServiceClient checkoutSettingsServiceClient =
CheckoutSettingsServiceClient.create()) {
CheckoutSettings checkoutSettings = CheckoutSettings.newBuilder().build();
FieldMask updateMask = FieldMask.newBuilder().build();
CheckoutSettings response =
checkoutSettingsServiceClient.updateCheckoutSettings(checkoutSettings, updateMask);
}
Parameters | |
---|---|
Name | Description |
checkoutSettings |
CheckoutSettings Required. The updated version of the |
updateMask |
FieldMask Required. List of fields being updated. The following fields are supported
(in both - |
Returns | |
---|---|
Type | Description |
CheckoutSettings |
updateCheckoutSettings(UpdateCheckoutSettingsRequest request)
public final CheckoutSettings updateCheckoutSettings(UpdateCheckoutSettingsRequest request)
Updates CheckoutSettings
for the given merchant.
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 (CheckoutSettingsServiceClient checkoutSettingsServiceClient =
CheckoutSettingsServiceClient.create()) {
UpdateCheckoutSettingsRequest request =
UpdateCheckoutSettingsRequest.newBuilder()
.setCheckoutSettings(CheckoutSettings.newBuilder().build())
.setUpdateMask(FieldMask.newBuilder().build())
.build();
CheckoutSettings response = checkoutSettingsServiceClient.updateCheckoutSettings(request);
}
Parameter | |
---|---|
Name | Description |
request |
UpdateCheckoutSettingsRequest The request object containing all of the parameters for the API call. |
Returns | |
---|---|
Type | Description |
CheckoutSettings |
updateCheckoutSettingsCallable()
public final UnaryCallable<UpdateCheckoutSettingsRequest,CheckoutSettings> updateCheckoutSettingsCallable()
Updates CheckoutSettings
for the given merchant.
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 (CheckoutSettingsServiceClient checkoutSettingsServiceClient =
CheckoutSettingsServiceClient.create()) {
UpdateCheckoutSettingsRequest request =
UpdateCheckoutSettingsRequest.newBuilder()
.setCheckoutSettings(CheckoutSettings.newBuilder().build())
.setUpdateMask(FieldMask.newBuilder().build())
.build();
ApiFuture<CheckoutSettings> future =
checkoutSettingsServiceClient.updateCheckoutSettingsCallable().futureCall(request);
// Do something.
CheckoutSettings response = future.get();
}
Returns | |
---|---|
Type | Description |
UnaryCallable<UpdateCheckoutSettingsRequest,CheckoutSettings> |