Package com.google.cloud.eventarc.v1
Class EventarcSettings
java.lang.Object
com.google.api.gax.rpc.ClientSettings<EventarcSettings>
com.google.cloud.eventarc.v1.EventarcSettings
@Generated("by gapic-generator-java")
public class EventarcSettings
extends ClientSettings<EventarcSettings>
Settings class to configure an instance of
EventarcClient.
The default instance has everything set to sensible defaults:
- The default service address (eventarc.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](https://cloud.google.com/java/docs/reference/gax/latest/com.google.api.gax.retrying.RetrySettings) of getTrigger:
// 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
EventarcSettings.Builder eventarcSettingsBuilder = EventarcSettings.newBuilder();
eventarcSettingsBuilder
.getTriggerSettings()
.setRetrySettings(
eventarcSettingsBuilder
.getTriggerSettings()
.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());
EventarcSettings eventarcSettings = eventarcSettingsBuilder.build();
Please refer to the [Client Side Retry
Guide](https://docs.cloud.google.com/java/docs/client-retries) for additional support in setting
retries.
To configure the RetrySettings of a Long Running Operation method, create an OperationTimedPollAlgorithm object and update the RPC's polling algorithm. For example, to configure the RetrySettings for createTrigger:
// 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
EventarcSettings.Builder eventarcSettingsBuilder = EventarcSettings.newBuilder();
TimedRetryAlgorithm timedRetryAlgorithm =
OperationalTimedPollAlgorithm.create(
RetrySettings.newBuilder()
.setInitialRetryDelayDuration(Duration.ofMillis(500))
.setRetryDelayMultiplier(1.5)
.setMaxRetryDelayDuration(Duration.ofMillis(5000))
.setTotalTimeoutDuration(Duration.ofHours(24))
.build());
eventarcSettingsBuilder
.createClusterOperationSettings()
.setPollingAlgorithm(timedRetryAlgorithm)
.build();
-
Nested Class Summary
Nested ClassesModifier and TypeClassDescriptionstatic classBuilder for EventarcSettings. -
Constructor Summary
ConstructorsModifierConstructorDescriptionprotectedEventarcSettings(EventarcSettings.Builder settingsBuilder) -
Method Summary
Modifier and TypeMethodDescriptionstatic final EventarcSettingscreate(EventarcStubSettings stub) Returns the object with the settings used for calls to createChannelConnection.Returns the object with the settings used for calls to createChannelConnection.Returns the object with the settings used for calls to createChannel.Returns the object with the settings used for calls to createChannel.Returns the object with the settings used for calls to createEnrollment.Returns the object with the settings used for calls to createEnrollment.Returns the object with the settings used for calls to createGoogleApiSource.Returns the object with the settings used for calls to createGoogleApiSource.Returns the object with the settings used for calls to createMessageBus.Returns the object with the settings used for calls to createMessageBus.Returns the object with the settings used for calls to createPipeline.Returns the object with the settings used for calls to createPipeline.Returns the object with the settings used for calls to createTrigger.Returns the object with the settings used for calls to createTrigger.Returns a builder for the default credentials for this service.Returns a builder for the default ExecutorProvider for this service.Returns a builder for the default gRPC ChannelProvider for this service.Returns a builder for the default REST ChannelProvider for this service.static TransportChannelProviderReturns the object with the settings used for calls to deleteChannelConnection.Returns the object with the settings used for calls to deleteChannelConnection.Returns the object with the settings used for calls to deleteChannel.Returns the object with the settings used for calls to deleteChannel.Returns the object with the settings used for calls to deleteEnrollment.Returns the object with the settings used for calls to deleteEnrollment.Returns the object with the settings used for calls to deleteGoogleApiSource.Returns the object with the settings used for calls to deleteGoogleApiSource.Returns the object with the settings used for calls to deleteMessageBus.Returns the object with the settings used for calls to deleteMessageBus.Returns the object with the settings used for calls to deletePipeline.Returns the object with the settings used for calls to deletePipeline.Returns the object with the settings used for calls to deleteTrigger.Returns the object with the settings used for calls to deleteTrigger.Returns the object with the settings used for calls to getChannelConnection.Returns the object with the settings used for calls to getChannel.static StringReturns the default service endpoint.Returns the default service scopes.Returns the object with the settings used for calls to getEnrollment.Returns the object with the settings used for calls to getGoogleApiSource.Returns the object with the settings used for calls to getGoogleChannelConfig.Returns the object with the settings used for calls to getIamPolicy.Returns the object with the settings used for calls to getLocation.Returns the object with the settings used for calls to getMessageBus.Returns the object with the settings used for calls to getPipeline.Returns the object with the settings used for calls to getProvider.Returns the object with the settings used for calls to getTrigger.PagedCallSettings<ListChannelConnectionsRequest,ListChannelConnectionsResponse, EventarcClient.ListChannelConnectionsPagedResponse> Returns the object with the settings used for calls to listChannelConnections.PagedCallSettings<ListChannelsRequest,ListChannelsResponse, EventarcClient.ListChannelsPagedResponse> Returns the object with the settings used for calls to listChannels.PagedCallSettings<ListEnrollmentsRequest,ListEnrollmentsResponse, EventarcClient.ListEnrollmentsPagedResponse> Returns the object with the settings used for calls to listEnrollments.PagedCallSettings<ListGoogleApiSourcesRequest,ListGoogleApiSourcesResponse, EventarcClient.ListGoogleApiSourcesPagedResponse> Returns the object with the settings used for calls to listGoogleApiSources.PagedCallSettings<ListLocationsRequest,ListLocationsResponse, EventarcClient.ListLocationsPagedResponse> Returns the object with the settings used for calls to listLocations.PagedCallSettings<ListMessageBusEnrollmentsRequest,ListMessageBusEnrollmentsResponse, EventarcClient.ListMessageBusEnrollmentsPagedResponse> Returns the object with the settings used for calls to listMessageBusEnrollments.PagedCallSettings<ListMessageBusesRequest,ListMessageBusesResponse, EventarcClient.ListMessageBusesPagedResponse> Returns the object with the settings used for calls to listMessageBuses.PagedCallSettings<ListPipelinesRequest,ListPipelinesResponse, EventarcClient.ListPipelinesPagedResponse> Returns the object with the settings used for calls to listPipelines.PagedCallSettings<ListProvidersRequest,ListProvidersResponse, EventarcClient.ListProvidersPagedResponse> Returns the object with the settings used for calls to listProviders.PagedCallSettings<ListTriggersRequest,ListTriggersResponse, EventarcClient.ListTriggersPagedResponse> Returns the object with the settings used for calls to listTriggers.static EventarcSettings.BuilderReturns a new gRPC builder for this class.static EventarcSettings.BuildernewBuilder(ClientContext clientContext) Returns a new builder for this class.static EventarcSettings.BuilderReturns a new REST builder for this class.Returns the object with the settings used for calls to setIamPolicy.Returns the object with the settings used for calls to testIamPermissions.Returns a builder containing all the values of this settings class.Returns the object with the settings used for calls to updateChannel.Returns the object with the settings used for calls to updateChannel.Returns the object with the settings used for calls to updateEnrollment.Returns the object with the settings used for calls to updateEnrollment.Returns the object with the settings used for calls to updateGoogleApiSource.Returns the object with the settings used for calls to updateGoogleApiSource.Returns the object with the settings used for calls to updateGoogleChannelConfig.Returns the object with the settings used for calls to updateMessageBus.Returns the object with the settings used for calls to updateMessageBus.Returns the object with the settings used for calls to updatePipeline.Returns the object with the settings used for calls to updatePipeline.Returns the object with the settings used for calls to updateTrigger.Returns the object with the settings used for calls to updateTrigger.Methods inherited from class com.google.api.gax.rpc.ClientSettings
getApiKey, getBackgroundExecutorProvider, getClock, getCredentialsProvider, getEndpoint, getExecutorProvider, getGdchApiAudience, getHeaderProvider, getInternalHeaderProvider, getQuotaProjectId, getStubSettings, getTransportChannelProvider, getUniverseDomain, getWatchdogCheckInterval, getWatchdogCheckIntervalDuration, getWatchdogProvider, toString
-
Constructor Details
-
EventarcSettings
- Throws:
IOException
-
-
Method Details
-
getTriggerSettings
Returns the object with the settings used for calls to getTrigger. -
listTriggersSettings
public PagedCallSettings<ListTriggersRequest,ListTriggersResponse, listTriggersSettings()EventarcClient.ListTriggersPagedResponse> Returns the object with the settings used for calls to listTriggers. -
createTriggerSettings
Returns the object with the settings used for calls to createTrigger. -
createTriggerOperationSettings
public OperationCallSettings<CreateTriggerRequest,Trigger, createTriggerOperationSettings()OperationMetadata> Returns the object with the settings used for calls to createTrigger. -
updateTriggerSettings
Returns the object with the settings used for calls to updateTrigger. -
updateTriggerOperationSettings
public OperationCallSettings<UpdateTriggerRequest,Trigger, updateTriggerOperationSettings()OperationMetadata> Returns the object with the settings used for calls to updateTrigger. -
deleteTriggerSettings
Returns the object with the settings used for calls to deleteTrigger. -
deleteTriggerOperationSettings
public OperationCallSettings<DeleteTriggerRequest,Trigger, deleteTriggerOperationSettings()OperationMetadata> Returns the object with the settings used for calls to deleteTrigger. -
getChannelSettings
Returns the object with the settings used for calls to getChannel. -
listChannelsSettings
public PagedCallSettings<ListChannelsRequest,ListChannelsResponse, listChannelsSettings()EventarcClient.ListChannelsPagedResponse> Returns the object with the settings used for calls to listChannels. -
createChannelSettings
Returns the object with the settings used for calls to createChannel. -
createChannelOperationSettings
public OperationCallSettings<CreateChannelRequest,Channel, createChannelOperationSettings()OperationMetadata> Returns the object with the settings used for calls to createChannel. -
updateChannelSettings
Returns the object with the settings used for calls to updateChannel. -
updateChannelOperationSettings
public OperationCallSettings<UpdateChannelRequest,Channel, updateChannelOperationSettings()OperationMetadata> Returns the object with the settings used for calls to updateChannel. -
deleteChannelSettings
Returns the object with the settings used for calls to deleteChannel. -
deleteChannelOperationSettings
public OperationCallSettings<DeleteChannelRequest,Channel, deleteChannelOperationSettings()OperationMetadata> Returns the object with the settings used for calls to deleteChannel. -
getProviderSettings
Returns the object with the settings used for calls to getProvider. -
listProvidersSettings
public PagedCallSettings<ListProvidersRequest,ListProvidersResponse, listProvidersSettings()EventarcClient.ListProvidersPagedResponse> Returns the object with the settings used for calls to listProviders. -
getChannelConnectionSettings
public UnaryCallSettings<GetChannelConnectionRequest,ChannelConnection> getChannelConnectionSettings()Returns the object with the settings used for calls to getChannelConnection. -
listChannelConnectionsSettings
public PagedCallSettings<ListChannelConnectionsRequest,ListChannelConnectionsResponse, listChannelConnectionsSettings()EventarcClient.ListChannelConnectionsPagedResponse> Returns the object with the settings used for calls to listChannelConnections. -
createChannelConnectionSettings
public UnaryCallSettings<CreateChannelConnectionRequest,Operation> createChannelConnectionSettings()Returns the object with the settings used for calls to createChannelConnection. -
createChannelConnectionOperationSettings
public OperationCallSettings<CreateChannelConnectionRequest,ChannelConnection, createChannelConnectionOperationSettings()OperationMetadata> Returns the object with the settings used for calls to createChannelConnection. -
deleteChannelConnectionSettings
public UnaryCallSettings<DeleteChannelConnectionRequest,Operation> deleteChannelConnectionSettings()Returns the object with the settings used for calls to deleteChannelConnection. -
deleteChannelConnectionOperationSettings
public OperationCallSettings<DeleteChannelConnectionRequest,ChannelConnection, deleteChannelConnectionOperationSettings()OperationMetadata> Returns the object with the settings used for calls to deleteChannelConnection. -
getGoogleChannelConfigSettings
public UnaryCallSettings<GetGoogleChannelConfigRequest,GoogleChannelConfig> getGoogleChannelConfigSettings()Returns the object with the settings used for calls to getGoogleChannelConfig. -
updateGoogleChannelConfigSettings
public UnaryCallSettings<UpdateGoogleChannelConfigRequest,GoogleChannelConfig> updateGoogleChannelConfigSettings()Returns the object with the settings used for calls to updateGoogleChannelConfig. -
getMessageBusSettings
Returns the object with the settings used for calls to getMessageBus. -
listMessageBusesSettings
public PagedCallSettings<ListMessageBusesRequest,ListMessageBusesResponse, listMessageBusesSettings()EventarcClient.ListMessageBusesPagedResponse> Returns the object with the settings used for calls to listMessageBuses. -
listMessageBusEnrollmentsSettings
public PagedCallSettings<ListMessageBusEnrollmentsRequest,ListMessageBusEnrollmentsResponse, listMessageBusEnrollmentsSettings()EventarcClient.ListMessageBusEnrollmentsPagedResponse> Returns the object with the settings used for calls to listMessageBusEnrollments. -
createMessageBusSettings
Returns the object with the settings used for calls to createMessageBus. -
createMessageBusOperationSettings
public OperationCallSettings<CreateMessageBusRequest,MessageBus, createMessageBusOperationSettings()OperationMetadata> Returns the object with the settings used for calls to createMessageBus. -
updateMessageBusSettings
Returns the object with the settings used for calls to updateMessageBus. -
updateMessageBusOperationSettings
public OperationCallSettings<UpdateMessageBusRequest,MessageBus, updateMessageBusOperationSettings()OperationMetadata> Returns the object with the settings used for calls to updateMessageBus. -
deleteMessageBusSettings
Returns the object with the settings used for calls to deleteMessageBus. -
deleteMessageBusOperationSettings
public OperationCallSettings<DeleteMessageBusRequest,MessageBus, deleteMessageBusOperationSettings()OperationMetadata> Returns the object with the settings used for calls to deleteMessageBus. -
getEnrollmentSettings
Returns the object with the settings used for calls to getEnrollment. -
listEnrollmentsSettings
public PagedCallSettings<ListEnrollmentsRequest,ListEnrollmentsResponse, listEnrollmentsSettings()EventarcClient.ListEnrollmentsPagedResponse> Returns the object with the settings used for calls to listEnrollments. -
createEnrollmentSettings
Returns the object with the settings used for calls to createEnrollment. -
createEnrollmentOperationSettings
public OperationCallSettings<CreateEnrollmentRequest,Enrollment, createEnrollmentOperationSettings()OperationMetadata> Returns the object with the settings used for calls to createEnrollment. -
updateEnrollmentSettings
Returns the object with the settings used for calls to updateEnrollment. -
updateEnrollmentOperationSettings
public OperationCallSettings<UpdateEnrollmentRequest,Enrollment, updateEnrollmentOperationSettings()OperationMetadata> Returns the object with the settings used for calls to updateEnrollment. -
deleteEnrollmentSettings
Returns the object with the settings used for calls to deleteEnrollment. -
deleteEnrollmentOperationSettings
public OperationCallSettings<DeleteEnrollmentRequest,Enrollment, deleteEnrollmentOperationSettings()OperationMetadata> Returns the object with the settings used for calls to deleteEnrollment. -
getPipelineSettings
Returns the object with the settings used for calls to getPipeline. -
listPipelinesSettings
public PagedCallSettings<ListPipelinesRequest,ListPipelinesResponse, listPipelinesSettings()EventarcClient.ListPipelinesPagedResponse> Returns the object with the settings used for calls to listPipelines. -
createPipelineSettings
Returns the object with the settings used for calls to createPipeline. -
createPipelineOperationSettings
public OperationCallSettings<CreatePipelineRequest,Pipeline, createPipelineOperationSettings()OperationMetadata> Returns the object with the settings used for calls to createPipeline. -
updatePipelineSettings
Returns the object with the settings used for calls to updatePipeline. -
updatePipelineOperationSettings
public OperationCallSettings<UpdatePipelineRequest,Pipeline, updatePipelineOperationSettings()OperationMetadata> Returns the object with the settings used for calls to updatePipeline. -
deletePipelineSettings
Returns the object with the settings used for calls to deletePipeline. -
deletePipelineOperationSettings
public OperationCallSettings<DeletePipelineRequest,Pipeline, deletePipelineOperationSettings()OperationMetadata> Returns the object with the settings used for calls to deletePipeline. -
getGoogleApiSourceSettings
Returns the object with the settings used for calls to getGoogleApiSource. -
listGoogleApiSourcesSettings
public PagedCallSettings<ListGoogleApiSourcesRequest,ListGoogleApiSourcesResponse, listGoogleApiSourcesSettings()EventarcClient.ListGoogleApiSourcesPagedResponse> Returns the object with the settings used for calls to listGoogleApiSources. -
createGoogleApiSourceSettings
Returns the object with the settings used for calls to createGoogleApiSource. -
createGoogleApiSourceOperationSettings
public OperationCallSettings<CreateGoogleApiSourceRequest,GoogleApiSource, createGoogleApiSourceOperationSettings()OperationMetadata> Returns the object with the settings used for calls to createGoogleApiSource. -
updateGoogleApiSourceSettings
Returns the object with the settings used for calls to updateGoogleApiSource. -
updateGoogleApiSourceOperationSettings
public OperationCallSettings<UpdateGoogleApiSourceRequest,GoogleApiSource, updateGoogleApiSourceOperationSettings()OperationMetadata> Returns the object with the settings used for calls to updateGoogleApiSource. -
deleteGoogleApiSourceSettings
Returns the object with the settings used for calls to deleteGoogleApiSource. -
deleteGoogleApiSourceOperationSettings
public OperationCallSettings<DeleteGoogleApiSourceRequest,GoogleApiSource, deleteGoogleApiSourceOperationSettings()OperationMetadata> Returns the object with the settings used for calls to deleteGoogleApiSource. -
listLocationsSettings
public PagedCallSettings<ListLocationsRequest,ListLocationsResponse, listLocationsSettings()EventarcClient.ListLocationsPagedResponse> Returns the object with the settings used for calls to listLocations. -
getLocationSettings
Returns the object with the settings used for calls to getLocation. -
setIamPolicySettings
Returns the object with the settings used for calls to setIamPolicy. -
getIamPolicySettings
Returns the object with the settings used for calls to getIamPolicy. -
testIamPermissionsSettings
public UnaryCallSettings<TestIamPermissionsRequest,TestIamPermissionsResponse> testIamPermissionsSettings()Returns the object with the settings used for calls to testIamPermissions. -
create
- Throws:
IOException
-
defaultExecutorProviderBuilder
Returns a builder for the default ExecutorProvider for this service. -
getDefaultEndpoint
Returns the default service endpoint. -
getDefaultServiceScopes
Returns the default service scopes. -
defaultCredentialsProviderBuilder
Returns a builder for the default credentials for this service. -
defaultGrpcTransportProviderBuilder
Returns a builder for the default gRPC ChannelProvider for this service. -
defaultHttpJsonTransportProviderBuilder
@BetaApi public static InstantiatingHttpJsonChannelProvider.Builder defaultHttpJsonTransportProviderBuilder()Returns a builder for the default REST ChannelProvider for this service. -
defaultTransportChannelProvider
-
defaultApiClientHeaderProviderBuilder
-
newBuilder
Returns a new gRPC builder for this class. -
newHttpJsonBuilder
Returns a new REST builder for this class. -
newBuilder
Returns a new builder for this class. -
toBuilder
Returns a builder containing all the values of this settings class.- Specified by:
toBuilderin classClientSettings<EventarcSettings>
-