| GitHub Repository | Product Reference |
Service Description: Provides methods for handling Partner 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 (PartnerServiceClient partnerServiceClient = PartnerServiceClient.create()) {
PartnerName name = PartnerName.of("[NETWORK_CODE]", "[PARTNER]");
Partner response = partnerServiceClient.getPartner(name);
}
Note: close() needs to be called on the PartnerServiceClient 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 |
|---|---|---|
GetPartner |
Retrieves a Partner object. |
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.
|
ListPartners |
Lists Partner objects. |
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.
|
UpdatePartner |
Updates a Partner object. |
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.
|
BatchUpdatePartners |
Batch updates Partner objects. |
Request object method variants only take one parameter, a request object, which must be constructed before the call.
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 PartnerServiceSettings 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
PartnerServiceSettings partnerServiceSettings =
PartnerServiceSettings.newBuilder()
.setCredentialsProvider(FixedCredentialsProvider.create(myCredentials))
.build();
PartnerServiceClient partnerServiceClient = PartnerServiceClient.create(partnerServiceSettings);
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
PartnerServiceSettings partnerServiceSettings =
PartnerServiceSettings.newBuilder().setEndpoint(myEndpoint).build();
PartnerServiceClient partnerServiceClient = PartnerServiceClient.create(partnerServiceSettings);
Please refer to the GitHub repository's samples for more quickstart code snippets.
Static Methods
create()
public static final PartnerServiceClient create()Constructs an instance of PartnerServiceClient with default settings.
| Returns | |
|---|---|
| Type | Description |
PartnerServiceClient |
|
| Exceptions | |
|---|---|
| Type | Description |
IOException |
|
create(PartnerServiceSettings settings)
public static final PartnerServiceClient create(PartnerServiceSettings settings)Constructs an instance of PartnerServiceClient, 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 |
PartnerServiceSettings |
| Returns | |
|---|---|
| Type | Description |
PartnerServiceClient |
|
| Exceptions | |
|---|---|
| Type | Description |
IOException |
|
create(PartnerServiceStub stub)
public static final PartnerServiceClient create(PartnerServiceStub stub)Constructs an instance of PartnerServiceClient, using the given stub for making calls. This is for advanced usage - prefer using create(PartnerServiceSettings).
| Parameter | |
|---|---|
| Name | Description |
stub |
PartnerServiceStub |
| Returns | |
|---|---|
| Type | Description |
PartnerServiceClient |
|
Constructors
PartnerServiceClient(PartnerServiceSettings settings)
protected PartnerServiceClient(PartnerServiceSettings settings)Constructs an instance of PartnerServiceClient, 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 |
PartnerServiceSettings |
PartnerServiceClient(PartnerServiceStub stub)
protected PartnerServiceClient(PartnerServiceStub stub)| Parameter | |
|---|---|
| Name | Description |
stub |
PartnerServiceStub |
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 |
|
batchUpdatePartners(@Nullable NetworkName parent, List<UpdatePartnerRequest> requests)
public final BatchUpdatePartnersResponse batchUpdatePartners(@Nullable NetworkName parent, List<UpdatePartnerRequest> requests)Batch updates Partner 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 (PartnerServiceClient partnerServiceClient = PartnerServiceClient.create()) {
NetworkName parent = NetworkName.of("[NETWORK_CODE]");
List<UpdatePartnerRequest> requests = new ArrayList<>();
BatchUpdatePartnersResponse response =
partnerServiceClient.batchUpdatePartners(parent, requests);
}
| Parameters | |
|---|---|
| Name | Description |
parent |
@org.jspecify.annotations.Nullable com.google.ads.admanager.v1.NetworkNameRequired. The parent resource where Partners
will be updated. Format: |
requests |
List<UpdatePartnerRequest>Required. The Partner objects to update. A maximum of 100 objects can be updated in a batch. |
| Returns | |
|---|---|
| Type | Description |
BatchUpdatePartnersResponse |
|
batchUpdatePartners(BatchUpdatePartnersRequest request)
public final BatchUpdatePartnersResponse batchUpdatePartners(BatchUpdatePartnersRequest request)Batch updates Partner 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 (PartnerServiceClient partnerServiceClient = PartnerServiceClient.create()) {
BatchUpdatePartnersRequest request =
BatchUpdatePartnersRequest.newBuilder()
.setParent(NetworkName.of("[NETWORK_CODE]").toString())
.addAllRequests(new ArrayList<UpdatePartnerRequest>())
.build();
BatchUpdatePartnersResponse response = partnerServiceClient.batchUpdatePartners(request);
}
| Parameter | |
|---|---|
| Name | Description |
request |
BatchUpdatePartnersRequestThe request object containing all of the parameters for the API call. |
| Returns | |
|---|---|
| Type | Description |
BatchUpdatePartnersResponse |
|
batchUpdatePartners(String parent, List<UpdatePartnerRequest> requests)
public final BatchUpdatePartnersResponse batchUpdatePartners(String parent, List<UpdatePartnerRequest> requests)Batch updates Partner 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 (PartnerServiceClient partnerServiceClient = PartnerServiceClient.create()) {
String parent = NetworkName.of("[NETWORK_CODE]").toString();
List<UpdatePartnerRequest> requests = new ArrayList<>();
BatchUpdatePartnersResponse response =
partnerServiceClient.batchUpdatePartners(parent, requests);
}
| Parameters | |
|---|---|
| Name | Description |
parent |
StringRequired. The parent resource where Partners
will be updated. Format: |
requests |
List<UpdatePartnerRequest>Required. The Partner objects to update. A maximum of 100 objects can be updated in a batch. |
| Returns | |
|---|---|
| Type | Description |
BatchUpdatePartnersResponse |
|
batchUpdatePartnersCallable()
public final UnaryCallable<BatchUpdatePartnersRequest,BatchUpdatePartnersResponse> batchUpdatePartnersCallable()Batch updates Partner 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 (PartnerServiceClient partnerServiceClient = PartnerServiceClient.create()) {
BatchUpdatePartnersRequest request =
BatchUpdatePartnersRequest.newBuilder()
.setParent(NetworkName.of("[NETWORK_CODE]").toString())
.addAllRequests(new ArrayList<UpdatePartnerRequest>())
.build();
ApiFuture<BatchUpdatePartnersResponse> future =
partnerServiceClient.batchUpdatePartnersCallable().futureCall(request);
// Do something.
BatchUpdatePartnersResponse response = future.get();
}
| Returns | |
|---|---|
| Type | Description |
UnaryCallable<BatchUpdatePartnersRequest,BatchUpdatePartnersResponse> |
|
close()
public final void close()getPartner(@Nullable PartnerName name)
public final Partner getPartner(@Nullable PartnerName name)Retrieves a Partner 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 (PartnerServiceClient partnerServiceClient = PartnerServiceClient.create()) {
PartnerName name = PartnerName.of("[NETWORK_CODE]", "[PARTNER]");
Partner response = partnerServiceClient.getPartner(name);
}
| Parameter | |
|---|---|
| Name | Description |
name |
@org.jspecify.annotations.Nullable com.google.ads.admanager.v1.PartnerNameRequired. The resource name of the Partner.
Format: |
| Returns | |
|---|---|
| Type | Description |
Partner |
|
getPartner(GetPartnerRequest request)
public final Partner getPartner(GetPartnerRequest request)Retrieves a Partner 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 (PartnerServiceClient partnerServiceClient = PartnerServiceClient.create()) {
GetPartnerRequest request =
GetPartnerRequest.newBuilder()
.setName(PartnerName.of("[NETWORK_CODE]", "[PARTNER]").toString())
.build();
Partner response = partnerServiceClient.getPartner(request);
}
| Parameter | |
|---|---|
| Name | Description |
request |
GetPartnerRequestThe request object containing all of the parameters for the API call. |
| Returns | |
|---|---|
| Type | Description |
Partner |
|
getPartner(String name)
public final Partner getPartner(String name)Retrieves a Partner 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 (PartnerServiceClient partnerServiceClient = PartnerServiceClient.create()) {
String name = PartnerName.of("[NETWORK_CODE]", "[PARTNER]").toString();
Partner response = partnerServiceClient.getPartner(name);
}
| Parameter | |
|---|---|
| Name | Description |
name |
StringRequired. The resource name of the Partner.
Format: |
| Returns | |
|---|---|
| Type | Description |
Partner |
|
getPartnerCallable()
public final UnaryCallable<GetPartnerRequest,Partner> getPartnerCallable()Retrieves a Partner 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 (PartnerServiceClient partnerServiceClient = PartnerServiceClient.create()) {
GetPartnerRequest request =
GetPartnerRequest.newBuilder()
.setName(PartnerName.of("[NETWORK_CODE]", "[PARTNER]").toString())
.build();
ApiFuture<Partner> future = partnerServiceClient.getPartnerCallable().futureCall(request);
// Do something.
Partner response = future.get();
}
| Returns | |
|---|---|
| Type | Description |
UnaryCallable<GetPartnerRequest,Partner> |
|
getSettings()
public final @Nullable PartnerServiceSettings getSettings()| Returns | |
|---|---|
| Type | Description |
@org.jspecify.annotations.Nullable com.google.ads.admanager.v1.PartnerServiceSettings |
|
getStub()
public PartnerServiceStub getStub()| Returns | |
|---|---|
| Type | Description |
PartnerServiceStub |
|
isShutdown()
public boolean isShutdown()| Returns | |
|---|---|
| Type | Description |
boolean |
|
isTerminated()
public boolean isTerminated()| Returns | |
|---|---|
| Type | Description |
boolean |
|
listPartners(@Nullable NetworkName parent)
public final PartnerServiceClient.ListPartnersPagedResponse listPartners(@Nullable NetworkName parent)Lists Partner 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 (PartnerServiceClient partnerServiceClient = PartnerServiceClient.create()) {
NetworkName parent = NetworkName.of("[NETWORK_CODE]");
for (Partner element : partnerServiceClient.listPartners(parent).iterateAll()) {
// doThingsWith(element);
}
}
| Parameter | |
|---|---|
| Name | Description |
parent |
@org.jspecify.annotations.Nullable com.google.ads.admanager.v1.NetworkNameRequired. The parent, which owns this collection of
Partners. Format: |
| Returns | |
|---|---|
| Type | Description |
PartnerServiceClient.ListPartnersPagedResponse |
|
listPartners(ListPartnersRequest request)
public final PartnerServiceClient.ListPartnersPagedResponse listPartners(ListPartnersRequest request)Lists Partner 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 (PartnerServiceClient partnerServiceClient = PartnerServiceClient.create()) {
ListPartnersRequest request =
ListPartnersRequest.newBuilder()
.setParent(NetworkName.of("[NETWORK_CODE]").toString())
.setPageSize(883849137)
.setPageToken("pageToken873572522")
.setFilter("filter-1274492040")
.setOrderBy("orderBy-1207110587")
.setSkip(3532159)
.build();
for (Partner element : partnerServiceClient.listPartners(request).iterateAll()) {
// doThingsWith(element);
}
}
| Parameter | |
|---|---|
| Name | Description |
request |
ListPartnersRequestThe request object containing all of the parameters for the API call. |
| Returns | |
|---|---|
| Type | Description |
PartnerServiceClient.ListPartnersPagedResponse |
|
listPartners(String parent)
public final PartnerServiceClient.ListPartnersPagedResponse listPartners(String parent)Lists Partner 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 (PartnerServiceClient partnerServiceClient = PartnerServiceClient.create()) {
String parent = NetworkName.of("[NETWORK_CODE]").toString();
for (Partner element : partnerServiceClient.listPartners(parent).iterateAll()) {
// doThingsWith(element);
}
}
| Parameter | |
|---|---|
| Name | Description |
parent |
StringRequired. The parent, which owns this collection of
Partners. Format: |
| Returns | |
|---|---|
| Type | Description |
PartnerServiceClient.ListPartnersPagedResponse |
|
listPartnersCallable()
public final UnaryCallable<ListPartnersRequest,ListPartnersResponse> listPartnersCallable()Lists Partner 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 (PartnerServiceClient partnerServiceClient = PartnerServiceClient.create()) {
ListPartnersRequest request =
ListPartnersRequest.newBuilder()
.setParent(NetworkName.of("[NETWORK_CODE]").toString())
.setPageSize(883849137)
.setPageToken("pageToken873572522")
.setFilter("filter-1274492040")
.setOrderBy("orderBy-1207110587")
.setSkip(3532159)
.build();
while (true) {
ListPartnersResponse response = partnerServiceClient.listPartnersCallable().call(request);
for (Partner element : response.getPartnersList()) {
// doThingsWith(element);
}
String nextPageToken = response.getNextPageToken();
if (!Strings.isNullOrEmpty(nextPageToken)) {
request = request.toBuilder().setPageToken(nextPageToken).build();
} else {
break;
}
}
}
| Returns | |
|---|---|
| Type | Description |
UnaryCallable<ListPartnersRequest,ListPartnersResponse> |
|
listPartnersPagedCallable()
public final UnaryCallable<ListPartnersRequest,PartnerServiceClient.ListPartnersPagedResponse> listPartnersPagedCallable()Lists Partner 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 (PartnerServiceClient partnerServiceClient = PartnerServiceClient.create()) {
ListPartnersRequest request =
ListPartnersRequest.newBuilder()
.setParent(NetworkName.of("[NETWORK_CODE]").toString())
.setPageSize(883849137)
.setPageToken("pageToken873572522")
.setFilter("filter-1274492040")
.setOrderBy("orderBy-1207110587")
.setSkip(3532159)
.build();
ApiFuture<Partner> future =
partnerServiceClient.listPartnersPagedCallable().futureCall(request);
// Do something.
for (Partner element : future.get().iterateAll()) {
// doThingsWith(element);
}
}
| Returns | |
|---|---|
| Type | Description |
UnaryCallable<ListPartnersRequest,ListPartnersPagedResponse> |
|
shutdown()
public void shutdown()shutdownNow()
public void shutdownNow()updatePartner(Partner partner, FieldMask updateMask)
public final Partner updatePartner(Partner partner, FieldMask updateMask)Updates a Partner 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 (PartnerServiceClient partnerServiceClient = PartnerServiceClient.create()) {
Partner partner = Partner.newBuilder().build();
FieldMask updateMask = FieldMask.newBuilder().build();
Partner response = partnerServiceClient.updatePartner(partner, updateMask);
}
| Parameters | |
|---|---|
| Name | Description |
partner |
PartnerRequired. The Partner to update. The Partner's |
updateMask |
FieldMaskOptional. The list of fields to update. |
| Returns | |
|---|---|
| Type | Description |
Partner |
|
updatePartner(UpdatePartnerRequest request)
public final Partner updatePartner(UpdatePartnerRequest request)Updates a Partner 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 (PartnerServiceClient partnerServiceClient = PartnerServiceClient.create()) {
UpdatePartnerRequest request =
UpdatePartnerRequest.newBuilder()
.setPartner(Partner.newBuilder().build())
.setUpdateMask(FieldMask.newBuilder().build())
.build();
Partner response = partnerServiceClient.updatePartner(request);
}
| Parameter | |
|---|---|
| Name | Description |
request |
UpdatePartnerRequestThe request object containing all of the parameters for the API call. |
| Returns | |
|---|---|
| Type | Description |
Partner |
|
updatePartnerCallable()
public final UnaryCallable<UpdatePartnerRequest,Partner> updatePartnerCallable()Updates a Partner 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 (PartnerServiceClient partnerServiceClient = PartnerServiceClient.create()) {
UpdatePartnerRequest request =
UpdatePartnerRequest.newBuilder()
.setPartner(Partner.newBuilder().build())
.setUpdateMask(FieldMask.newBuilder().build())
.build();
ApiFuture<Partner> future = partnerServiceClient.updatePartnerCallable().futureCall(request);
// Do something.
Partner response = future.get();
}
| Returns | |
|---|---|
| Type | Description |
UnaryCallable<UpdatePartnerRequest,Partner> |
|