com.google.ads.googleads.v18.services.DataLinkServiceClient Maven / Gradle / Ivy
Show all versions of google-ads-stubs-v18 Show documentation
/*
* Copyright 2024 Google LLC
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* https://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package com.google.ads.googleads.v18.services;
import com.google.ads.googleads.v18.resources.DataLink;
import com.google.ads.googleads.v18.services.stub.DataLinkServiceStub;
import com.google.ads.googleads.v18.services.stub.DataLinkServiceStubSettings;
import com.google.api.gax.core.BackgroundResource;
import com.google.api.gax.rpc.UnaryCallable;
import java.io.IOException;
import java.util.concurrent.TimeUnit;
import javax.annotation.Generated;
// AUTO-GENERATED DOCUMENTATION AND CLASS.
/**
* Service Description: This service allows management of data links between a Google Ads customer
* and another data entity.
*
* 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:
*
*
{@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 (DataLinkServiceClient dataLinkServiceClient = DataLinkServiceClient.create()) {
* String customerId = "customerId-1581184615";
* DataLink dataLink = DataLink.newBuilder().build();
* CreateDataLinkResponse response = dataLinkServiceClient.createDataLink(customerId, dataLink);
* }
* }
*
* Note: close() needs to be called on the DataLinkServiceClient 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
*
*
* CreateDataLink
Creates a data link. The requesting Google Ads account name and account ID will be shared with the third party (such as YouTube creators for video links) to whom you are creating the link with. Only customers on the allow-list can create data links.
*
List of thrown errors: [AuthenticationError]() [AuthorizationError]() [DatabaseError]() [DataLinkError]() [FieldError]() [HeaderError]() [InternalError]() [MutateError]() [QuotaError]() [RequestError]()
* Request object method variants only take one parameter, a request object, which must be constructed before the call.
*
* createDataLink(CreateDataLinkRequest request)
*
* "Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.
*
* createDataLink(String customerId, DataLink dataLink)
*
* Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
*
* createDataLinkCallable()
*
*
*
*
*
* 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 DataLinkServiceSettings to
* create(). For example:
*
*
To customize credentials:
*
*
{@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
* DataLinkServiceSettings dataLinkServiceSettings =
* DataLinkServiceSettings.newBuilder()
* .setCredentialsProvider(FixedCredentialsProvider.create(myCredentials))
* .build();
* DataLinkServiceClient dataLinkServiceClient =
* DataLinkServiceClient.create(dataLinkServiceSettings);
* }
*
* To customize the endpoint:
*
*
{@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
* DataLinkServiceSettings dataLinkServiceSettings =
* DataLinkServiceSettings.newBuilder().setEndpoint(myEndpoint).build();
* DataLinkServiceClient dataLinkServiceClient =
* DataLinkServiceClient.create(dataLinkServiceSettings);
* }
*
* Please refer to the GitHub repository's samples for more quickstart code snippets.
*/
@Generated("by gapic-generator-java")
public class DataLinkServiceClient implements BackgroundResource {
private final DataLinkServiceSettings settings;
private final DataLinkServiceStub stub;
/** Constructs an instance of DataLinkServiceClient with default settings. */
public static final DataLinkServiceClient create() throws IOException {
return create(DataLinkServiceSettings.newBuilder().build());
}
/**
* Constructs an instance of DataLinkServiceClient, using the given settings. The channels are
* created based on the settings passed in, or defaults for any settings that are not set.
*/
public static final DataLinkServiceClient create(DataLinkServiceSettings settings)
throws IOException {
return new DataLinkServiceClient(settings);
}
/**
* Constructs an instance of DataLinkServiceClient, using the given stub for making calls. This is
* for advanced usage - prefer using create(DataLinkServiceSettings).
*/
public static final DataLinkServiceClient create(DataLinkServiceStub stub) {
return new DataLinkServiceClient(stub);
}
/**
* Constructs an instance of DataLinkServiceClient, 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.
*/
protected DataLinkServiceClient(DataLinkServiceSettings settings) throws IOException {
this.settings = settings;
this.stub = ((DataLinkServiceStubSettings) settings.getStubSettings()).createStub();
}
protected DataLinkServiceClient(DataLinkServiceStub stub) {
this.settings = null;
this.stub = stub;
}
public final DataLinkServiceSettings getSettings() {
return settings;
}
public DataLinkServiceStub getStub() {
return stub;
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Creates a data link. The requesting Google Ads account name and account ID will be shared with
* the third party (such as YouTube creators for video links) to whom you are creating the link
* with. Only customers on the allow-list can create data links.
*
*
List of thrown errors: [AuthenticationError]() [AuthorizationError]() [DatabaseError]()
* [DataLinkError]() [FieldError]() [HeaderError]() [InternalError]() [MutateError]()
* [QuotaError]() [RequestError]()
*
*
Sample code:
*
*
{@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 (DataLinkServiceClient dataLinkServiceClient = DataLinkServiceClient.create()) {
* String customerId = "customerId-1581184615";
* DataLink dataLink = DataLink.newBuilder().build();
* CreateDataLinkResponse response = dataLinkServiceClient.createDataLink(customerId, dataLink);
* }
* }
*
* @param customerId Required. The ID of the customer for which the data link is created.
* @param dataLink Required. The data link to be created.
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
*/
public final CreateDataLinkResponse createDataLink(String customerId, DataLink dataLink) {
CreateDataLinkRequest request =
CreateDataLinkRequest.newBuilder().setCustomerId(customerId).setDataLink(dataLink).build();
return createDataLink(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Creates a data link. The requesting Google Ads account name and account ID will be shared with
* the third party (such as YouTube creators for video links) to whom you are creating the link
* with. Only customers on the allow-list can create data links.
*
* List of thrown errors: [AuthenticationError]() [AuthorizationError]() [DatabaseError]()
* [DataLinkError]() [FieldError]() [HeaderError]() [InternalError]() [MutateError]()
* [QuotaError]() [RequestError]()
*
*
Sample code:
*
*
{@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 (DataLinkServiceClient dataLinkServiceClient = DataLinkServiceClient.create()) {
* CreateDataLinkRequest request =
* CreateDataLinkRequest.newBuilder()
* .setCustomerId("customerId-1581184615")
* .setDataLink(DataLink.newBuilder().build())
* .build();
* CreateDataLinkResponse response = dataLinkServiceClient.createDataLink(request);
* }
* }
*
* @param request The request object containing all of the parameters for the API call.
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
*/
public final CreateDataLinkResponse createDataLink(CreateDataLinkRequest request) {
return createDataLinkCallable().call(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Creates a data link. The requesting Google Ads account name and account ID will be shared with
* the third party (such as YouTube creators for video links) to whom you are creating the link
* with. Only customers on the allow-list can create data links.
*
* List of thrown errors: [AuthenticationError]() [AuthorizationError]() [DatabaseError]()
* [DataLinkError]() [FieldError]() [HeaderError]() [InternalError]() [MutateError]()
* [QuotaError]() [RequestError]()
*
*
Sample code:
*
*
{@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 (DataLinkServiceClient dataLinkServiceClient = DataLinkServiceClient.create()) {
* CreateDataLinkRequest request =
* CreateDataLinkRequest.newBuilder()
* .setCustomerId("customerId-1581184615")
* .setDataLink(DataLink.newBuilder().build())
* .build();
* ApiFuture future =
* dataLinkServiceClient.createDataLinkCallable().futureCall(request);
* // Do something.
* CreateDataLinkResponse response = future.get();
* }
* }
*/
public final UnaryCallable
createDataLinkCallable() {
return stub.createDataLinkCallable();
}
@Override
public final void close() {
stub.close();
}
@Override
public void shutdown() {
stub.shutdown();
}
@Override
public boolean isShutdown() {
return stub.isShutdown();
}
@Override
public boolean isTerminated() {
return stub.isTerminated();
}
@Override
public void shutdownNow() {
stub.shutdownNow();
}
@Override
public boolean awaitTermination(long duration, TimeUnit unit) throws InterruptedException {
return stub.awaitTermination(duration, unit);
}
}