Package com.google.cloud.essentialcontacts.v1 (2.16.0)

A client to Essential Contacts API

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

EssentialContactsServiceClient

Service Description: Manages contacts for important Google Cloud notifications.

Sample for EssentialContactsServiceClient:


 // 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 (EssentialContactsServiceClient essentialContactsServiceClient =
     EssentialContactsServiceClient.create()) {
   FolderName parent = FolderName.of("[FOLDER]");
   Contact contact = Contact.newBuilder().build();
   Contact response = essentialContactsServiceClient.createContact(parent, contact);
 }

Classes

ComputeContactsRequest

Request message for the ComputeContacts method.

Protobuf type google.cloud.essentialcontacts.v1.ComputeContactsRequest

ComputeContactsRequest.Builder

Request message for the ComputeContacts method.

Protobuf type google.cloud.essentialcontacts.v1.ComputeContactsRequest

ComputeContactsResponse

Response message for the ComputeContacts method.

Protobuf type google.cloud.essentialcontacts.v1.ComputeContactsResponse

ComputeContactsResponse.Builder

Response message for the ComputeContacts method.

Protobuf type google.cloud.essentialcontacts.v1.ComputeContactsResponse

Contact

A contact that will receive notifications from Google Cloud.

Protobuf type google.cloud.essentialcontacts.v1.Contact

Contact.Builder

A contact that will receive notifications from Google Cloud.

Protobuf type google.cloud.essentialcontacts.v1.Contact

ContactName.Builder

Builder for projects/{project}/contacts/{contact}.

ContactName.FolderContactBuilder

Builder for folders/{folder}/contacts/{contact}.

ContactName.OrganizationContactBuilder

Builder for organizations/{organization}/contacts/{contact}.

CreateContactRequest

Request message for the CreateContact method.

Protobuf type google.cloud.essentialcontacts.v1.CreateContactRequest

CreateContactRequest.Builder

Request message for the CreateContact method.

Protobuf type google.cloud.essentialcontacts.v1.CreateContactRequest

DeleteContactRequest

Request message for the DeleteContact method.

Protobuf type google.cloud.essentialcontacts.v1.DeleteContactRequest

DeleteContactRequest.Builder

Request message for the DeleteContact method.

Protobuf type google.cloud.essentialcontacts.v1.DeleteContactRequest

EssentialContactsServiceClient

Service Description: Manages contacts for important Google Cloud notifications.

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 (EssentialContactsServiceClient essentialContactsServiceClient =
     EssentialContactsServiceClient.create()) {
   FolderName parent = FolderName.of("[FOLDER]");
   Contact contact = Contact.newBuilder().build();
   Contact response = essentialContactsServiceClient.createContact(parent, contact);
 }

Note: close() needs to be called on the EssentialContactsServiceClient 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 EssentialContactsServiceSettings 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
 EssentialContactsServiceSettings essentialContactsServiceSettings =
     EssentialContactsServiceSettings.newBuilder()
         .setCredentialsProvider(FixedCredentialsProvider.create(myCredentials))
         .build();
 EssentialContactsServiceClient essentialContactsServiceClient =
     EssentialContactsServiceClient.create(essentialContactsServiceSettings);

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
 EssentialContactsServiceSettings essentialContactsServiceSettings =
     EssentialContactsServiceSettings.newBuilder().setEndpoint(myEndpoint).build();
 EssentialContactsServiceClient essentialContactsServiceClient =
     EssentialContactsServiceClient.create(essentialContactsServiceSettings);

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
 EssentialContactsServiceSettings essentialContactsServiceSettings =
     EssentialContactsServiceSettings.newHttpJsonBuilder().build();
 EssentialContactsServiceClient essentialContactsServiceClient =
     EssentialContactsServiceClient.create(essentialContactsServiceSettings);

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

EssentialContactsServiceClient.ComputeContactsFixedSizeCollection

EssentialContactsServiceClient.ComputeContactsPage

EssentialContactsServiceClient.ComputeContactsPagedResponse

EssentialContactsServiceClient.ListContactsFixedSizeCollection

EssentialContactsServiceClient.ListContactsPage

EssentialContactsServiceClient.ListContactsPagedResponse

