Class AlertPolicyServiceSettings (3.3.5)

public class AlertPolicyServiceSettings extends ClientSettings<AlertPolicyServiceSettings>

Settings class to configure an instance of AlertPolicyServiceClient.

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 total timeout of getAlertPolicy to 30 seconds:


 // This snippet has been automatically generated for illustrative purposes only.
 // It may require modifications to work in your environment.
 AlertPolicyServiceSettings.Builder alertPolicyServiceSettingsBuilder =
     AlertPolicyServiceSettings.newBuilder();
 alertPolicyServiceSettingsBuilder
     .getAlertPolicySettings()
     .setRetrySettings(
         alertPolicyServiceSettingsBuilder
             .getAlertPolicySettings()
             .getRetrySettings()
             .toBuilder()
             .setTotalTimeout(Duration.ofSeconds(30))
             .build());
 AlertPolicyServiceSettings alertPolicyServiceSettings =
     alertPolicyServiceSettingsBuilder.build();
 

Inheritance

java.lang.Object > ClientSettings > AlertPolicyServiceSettings

Static Methods

create(AlertPolicyServiceStubSettings stub)

public static final AlertPolicyServiceSettings create(AlertPolicyServiceStubSettings stub)
Parameter
NameDescription
stubAlertPolicyServiceStubSettings
Returns
TypeDescription
AlertPolicyServiceSettings
Exceptions
TypeDescription
IOException

defaultApiClientHeaderProviderBuilder()

public static ApiClientHeaderProvider.Builder defaultApiClientHeaderProviderBuilder()
Returns
TypeDescription
Builder

defaultCredentialsProviderBuilder()

public static GoogleCredentialsProvider.Builder defaultCredentialsProviderBuilder()

Returns a builder for the default credentials for this service.

Returns
TypeDescription
Builder

defaultExecutorProviderBuilder()

public static InstantiatingExecutorProvider.Builder defaultExecutorProviderBuilder()

Returns a builder for the default ExecutorProvider for this service.

Returns
TypeDescription
Builder

defaultGrpcTransportProviderBuilder()

public static InstantiatingGrpcChannelProvider.Builder defaultGrpcTransportProviderBuilder()

Returns a builder for the default ChannelProvider for this service.

Returns
TypeDescription
Builder

defaultTransportChannelProvider()

public static TransportChannelProvider defaultTransportChannelProvider()
Returns
TypeDescription
TransportChannelProvider

getDefaultEndpoint()

public static String getDefaultEndpoint()

Returns the default service endpoint.

Returns
TypeDescription
String

getDefaultServiceScopes()

public static List<String> getDefaultServiceScopes()

Returns the default service scopes.

Returns
TypeDescription
List<String>

newBuilder()

public static AlertPolicyServiceSettings.Builder newBuilder()

Returns a new builder for this class.

Returns
TypeDescription
AlertPolicyServiceSettings.Builder

newBuilder(ClientContext clientContext)

public static AlertPolicyServiceSettings.Builder newBuilder(ClientContext clientContext)

Returns a new builder for this class.

Parameter
NameDescription
clientContextClientContext
Returns
TypeDescription
AlertPolicyServiceSettings.Builder

Constructors

AlertPolicyServiceSettings(AlertPolicyServiceSettings.Builder settingsBuilder)

protected AlertPolicyServiceSettings(AlertPolicyServiceSettings.Builder settingsBuilder)
Parameter
NameDescription
settingsBuilderAlertPolicyServiceSettings.Builder

Methods

createAlertPolicySettings()

public UnaryCallSettings<CreateAlertPolicyRequest,AlertPolicy> createAlertPolicySettings()

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

Returns
TypeDescription
UnaryCallSettings<CreateAlertPolicyRequest,AlertPolicy>

deleteAlertPolicySettings()

public UnaryCallSettings<DeleteAlertPolicyRequest,Empty> deleteAlertPolicySettings()

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

Returns
TypeDescription
UnaryCallSettings<DeleteAlertPolicyRequest,Empty>

getAlertPolicySettings()

public UnaryCallSettings<GetAlertPolicyRequest,AlertPolicy> getAlertPolicySettings()

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

Returns
TypeDescription
UnaryCallSettings<GetAlertPolicyRequest,AlertPolicy>

listAlertPoliciesSettings()

public PagedCallSettings<ListAlertPoliciesRequest,ListAlertPoliciesResponse,AlertPolicyServiceClient.ListAlertPoliciesPagedResponse> listAlertPoliciesSettings()

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

Returns
TypeDescription
PagedCallSettings<ListAlertPoliciesRequest,ListAlertPoliciesResponse,ListAlertPoliciesPagedResponse>

toBuilder()

public AlertPolicyServiceSettings.Builder toBuilder()

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

Returns
TypeDescription
AlertPolicyServiceSettings.Builder
Overrides

updateAlertPolicySettings()

public UnaryCallSettings<UpdateAlertPolicyRequest,AlertPolicy> updateAlertPolicySettings()

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

Returns
TypeDescription
UnaryCallSettings<UpdateAlertPolicyRequest,AlertPolicy>