Class CaseAttachmentServiceClient (0.11.0)

public class CaseAttachmentServiceClient implements BackgroundResource

Service Description: A service to manage file attachment for Google Cloud support cases.

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 (CaseAttachmentServiceClient caseAttachmentServiceClient =
     CaseAttachmentServiceClient.create()) {
   CaseName parent = CaseName.ofProjectCaseName("[PROJECT]", "[CASE]");
   for (Attachment element : caseAttachmentServiceClient.listAttachments(parent).iterateAll()) {
     // doThingsWith(element);
   }
 }

Note: close() needs to be called on the CaseAttachmentServiceClient object to clean up resources such as threads. In the example above, try-with-resources is used, which automatically calls close().

The surface of this class includes several types of Java methods for each of the API's methods:

A "flattened" method. With this type of method, the fields of the request type have been converted into function parameters. It may be the case that not all fields are available as parameters, and not every API method will have a flattened method entry point.
A "request object" method. This type of method only takes one parameter, a request object, which must be constructed before the call. Not every API method will have a request object method.
A "callable" method. This type of method takes no parameters and returns 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 CaseAttachmentServiceSettings 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
 CaseAttachmentServiceSettings caseAttachmentServiceSettings =
     CaseAttachmentServiceSettings.newBuilder()
         .setCredentialsProvider(FixedCredentialsProvider.create(myCredentials))
         .build();
 CaseAttachmentServiceClient caseAttachmentServiceClient =
     CaseAttachmentServiceClient.create(caseAttachmentServiceSettings);

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
 CaseAttachmentServiceSettings caseAttachmentServiceSettings =
     CaseAttachmentServiceSettings.newBuilder().setEndpoint(myEndpoint).build();
 CaseAttachmentServiceClient caseAttachmentServiceClient =
     CaseAttachmentServiceClient.create(caseAttachmentServiceSettings);

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
 CaseAttachmentServiceSettings caseAttachmentServiceSettings =
     CaseAttachmentServiceSettings.newHttpJsonBuilder().build();
 CaseAttachmentServiceClient caseAttachmentServiceClient =
     CaseAttachmentServiceClient.create(caseAttachmentServiceSettings);

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

Inheritance

java.lang.Object > CaseAttachmentServiceClient

Implements

BackgroundResource

Inherited Members

Object.clone()

Object.equals(Object)

Object.finalize()

Object.getClass()

Object.hashCode()

Object.notify()

Object.notifyAll()

Object.toString()

Object.wait()

Object.wait(long)

Object.wait(long,int)

Static Methods

create()

public static final CaseAttachmentServiceClient create()

Constructs an instance of CaseAttachmentServiceClient with default settings.

Returns
Type	Description
`CaseAttachmentServiceClient`

Exceptions
Type	Description
`IOException`

create(CaseAttachmentServiceSettings settings)

public static final CaseAttachmentServiceClient create(CaseAttachmentServiceSettings settings)

Constructs an instance of CaseAttachmentServiceClient, 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`	`CaseAttachmentServiceSettings`

Returns
Type	Description
`CaseAttachmentServiceClient`

Exceptions
Type	Description
`IOException`

create(CaseAttachmentServiceStub stub)

public static final CaseAttachmentServiceClient create(CaseAttachmentServiceStub stub)

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

Parameter
Name	Description
`stub`	`CaseAttachmentServiceStub`

Returns
Type	Description
`CaseAttachmentServiceClient`

Constructors

CaseAttachmentServiceClient(CaseAttachmentServiceSettings settings)

protected CaseAttachmentServiceClient(CaseAttachmentServiceSettings settings)

Constructs an instance of CaseAttachmentServiceClient, 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`	`CaseAttachmentServiceSettings`

CaseAttachmentServiceClient(CaseAttachmentServiceStub stub)

protected CaseAttachmentServiceClient(CaseAttachmentServiceStub stub)

Parameter
Name	Description
`stub`	`CaseAttachmentServiceStub`

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

getSettings()

public final CaseAttachmentServiceSettings getSettings()

Returns
Type	Description
`CaseAttachmentServiceSettings`

getStub()

public CaseAttachmentServiceStub getStub()

Returns
Type	Description
`CaseAttachmentServiceStub`

isShutdown()

public boolean isShutdown()

Returns
Type	Description
`boolean`

isTerminated()

public boolean isTerminated()

Returns
Type	Description
`boolean`

listAttachments(CaseName parent)

