Class MediaFileServiceClient
- java.lang.Object
-
- com.google.ads.googleads.v14.services.MediaFileServiceClient
-
- All Implemented Interfaces:
com.google.api.gax.core.BackgroundResource
,java.lang.AutoCloseable
@Generated("by gapic-generator-java") public class MediaFileServiceClient extends java.lang.Object implements com.google.api.gax.core.BackgroundResource
Service Description: Service to manage media files.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 (MediaFileServiceClient mediaFileServiceClient = MediaFileServiceClient.create()) { String customerId = "customerId-1581184615"; List<MediaFileOperation> operations = new ArrayList<>(); MutateMediaFilesResponse response = mediaFileServiceClient.mutateMediaFiles(customerId, operations); }
Note: close() needs to be called on the MediaFileServiceClient 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 MutateMediaFiles
Creates media files. Operation statuses are returned.
List of thrown errors: [AuthenticationError]() [AuthorizationError]() [DatabaseError]() [DistinctError]() [FieldError]() [HeaderError]() [IdError]() [ImageError]() [InternalError]() [MediaBundleError]() [MediaFileError]() [NewResourceCreationError]() [NotEmptyError]() [NullError]() [OperatorError]() [QuotaError]() [RangeError]() [RequestError]() [SizeLimitError]() [StringFormatError]() [StringLengthError]()
Request object method variants only take one parameter, a request object, which must be constructed before the call.
mutateMediaFiles(MutateMediaFilesRequest request)
"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.
mutateMediaFiles(String customerId, List<MediaFileOperation> operations)
Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
mutateMediaFilesCallable()
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 MediaFileServiceSettings 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 MediaFileServiceSettings mediaFileServiceSettings = MediaFileServiceSettings.newBuilder() .setCredentialsProvider(FixedCredentialsProvider.create(myCredentials)) .build(); MediaFileServiceClient mediaFileServiceClient = MediaFileServiceClient.create(mediaFileServiceSettings);
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 MediaFileServiceSettings mediaFileServiceSettings = MediaFileServiceSettings.newBuilder().setEndpoint(myEndpoint).build(); MediaFileServiceClient mediaFileServiceClient = MediaFileServiceClient.create(mediaFileServiceSettings);
Please refer to the GitHub repository's samples for more quickstart code snippets.
-
-
Constructor Summary
Constructors Modifier Constructor Description protected
MediaFileServiceClient(MediaFileServiceSettings settings)
Constructs an instance of MediaFileServiceClient, using the given settings.protected
MediaFileServiceClient(MediaFileServiceStub stub)
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description boolean
awaitTermination(long duration, java.util.concurrent.TimeUnit unit)
void
close()
static MediaFileServiceClient
create()
Constructs an instance of MediaFileServiceClient with default settings.static MediaFileServiceClient
create(MediaFileServiceSettings settings)
Constructs an instance of MediaFileServiceClient, using the given settings.static MediaFileServiceClient
create(MediaFileServiceStub stub)
Constructs an instance of MediaFileServiceClient, using the given stub for making calls.MediaFileServiceSettings
getSettings()
MediaFileServiceStub
getStub()
boolean
isShutdown()
boolean
isTerminated()
MutateMediaFilesResponse
mutateMediaFiles(MutateMediaFilesRequest request)
Creates media files.MutateMediaFilesResponse
mutateMediaFiles(java.lang.String customerId, java.util.List<MediaFileOperation> operations)
Creates media files.com.google.api.gax.rpc.UnaryCallable<MutateMediaFilesRequest,MutateMediaFilesResponse>
mutateMediaFilesCallable()
Creates media files.void
shutdown()
void
shutdownNow()
-
-
-
Constructor Detail
-
MediaFileServiceClient
protected MediaFileServiceClient(MediaFileServiceSettings settings) throws java.io.IOException
Constructs an instance of MediaFileServiceClient, 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.- Throws:
java.io.IOException
-
MediaFileServiceClient
protected MediaFileServiceClient(MediaFileServiceStub stub)
-
-
Method Detail
-
create
public static final MediaFileServiceClient create() throws java.io.IOException
Constructs an instance of MediaFileServiceClient with default settings.- Throws:
java.io.IOException
-
create
public static final MediaFileServiceClient create(MediaFileServiceSettings settings) throws java.io.IOException
Constructs an instance of MediaFileServiceClient, using the given settings. The channels are created based on the settings passed in, or defaults for any settings that are not set.- Throws:
java.io.IOException
-
create
public static final MediaFileServiceClient create(MediaFileServiceStub stub)
Constructs an instance of MediaFileServiceClient, using the given stub for making calls. This is for advanced usage - prefer using create(MediaFileServiceSettings).
-
getSettings
public final MediaFileServiceSettings getSettings()
-
getStub
public MediaFileServiceStub getStub()
-
mutateMediaFiles
public final MutateMediaFilesResponse mutateMediaFiles(java.lang.String customerId, java.util.List<MediaFileOperation> operations)
Creates media files. Operation statuses are returned.List of thrown errors: [AuthenticationError]() [AuthorizationError]() [DatabaseError]() [DistinctError]() [FieldError]() [HeaderError]() [IdError]() [ImageError]() [InternalError]() [MediaBundleError]() [MediaFileError]() [NewResourceCreationError]() [NotEmptyError]() [NullError]() [OperatorError]() [QuotaError]() [RangeError]() [RequestError]() [SizeLimitError]() [StringFormatError]() [StringLengthError]()
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 (MediaFileServiceClient mediaFileServiceClient = MediaFileServiceClient.create()) { String customerId = "customerId-1581184615"; List<MediaFileOperation> operations = new ArrayList<>(); MutateMediaFilesResponse response = mediaFileServiceClient.mutateMediaFiles(customerId, operations); }
- Parameters:
customerId
- Required. The ID of the customer whose media files are being modified.operations
- Required. The list of operations to perform on individual media file.- Throws:
com.google.api.gax.rpc.ApiException
- if the remote call fails
-
mutateMediaFiles
public final MutateMediaFilesResponse mutateMediaFiles(MutateMediaFilesRequest request)
Creates media files. Operation statuses are returned.List of thrown errors: [AuthenticationError]() [AuthorizationError]() [DatabaseError]() [DistinctError]() [FieldError]() [HeaderError]() [IdError]() [ImageError]() [InternalError]() [MediaBundleError]() [MediaFileError]() [NewResourceCreationError]() [NotEmptyError]() [NullError]() [OperatorError]() [QuotaError]() [RangeError]() [RequestError]() [SizeLimitError]() [StringFormatError]() [StringLengthError]()
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 (MediaFileServiceClient mediaFileServiceClient = MediaFileServiceClient.create()) { MutateMediaFilesRequest request = MutateMediaFilesRequest.newBuilder() .setCustomerId("customerId-1581184615") .addAllOperations(new ArrayList<MediaFileOperation>()) .setPartialFailure(true) .setValidateOnly(true) .build(); MutateMediaFilesResponse response = mediaFileServiceClient.mutateMediaFiles(request); }
- Parameters:
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
-
mutateMediaFilesCallable
public final com.google.api.gax.rpc.UnaryCallable<MutateMediaFilesRequest,MutateMediaFilesResponse> mutateMediaFilesCallable()
Creates media files. Operation statuses are returned.List of thrown errors: [AuthenticationError]() [AuthorizationError]() [DatabaseError]() [DistinctError]() [FieldError]() [HeaderError]() [IdError]() [ImageError]() [InternalError]() [MediaBundleError]() [MediaFileError]() [NewResourceCreationError]() [NotEmptyError]() [NullError]() [OperatorError]() [QuotaError]() [RangeError]() [RequestError]() [SizeLimitError]() [StringFormatError]() [StringLengthError]()
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 (MediaFileServiceClient mediaFileServiceClient = MediaFileServiceClient.create()) { MutateMediaFilesRequest request = MutateMediaFilesRequest.newBuilder() .setCustomerId("customerId-1581184615") .addAllOperations(new ArrayList<MediaFileOperation>()) .setPartialFailure(true) .setValidateOnly(true) .build(); ApiFuture<MutateMediaFilesResponse> future = mediaFileServiceClient.mutateMediaFilesCallable().futureCall(request); // Do something. MutateMediaFilesResponse response = future.get(); }
-
close
public final void close()
- Specified by:
close
in interfacejava.lang.AutoCloseable
-
shutdown
public void shutdown()
- Specified by:
shutdown
in interfacecom.google.api.gax.core.BackgroundResource
-
isShutdown
public boolean isShutdown()
- Specified by:
isShutdown
in interfacecom.google.api.gax.core.BackgroundResource
-
isTerminated
public boolean isTerminated()
- Specified by:
isTerminated
in interfacecom.google.api.gax.core.BackgroundResource
-
shutdownNow
public void shutdownNow()
- Specified by:
shutdownNow
in interfacecom.google.api.gax.core.BackgroundResource
-
awaitTermination
public boolean awaitTermination(long duration, java.util.concurrent.TimeUnit unit) throws java.lang.InterruptedException
- Specified by:
awaitTermination
in interfacecom.google.api.gax.core.BackgroundResource
- Throws:
java.lang.InterruptedException
-
-