Package com.google.cloud.support.v2 (0.4.0)

A client to Google Cloud Support API

The interfaces provided are listed below, along with usage samples.

CaseAttachmentServiceClient

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

Sample for CaseAttachmentServiceClient:


 // 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);
   }
 }

CaseServiceClient

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

Sample for CaseServiceClient:


 // 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 (CaseServiceClient caseServiceClient = CaseServiceClient.create()) {
   CaseName name = CaseName.ofProjectCaseName("[PROJECT]", "[CASE]");
   Case response = caseServiceClient.getCase(name);
 }

CommentServiceClient

Service Description: A service to manage comments on cases.

Sample for CommentServiceClient:


 // 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 (CommentServiceClient commentServiceClient = CommentServiceClient.create()) {
   CaseName parent = CaseName.ofProjectCaseName("[PROJECT]", "[CASE]");
   Comment comment = Comment.newBuilder().build();
   Comment response = commentServiceClient.createComment(parent, comment);
 }

Classes

Actor

An object containing information about the effective user and authenticated principal responsible for an action.

Protobuf type google.cloud.support.v2.Actor

Actor.Builder

An object containing information about the effective user and authenticated principal responsible for an action.

Protobuf type google.cloud.support.v2.Actor

Attachment

Represents a file attached to a support case.

Protobuf type google.cloud.support.v2.Attachment

Attachment.Builder

Represents a file attached to a support case.

Protobuf type google.cloud.support.v2.Attachment

Case

A support case.

Protobuf type google.cloud.support.v2.Case

Case.Builder

A support case.

Protobuf type google.cloud.support.v2.Case

CaseAttachmentServiceClient

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.

CaseAttachmentServiceClient.ListAttachmentsFixedSizeCollection

CaseAttachmentServiceClient.ListAttachmentsPage

CaseAttachmentServiceClient.ListAttachmentsPagedResponse

CaseAttachmentServiceGrpc

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

CaseAttachmentServiceGrpc.CaseAttachmentServiceBlockingStub

A stub to allow clients to do synchronous rpc calls to service CaseAttachmentService.

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

CaseAttachmentServiceGrpc.CaseAttachmentServiceFutureStub

A stub to allow clients to do ListenableFuture-style rpc calls to service CaseAttachmentService.

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

CaseAttachmentServiceGrpc.CaseAttachmentServiceImplBase

Base class for the server implementation of the service CaseAttachmentService.

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

CaseAttachmentServiceGrpc.CaseAttachmentServiceStub

A stub to allow clients to do asynchronous rpc calls to service CaseAttachmentService.

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

CaseAttachmentServiceSettings

Settings class to configure an instance of CaseAttachmentServiceClient.

The default instance has everything set to sensible defaults:

The default service address (cloudsupport.googleapis.com) and default port (443) are used.
Credentials are acquired automatically through Application Default Credentials.
Retries are configured for idempotent methods but not for non-idempotent methods.

The builder of this class is recursive, so contained classes are themselves builders. When build() is called, the tree of builders is called to create the complete settings object.

For example, to set the total timeout of listAttachments to 30 seconds:


 // 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.Builder caseAttachmentServiceSettingsBuilder =
     CaseAttachmentServiceSettings.newBuilder();
 caseAttachmentServiceSettingsBuilder
     .listAttachmentsSettings()
     .setRetrySettings(
         caseAttachmentServiceSettingsBuilder
             .listAttachmentsSettings()
             .getRetrySettings()
             .toBuilder()
             .setTotalTimeout(Duration.ofSeconds(30))
             .build());
 CaseAttachmentServiceSettings caseAttachmentServiceSettings =
     caseAttachmentServiceSettingsBuilder.build();

CaseAttachmentServiceSettings.Builder

Builder for CaseAttachmentServiceSettings.

CaseClassification

A classification object with a product type and value.

Protobuf type google.cloud.support.v2.CaseClassification

CaseClassification.Builder

A classification object with a product type and value.

Protobuf type google.cloud.support.v2.CaseClassification

CaseName

CaseName.Builder

Builder for organizations/{organization}/cases/{case}.

CaseName.ProjectCaseBuilder

Builder for projects/{project}/cases/{case}.

CaseProto

CaseServiceClient

Service Description: A service to manage 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 (CaseServiceClient caseServiceClient = CaseServiceClient.create()) {
   CaseName name = CaseName.ofProjectCaseName("[PROJECT]", "[CASE]");
   Case response = caseServiceClient.getCase(name);
 }

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

This class can be customized by passing in a custom instance of CaseServiceSettings 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
 CaseServiceSettings caseServiceSettings =
     CaseServiceSettings.newBuilder()
         .setCredentialsProvider(FixedCredentialsProvider.create(myCredentials))
         .build();
 CaseServiceClient caseServiceClient = CaseServiceClient.create(caseServiceSettings);

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
 CaseServiceSettings caseServiceSettings =
     CaseServiceSettings.newBuilder().setEndpoint(myEndpoint).build();
 CaseServiceClient caseServiceClient = CaseServiceClient.create(caseServiceSettings);

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
 CaseServiceSettings caseServiceSettings = CaseServiceSettings.newHttpJsonBuilder().build();
 CaseServiceClient caseServiceClient = CaseServiceClient.create(caseServiceSettings);

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

CaseServiceClient.ListCasesFixedSizeCollection

CaseServiceClient.ListCasesPage

CaseServiceClient.ListCasesPagedResponse

CaseServiceClient.SearchCaseClassificationsFixedSizeCollection

CaseServiceClient.SearchCaseClassificationsPage

CaseServiceClient.SearchCaseClassificationsPagedResponse