public final CaseAttachmentServiceClient.ListAttachmentsPagedResponse listAttachments(CaseName parent)

Retrieve all attachments associated with a support case.

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 (CaseAttachmentServiceClient caseAttachmentServiceClient =
     CaseAttachmentServiceClient.create()) {
   CaseName parent = CaseName.ofProjectCaseName("[PROJECT]", "[CASE]");
   for (Attachment element : caseAttachmentServiceClient.listAttachments(parent).iterateAll()) {
     // doThingsWith(element);
   }
 }

Parameter
Name	Description
`parent`	`CaseName` Required. The resource name of Case object for which attachments should be listed.

Returns
Type	Description
`CaseAttachmentServiceClient.ListAttachmentsPagedResponse`

listAttachments(ListAttachmentsRequest request)

public final CaseAttachmentServiceClient.ListAttachmentsPagedResponse listAttachments(ListAttachmentsRequest request)

Retrieve all attachments associated with a support case.

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 (CaseAttachmentServiceClient caseAttachmentServiceClient =
     CaseAttachmentServiceClient.create()) {
   ListAttachmentsRequest request =
       ListAttachmentsRequest.newBuilder()
           .setParent(CaseName.ofProjectCaseName("[PROJECT]", "[CASE]").toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .build();
   for (Attachment element : caseAttachmentServiceClient.listAttachments(request).iterateAll()) {
     // doThingsWith(element);
   }
 }

Parameter
Name	Description
`request`	`ListAttachmentsRequest` The request object containing all of the parameters for the API call.

Returns
Type	Description
`CaseAttachmentServiceClient.ListAttachmentsPagedResponse`

listAttachments(String parent)

public final CaseAttachmentServiceClient.ListAttachmentsPagedResponse listAttachments(String parent)

Retrieve all attachments associated with a support case.

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 (CaseAttachmentServiceClient caseAttachmentServiceClient =
     CaseAttachmentServiceClient.create()) {
   String parent = CaseName.ofOrganizationCaseName("[ORGANIZATION]", "[CASE]").toString();
   for (Attachment element : caseAttachmentServiceClient.listAttachments(parent).iterateAll()) {
     // doThingsWith(element);
   }
 }

Parameter
Name	Description
`parent`	`String` Required. The resource name of Case object for which attachments should be listed.

Returns
Type	Description
`CaseAttachmentServiceClient.ListAttachmentsPagedResponse`

listAttachmentsCallable()

public final UnaryCallable<ListAttachmentsRequest,ListAttachmentsResponse> listAttachmentsCallable()

Retrieve all attachments associated with a support case.

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 (CaseAttachmentServiceClient caseAttachmentServiceClient =
     CaseAttachmentServiceClient.create()) {
   ListAttachmentsRequest request =
       ListAttachmentsRequest.newBuilder()
           .setParent(CaseName.ofProjectCaseName("[PROJECT]", "[CASE]").toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .build();
   while (true) {
     ListAttachmentsResponse response =
         caseAttachmentServiceClient.listAttachmentsCallable().call(request);
     for (Attachment element : response.getAttachmentsList()) {
       // doThingsWith(element);
     }
     String nextPageToken = response.getNextPageToken();
     if (!Strings.isNullOrEmpty(nextPageToken)) {
       request = request.toBuilder().setPageToken(nextPageToken).build();
     } else {
       break;
     }
   }
 }

Returns
Type	Description
`UnaryCallable<ListAttachmentsRequest,ListAttachmentsResponse>`

listAttachmentsPagedCallable()

public final UnaryCallable<ListAttachmentsRequest,CaseAttachmentServiceClient.ListAttachmentsPagedResponse> listAttachmentsPagedCallable()

Retrieve all attachments associated with a support case.

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 (CaseAttachmentServiceClient caseAttachmentServiceClient =
     CaseAttachmentServiceClient.create()) {
   ListAttachmentsRequest request =
       ListAttachmentsRequest.newBuilder()
           .setParent(CaseName.ofProjectCaseName("[PROJECT]", "[CASE]").toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .build();
   ApiFuture<Attachment> future =
       caseAttachmentServiceClient.listAttachmentsPagedCallable().futureCall(request);
   // Do something.
   for (Attachment element : future.get().iterateAll()) {
     // doThingsWith(element);
   }
 }

Returns
Type	Description
`UnaryCallable<ListAttachmentsRequest,ListAttachmentsPagedResponse>`

shutdown()

public void shutdown()

shutdownNow()

public void shutdownNow()