Class NotificationChannelServiceSettings (3.53.0) 

public class NotificationChannelServiceSettings extends ClientSettings<NotificationChannelServiceSettings>

Settings class to configure an instance of NotificationChannelServiceClient.

The default instance has everything set to sensible defaults:

  • The default service address (monitoring.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 RetrySettings of getNotificationChannelDescriptor:


 // 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
 NotificationChannelServiceSettings.Builder notificationChannelServiceSettingsBuilder =
     NotificationChannelServiceSettings.newBuilder();
 notificationChannelServiceSettingsBuilder
     .getNotificationChannelDescriptorSettings()
     .setRetrySettings(
         notificationChannelServiceSettingsBuilder
             .getNotificationChannelDescriptorSettings()
             .getRetrySettings()
             .toBuilder()
             .setInitialRetryDelayDuration(Duration.ofSeconds(1))
             .setInitialRpcTimeoutDuration(Duration.ofSeconds(5))
             .setMaxAttempts(5)
             .setMaxRetryDelayDuration(Duration.ofSeconds(30))
             .setMaxRpcTimeoutDuration(Duration.ofSeconds(60))
             .setRetryDelayMultiplier(1.3)
             .setRpcTimeoutMultiplier(1.5)
             .setTotalTimeoutDuration(Duration.ofSeconds(300))
             .build());
 NotificationChannelServiceSettings notificationChannelServiceSettings =
     notificationChannelServiceSettingsBuilder.build();

Please refer to the Client Side Retry Guide for additional support in setting retries.

Inheritance

java.lang.Object > ClientSettings > NotificationChannelServiceSettings

Static Methods

create(NotificationChannelServiceStubSettings stub)

public static final NotificationChannelServiceSettings create(NotificationChannelServiceStubSettings stub)
Parameter
Name Description
stub NotificationChannelServiceStubSettings
Returns
Type Description
NotificationChannelServiceSettings
Exceptions
Type Description
IOException

defaultApiClientHeaderProviderBuilder()

public static ApiClientHeaderProvider.Builder defaultApiClientHeaderProviderBuilder()
Returns
Type Description
Builder

defaultCredentialsProviderBuilder()

public static GoogleCredentialsProvider.Builder defaultCredentialsProviderBuilder()

Returns a builder for the default credentials for this service.

Returns
Type Description
Builder

defaultExecutorProviderBuilder()

public static InstantiatingExecutorProvider.Builder defaultExecutorProviderBuilder()

Returns a builder for the default ExecutorProvider for this service.

Returns
Type Description
Builder

defaultGrpcTransportProviderBuilder()

public static InstantiatingGrpcChannelProvider.Builder defaultGrpcTransportProviderBuilder()

Returns a builder for the default ChannelProvider for this service.

Returns
Type Description
Builder

defaultTransportChannelProvider()

public static TransportChannelProvider defaultTransportChannelProvider()
Returns
Type Description
TransportChannelProvider

getDefaultEndpoint()

public static String getDefaultEndpoint()

Returns the default service endpoint.

Returns
Type Description
String

getDefaultServiceScopes()

public static List<String> getDefaultServiceScopes()

Returns the default service scopes.

Returns
Type Description
List<String>

newBuilder()

public static NotificationChannelServiceSettings.Builder newBuilder()

Returns a new builder for this class.

Returns
Type Description
NotificationChannelServiceSettings.Builder

newBuilder(ClientContext clientContext)

public static NotificationChannelServiceSettings.Builder newBuilder(ClientContext clientContext)

Returns a new builder for this class.

Parameter
Name Description
clientContext ClientContext
Returns
Type Description
NotificationChannelServiceSettings.Builder

Constructors

NotificationChannelServiceSettings(NotificationChannelServiceSettings.Builder settingsBuilder)

protected NotificationChannelServiceSettings(NotificationChannelServiceSettings.Builder settingsBuilder)
Parameter
Name Description
settingsBuilder NotificationChannelServiceSettings.Builder

Methods

createNotificationChannelSettings()

public UnaryCallSettings<CreateNotificationChannelRequest,NotificationChannel> createNotificationChannelSettings()

Returns the object with the settings used for calls to createNotificationChannel.

Returns
Type Description
UnaryCallSettings<CreateNotificationChannelRequest,NotificationChannel>

deleteNotificationChannelSettings()

public UnaryCallSettings<DeleteNotificationChannelRequest,Empty> deleteNotificationChannelSettings()

Returns the object with the settings used for calls to deleteNotificationChannel.

Returns
Type Description
UnaryCallSettings<DeleteNotificationChannelRequest,Empty>

getNotificationChannelDescriptorSettings()

public UnaryCallSettings<GetNotificationChannelDescriptorRequest,NotificationChannelDescriptor> getNotificationChannelDescriptorSettings()

Returns the object with the settings used for calls to getNotificationChannelDescriptor.

Returns
Type Description
UnaryCallSettings<GetNotificationChannelDescriptorRequest,NotificationChannelDescriptor>

getNotificationChannelSettings()

public UnaryCallSettings<GetNotificationChannelRequest,NotificationChannel> getNotificationChannelSettings()

Returns the object with the settings used for calls to getNotificationChannel.

Returns
Type Description
UnaryCallSettings<GetNotificationChannelRequest,NotificationChannel>

getNotificationChannelVerificationCodeSettings()

public UnaryCallSettings<GetNotificationChannelVerificationCodeRequest,GetNotificationChannelVerificationCodeResponse> getNotificationChannelVerificationCodeSettings()

Returns the object with the settings used for calls to getNotificationChannelVerificationCode.

Returns
Type Description
UnaryCallSettings<GetNotificationChannelVerificationCodeRequest,GetNotificationChannelVerificationCodeResponse>

listNotificationChannelDescriptorsSettings()

public PagedCallSettings<ListNotificationChannelDescriptorsRequest,ListNotificationChannelDescriptorsResponse,NotificationChannelServiceClient.ListNotificationChannelDescriptorsPagedResponse> listNotificationChannelDescriptorsSettings()

Returns the object with the settings used for calls to listNotificationChannelDescriptors.

Returns
Type Description
PagedCallSettings<ListNotificationChannelDescriptorsRequest,ListNotificationChannelDescriptorsResponse,ListNotificationChannelDescriptorsPagedResponse>

listNotificationChannelsSettings()

public PagedCallSettings<ListNotificationChannelsRequest,ListNotificationChannelsResponse,NotificationChannelServiceClient.ListNotificationChannelsPagedResponse> listNotificationChannelsSettings()

Returns the object with the settings used for calls to listNotificationChannels.

Returns
Type Description
PagedCallSettings<ListNotificationChannelsRequest,ListNotificationChannelsResponse,ListNotificationChannelsPagedResponse>

sendNotificationChannelVerificationCodeSettings()

public UnaryCallSettings<SendNotificationChannelVerificationCodeRequest,Empty> sendNotificationChannelVerificationCodeSettings()

Returns the object with the settings used for calls to sendNotificationChannelVerificationCode.

Returns
Type Description
UnaryCallSettings<SendNotificationChannelVerificationCodeRequest,Empty>

toBuilder()

public NotificationChannelServiceSettings.Builder toBuilder()

Returns a builder containing all the values of this settings class.

Returns
Type Description
NotificationChannelServiceSettings.Builder
Overrides

updateNotificationChannelSettings()

public UnaryCallSettings<UpdateNotificationChannelRequest,NotificationChannel> updateNotificationChannelSettings()

Returns the object with the settings used for calls to updateNotificationChannel.

Returns
Type Description
UnaryCallSettings<UpdateNotificationChannelRequest,NotificationChannel>

verifyNotificationChannelSettings()

public UnaryCallSettings<VerifyNotificationChannelRequest,NotificationChannel> verifyNotificationChannelSettings()

Returns the object with the settings used for calls to verifyNotificationChannel.

Returns
Type Description
UnaryCallSettings<VerifyNotificationChannelRequest,NotificationChannel>