EssentialContactsServiceGrpc

Manages contacts for important Google Cloud notifications.

EssentialContactsServiceGrpc.EssentialContactsServiceBlockingStub

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

Manages contacts for important Google Cloud notifications.

EssentialContactsServiceGrpc.EssentialContactsServiceFutureStub

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

Manages contacts for important Google Cloud notifications.

EssentialContactsServiceGrpc.EssentialContactsServiceImplBase

Base class for the server implementation of the service EssentialContactsService.

Manages contacts for important Google Cloud notifications.

EssentialContactsServiceGrpc.EssentialContactsServiceStub

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

Manages contacts for important Google Cloud notifications.

EssentialContactsServiceSettings

Settings class to configure an instance of EssentialContactsServiceClient.

The default instance has everything set to sensible defaults:

The default service address (essentialcontacts.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 createContact 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
 EssentialContactsServiceSettings.Builder essentialContactsServiceSettingsBuilder =
     EssentialContactsServiceSettings.newBuilder();
 essentialContactsServiceSettingsBuilder
     .createContactSettings()
     .setRetrySettings(
         essentialContactsServiceSettingsBuilder
             .createContactSettings()
             .getRetrySettings()
             .toBuilder()
             .setTotalTimeout(Duration.ofSeconds(30))
             .build());
 EssentialContactsServiceSettings essentialContactsServiceSettings =
     essentialContactsServiceSettingsBuilder.build();

EssentialContactsServiceSettings.Builder

Builder for EssentialContactsServiceSettings.

FolderName

FolderName.Builder

Builder for folders/{folder}.

GetContactRequest

Request message for the GetContact method.

Protobuf type google.cloud.essentialcontacts.v1.GetContactRequest

GetContactRequest.Builder

Request message for the GetContact method.

Protobuf type google.cloud.essentialcontacts.v1.GetContactRequest

ListContactsRequest

Request message for the ListContacts method.

Protobuf type google.cloud.essentialcontacts.v1.ListContactsRequest

ListContactsRequest.Builder

Request message for the ListContacts method.

Protobuf type google.cloud.essentialcontacts.v1.ListContactsRequest

ListContactsResponse

Response message for the ListContacts method.

Protobuf type google.cloud.essentialcontacts.v1.ListContactsResponse

ListContactsResponse.Builder

Response message for the ListContacts method.

Protobuf type google.cloud.essentialcontacts.v1.ListContactsResponse

OrganizationName

OrganizationName.Builder

Builder for organizations/{organization}.

ProjectName

ProjectName.Builder

Builder for projects/{project}.

SendTestMessageRequest

Request message for the SendTestMessage method.

Protobuf type google.cloud.essentialcontacts.v1.SendTestMessageRequest

SendTestMessageRequest.Builder

Request message for the SendTestMessage method.

Protobuf type google.cloud.essentialcontacts.v1.SendTestMessageRequest

Service

UpdateContactRequest

Request message for the UpdateContact method.

Protobuf type google.cloud.essentialcontacts.v1.UpdateContactRequest

UpdateContactRequest.Builder

Request message for the UpdateContact method.

Protobuf type google.cloud.essentialcontacts.v1.UpdateContactRequest

Interfaces

ComputeContactsRequestOrBuilder

ComputeContactsResponseOrBuilder

ContactOrBuilder

CreateContactRequestOrBuilder

DeleteContactRequestOrBuilder

EssentialContactsServiceGrpc.AsyncService

Manages contacts for important Google Cloud notifications.

GetContactRequestOrBuilder

ListContactsRequestOrBuilder

ListContactsResponseOrBuilder

SendTestMessageRequestOrBuilder

UpdateContactRequestOrBuilder

Enums

NotificationCategory

The notification categories that an essential contact can be subscribed to. Each notification will be categorized by the sender into one of the following categories. All contacts that are subscribed to that category will receive the notification.

Protobuf enum google.cloud.essentialcontacts.v1.NotificationCategory

ValidationState

A contact's validation state indicates whether or not it is the correct contact to be receiving notifications for a particular resource.

Protobuf enum google.cloud.essentialcontacts.v1.ValidationState