Class FileUploadsServiceClient (0.9.0)

GitHub RepositoryProduct Reference

Service Description: Service to manage data source file uploads.

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 (FileUploadsServiceClient fileUploadsServiceClient = FileUploadsServiceClient.create()) {
   FileUploadName name = FileUploadName.of("[ACCOUNT]", "[DATASOURCE]", "[FILEUPLOAD]");
   FileUpload response = fileUploadsServiceClient.getFileUpload(name);
 }

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

GetFileUpload

Gets the latest data source file upload. Only the latest alias is accepted for a file upload.

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

  • getFileUpload(GetFileUploadRequest request)

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

  • getFileUpload(FileUploadName name)

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

  • getFileUploadCallable()

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 FileUploadsServiceSettings 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
 FileUploadsServiceSettings fileUploadsServiceSettings =
     FileUploadsServiceSettings.newBuilder()
         .setCredentialsProvider(FixedCredentialsProvider.create(myCredentials))
         .build();
 FileUploadsServiceClient fileUploadsServiceClient =
     FileUploadsServiceClient.create(fileUploadsServiceSettings);

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
 FileUploadsServiceSettings fileUploadsServiceSettings =
     FileUploadsServiceSettings.newBuilder().setEndpoint(myEndpoint).build();
 FileUploadsServiceClient fileUploadsServiceClient =
     FileUploadsServiceClient.create(fileUploadsServiceSettings);

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
 FileUploadsServiceSettings fileUploadsServiceSettings =
     FileUploadsServiceSettings.newHttpJsonBuilder().build();
 FileUploadsServiceClient fileUploadsServiceClient =
     FileUploadsServiceClient.create(fileUploadsServiceSettings);

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

Inheritance

java.lang.Object > FileUploadsServiceClient

Static Methods

create()

public static final FileUploadsServiceClient create()

Constructs an instance of FileUploadsServiceClient with default settings.

Returns
Type Description
FileUploadsServiceClient
Exceptions
Type Description
IOException

create(FileUploadsServiceSettings settings)

public static final FileUploadsServiceClient create(FileUploadsServiceSettings settings)

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

create(FileUploadsServiceStub stub)

public static final FileUploadsServiceClient create(FileUploadsServiceStub stub)

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

Parameter
Name Description
stub FileUploadsServiceStub
Returns
Type Description
FileUploadsServiceClient

Constructors

FileUploadsServiceClient(FileUploadsServiceSettings settings)

protected FileUploadsServiceClient(FileUploadsServiceSettings settings)

Constructs an instance of FileUploadsServiceClient, 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 FileUploadsServiceSettings

FileUploadsServiceClient(FileUploadsServiceStub stub)

protected FileUploadsServiceClient(FileUploadsServiceStub stub)
Parameter
Name Description
stub FileUploadsServiceStub

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

getFileUpload(FileUploadName name)

public final FileUpload getFileUpload(FileUploadName name)

Gets the latest data source file upload. Only the latest alias is accepted for a file upload.

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 (FileUploadsServiceClient fileUploadsServiceClient = FileUploadsServiceClient.create()) {
   FileUploadName name = FileUploadName.of("[ACCOUNT]", "[DATASOURCE]", "[FILEUPLOAD]");
   FileUpload response = fileUploadsServiceClient.getFileUpload(name);
 }
Parameter
Name Description
name FileUploadName

Required. The name of the data source file upload to retrieve. Format: accounts/{account}/dataSources/{datasource}/fileUploads/latest
Returns
Type Description
FileUpload

getFileUpload(GetFileUploadRequest request)

public final FileUpload getFileUpload(GetFileUploadRequest request)

Gets the latest data source file upload. Only the latest alias is accepted for a file upload.

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 (FileUploadsServiceClient fileUploadsServiceClient = FileUploadsServiceClient.create()) {
   GetFileUploadRequest request =
       GetFileUploadRequest.newBuilder()
           .setName(FileUploadName.of("[ACCOUNT]", "[DATASOURCE]", "[FILEUPLOAD]").toString())
           .build();
   FileUpload response = fileUploadsServiceClient.getFileUpload(request);
 }
Parameter
Name Description
request GetFileUploadRequest

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

getFileUpload(String name)

public final FileUpload getFileUpload(String name)

Gets the latest data source file upload. Only the latest alias is accepted for a file upload.

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 (FileUploadsServiceClient fileUploadsServiceClient = FileUploadsServiceClient.create()) {
   String name = FileUploadName.of("[ACCOUNT]", "[DATASOURCE]", "[FILEUPLOAD]").toString();
   FileUpload response = fileUploadsServiceClient.getFileUpload(name);
 }
Parameter
Name Description
name String

Required. The name of the data source file upload to retrieve. Format: accounts/{account}/dataSources/{datasource}/fileUploads/latest
Returns
Type Description
FileUpload

getFileUploadCallable()

public final UnaryCallable<GetFileUploadRequest,FileUpload> getFileUploadCallable()

Gets the latest data source file upload. Only the latest alias is accepted for a file upload.

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 (FileUploadsServiceClient fileUploadsServiceClient = FileUploadsServiceClient.create()) {
   GetFileUploadRequest request =
       GetFileUploadRequest.newBuilder()
           .setName(FileUploadName.of("[ACCOUNT]", "[DATASOURCE]", "[FILEUPLOAD]").toString())
           .build();
   ApiFuture<FileUpload> future =
       fileUploadsServiceClient.getFileUploadCallable().futureCall(request);
   // Do something.
   FileUpload response = future.get();
 }
Returns
Type Description
UnaryCallable<GetFileUploadRequest,FileUpload>

getSettings()

public final FileUploadsServiceSettings getSettings()
Returns
Type Description
FileUploadsServiceSettings

getStub()

public FileUploadsServiceStub getStub()
Returns
Type Description
FileUploadsServiceStub

isShutdown()

public boolean isShutdown()
Returns
Type Description
boolean

isTerminated()

public boolean isTerminated()
Returns
Type Description
boolean

shutdown()

public void shutdown()

shutdownNow()

public void shutdownNow()