Class EventarcStubSettings (1.53.0)

public class EventarcStubSettings extends StubSettings<EventarcStubSettings>

Settings class to configure an instance of EventarcStub.

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 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
 EventarcStubSettings.Builder eventarcSettingsBuilder = EventarcStubSettings.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());
 EventarcStubSettings eventarcSettings = eventarcSettingsBuilder.build();

Please refer to the Client Side Retry Guide 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
 EventarcStubSettings.Builder eventarcSettingsBuilder = EventarcStubSettings.newBuilder();
 TimedRetryAlgorithm timedRetryAlgorithm =
     OperationalTimedPollAlgorithm.create(
         RetrySettings.newBuilder()
             .setInitialRetryDelayDuration(Duration.ofMillis(500))
             .setRetryDelayMultiplier(1.5)
             .setMaxRetryDelay(Duration.ofMillis(5000))
             .setTotalTimeoutDuration(Duration.ofHours(24))
             .build());
 eventarcSettingsBuilder
     .createClusterOperationSettings()
     .setPollingAlgorithm(timedRetryAlgorithm)
     .build();

Inheritance

java.lang.Object > StubSettings > EventarcStubSettings

Inherited Members

StubSettings.getApiKey()

StubSettings.getBackgroundExecutorProvider()

StubSettings.getClock()

StubSettings.getCredentialsProvider()

StubSettings.getEndpoint()

StubSettings.getExecutorProvider()

StubSettings.getGdchApiAudience()

StubSettings.getHeaderProvider()

StubSettings.getInternalHeaderProvider()

StubSettings.getMtlsEndpoint()

StubSettings.getQuotaProjectId()

StubSettings.getServiceName()

StubSettings.getStreamWatchdogCheckInterval()

StubSettings.getStreamWatchdogCheckIntervalDuration()

StubSettings.getStreamWatchdogProvider()

StubSettings.getTracerFactory()

StubSettings.getTransportChannelProvider()

StubSettings.getUniverseDomain()

StubSettings.toBuilder()

StubSettings.toString()

Object.clone()

Object.equals(Object)

Object.finalize()

Object.getClass()

Object.hashCode()

Object.notify()

Object.notifyAll()

Object.wait()

Object.wait(long)

Object.wait(long,int)

Static Methods

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`

defaultGrpcApiClientHeaderProviderBuilder()

public static ApiClientHeaderProvider.Builder defaultGrpcApiClientHeaderProviderBuilder()

Returns
Type	Description
`Builder`

defaultGrpcTransportProviderBuilder()

public static InstantiatingGrpcChannelProvider.Builder defaultGrpcTransportProviderBuilder()

Returns a builder for the default gRPC ChannelProvider for this service.

Returns
Type	Description
`Builder`

defaultHttpJsonApiClientHeaderProviderBuilder()

public static ApiClientHeaderProvider.Builder defaultHttpJsonApiClientHeaderProviderBuilder()

Returns
Type	Description
`Builder`

defaultHttpJsonTransportProviderBuilder()

public static InstantiatingHttpJsonChannelProvider.Builder defaultHttpJsonTransportProviderBuilder()

Returns a builder for the default REST 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`

getDefaultMtlsEndpoint()

public static String getDefaultMtlsEndpoint()

Returns the default mTLS 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 EventarcStubSettings.Builder newBuilder()

Returns a new gRPC builder for this class.

Returns
Type	Description
`EventarcStubSettings.Builder`

newBuilder(ClientContext clientContext)

public static EventarcStubSettings.Builder newBuilder(ClientContext clientContext)

Returns a new builder for this class.

Parameter
Name	Description
`clientContext`	`ClientContext`

Returns
Type	Description
`EventarcStubSettings.Builder`

newHttpJsonBuilder()

public static EventarcStubSettings.Builder newHttpJsonBuilder()

Returns a new REST builder for this class.

Returns
Type	Description
`EventarcStubSettings.Builder`

Constructors

EventarcStubSettings(EventarcStubSettings.Builder settingsBuilder)

protected EventarcStubSettings(EventarcStubSettings.Builder settingsBuilder)

Parameter
Name	Description
`settingsBuilder`	`EventarcStubSettings.Builder`

Methods

createChannelConnectionOperationSettings()

public OperationCallSettings<CreateChannelConnectionRequest,ChannelConnection,OperationMetadata> createChannelConnectionOperationSettings()

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

Returns
Type	Description
`OperationCallSettings<CreateChannelConnectionRequest,ChannelConnection,OperationMetadata>`

createChannelConnectionSettings()

public UnaryCallSettings<CreateChannelConnectionRequest,Operation> createChannelConnectionSettings()

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

Returns
Type	Description
`UnaryCallSettings<CreateChannelConnectionRequest,Operation>`

createChannelOperationSettings()

public OperationCallSettings<CreateChannelRequest,Channel,OperationMetadata> createChannelOperationSettings()

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

Returns
Type	Description
`OperationCallSettings<CreateChannelRequest,Channel,OperationMetadata>`

createChannelSettings()

public UnaryCallSettings<CreateChannelRequest,Operation> createChannelSettings()

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

Returns
Type	Description
`UnaryCallSettings<CreateChannelRequest,Operation>`

createStub()

public EventarcStub createStub()

Returns
Type	Description
`EventarcStub`

Exceptions
Type	Description
`IOException`

createTriggerOperationSettings()

public OperationCallSettings<CreateTriggerRequest,Trigger,OperationMetadata> createTriggerOperationSettings()

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

Returns
Type	Description
`OperationCallSettings<CreateTriggerRequest,Trigger,OperationMetadata>`

createTriggerSettings()

public UnaryCallSettings<CreateTriggerRequest,Operation> createTriggerSettings()

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

Returns
Type	Description
`UnaryCallSettings<CreateTriggerRequest,Operation>`

deleteChannelConnectionOperationSettings()

public OperationCallSettings<DeleteChannelConnectionRequest,ChannelConnection,OperationMetadata> deleteChannelConnectionOperationSettings()

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

Returns
Type	Description
`OperationCallSettings<DeleteChannelConnectionRequest,ChannelConnection,OperationMetadata>`

deleteChannelConnectionSettings()

public UnaryCallSettings<DeleteChannelConnectionRequest,Operation> deleteChannelConnectionSettings()

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

Returns
Type	Description
`UnaryCallSettings<DeleteChannelConnectionRequest,Operation>`

deleteChannelOperationSettings()

public OperationCallSettings<DeleteChannelRequest,Channel,OperationMetadata> deleteChannelOperationSettings()

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

Returns
Type	Description
`OperationCallSettings<DeleteChannelRequest,Channel,OperationMetadata>`

deleteChannelSettings()

public UnaryCallSettings<DeleteChannelRequest,Operation> deleteChannelSettings()

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

Returns
Type	Description
`UnaryCallSettings<DeleteChannelRequest,Operation>`

deleteTriggerOperationSettings()

public OperationCallSettings<DeleteTriggerRequest,Trigger,OperationMetadata> deleteTriggerOperationSettings()

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

Returns
Type	Description
`OperationCallSettings<DeleteTriggerRequest,Trigger,OperationMetadata>`

deleteTriggerSettings()

public UnaryCallSettings<DeleteTriggerRequest,Operation> deleteTriggerSettings()

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

Returns
Type	Description
`UnaryCallSettings<DeleteTriggerRequest,Operation>`

getChannelConnectionSettings()

public UnaryCallSettings<GetChannelConnectionRequest,ChannelConnection> getChannelConnectionSettings()

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

Returns
Type	Description
`UnaryCallSettings<GetChannelConnectionRequest,ChannelConnection>`

getChannelSettings()

public UnaryCallSettings<GetChannelRequest,Channel> getChannelSettings()

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

Returns
Type	Description
`UnaryCallSettings<GetChannelRequest,Channel>`

getGoogleChannelConfigSettings()

public UnaryCallSettings<GetGoogleChannelConfigRequest,GoogleChannelConfig> getGoogleChannelConfigSettings()

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

Returns
Type	Description
`UnaryCallSettings<GetGoogleChannelConfigRequest,GoogleChannelConfig>`

getIamPolicySettings()

public UnaryCallSettings<GetIamPolicyRequest,Policy> getIamPolicySettings()

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

Returns
Type	Description
`UnaryCallSettings<com.google.iam.v1.GetIamPolicyRequest,com.google.iam.v1.Policy>`

getLocationSettings()

public UnaryCallSettings<GetLocationRequest,Location> getLocationSettings()

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

Returns
Type	Description
`UnaryCallSettings<com.google.cloud.location.GetLocationRequest,com.google.cloud.location.Location>`

getProviderSettings()

public UnaryCallSettings<GetProviderRequest,Provider> getProviderSettings()

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

Returns
Type	Description
`UnaryCallSettings<GetProviderRequest,Provider>`

getServiceName()

public String getServiceName()

Returns the default service name.

Returns
Type	Description
`String`

Overrides

StubSettings<SettingsT>.getServiceName()

getTriggerSettings()

public UnaryCallSettings<GetTriggerRequest,Trigger> getTriggerSettings()

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

Returns
Type	Description
`UnaryCallSettings<GetTriggerRequest,Trigger>`

listChannelConnectionsSettings()

public PagedCallSettings<ListChannelConnectionsRequest,ListChannelConnectionsResponse,EventarcClient.ListChannelConnectionsPagedResponse> listChannelConnectionsSettings()

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

Returns
Type	Description
`PagedCallSettings<ListChannelConnectionsRequest,ListChannelConnectionsResponse,ListChannelConnectionsPagedResponse>`

listChannelsSettings()

public PagedCallSettings<ListChannelsRequest,ListChannelsResponse,EventarcClient.ListChannelsPagedResponse> listChannelsSettings()

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

Returns
Type	Description
`PagedCallSettings<ListChannelsRequest,ListChannelsResponse,ListChannelsPagedResponse>`

listLocationsSettings()

public PagedCallSettings<ListLocationsRequest,ListLocationsResponse,EventarcClient.ListLocationsPagedResponse> listLocationsSettings()

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

Returns
Type	Description
`PagedCallSettings<com.google.cloud.location.ListLocationsRequest,com.google.cloud.location.ListLocationsResponse,ListLocationsPagedResponse>`

listProvidersSettings()

public PagedCallSettings<ListProvidersRequest,ListProvidersResponse,EventarcClient.ListProvidersPagedResponse> listProvidersSettings()

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

Returns
Type	Description
`PagedCallSettings<ListProvidersRequest,ListProvidersResponse,ListProvidersPagedResponse>`

listTriggersSettings()

public PagedCallSettings<ListTriggersRequest,ListTriggersResponse,EventarcClient.ListTriggersPagedResponse> listTriggersSettings()

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

Returns
Type	Description
`PagedCallSettings<ListTriggersRequest,ListTriggersResponse,ListTriggersPagedResponse>`

setIamPolicySettings()

public UnaryCallSettings<SetIamPolicyRequest,Policy> setIamPolicySettings()

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

Returns
Type	Description
`UnaryCallSettings<com.google.iam.v1.SetIamPolicyRequest,com.google.iam.v1.Policy>`

testIamPermissionsSettings()

public UnaryCallSettings<TestIamPermissionsRequest,TestIamPermissionsResponse> testIamPermissionsSettings()

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

Returns
Type	Description
`UnaryCallSettings<com.google.iam.v1.TestIamPermissionsRequest,com.google.iam.v1.TestIamPermissionsResponse>`

toBuilder()

public EventarcStubSettings.Builder toBuilder()

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

Returns
Type	Description
`EventarcStubSettings.Builder`

Overrides

StubSettings<SettingsT>.toBuilder()

updateChannelOperationSettings()

public OperationCallSettings<UpdateChannelRequest,Channel,OperationMetadata> updateChannelOperationSettings()

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

Returns
Type	Description
`OperationCallSettings<UpdateChannelRequest,Channel,OperationMetadata>`

updateChannelSettings()

public UnaryCallSettings<UpdateChannelRequest,Operation> updateChannelSettings()

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

Returns
Type	Description
`UnaryCallSettings<UpdateChannelRequest,Operation>`

updateGoogleChannelConfigSettings()

public UnaryCallSettings<UpdateGoogleChannelConfigRequest,GoogleChannelConfig> updateGoogleChannelConfigSettings()

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

Returns
Type	Description
`UnaryCallSettings<UpdateGoogleChannelConfigRequest,GoogleChannelConfig>`

updateTriggerOperationSettings()

public OperationCallSettings<UpdateTriggerRequest,Trigger,OperationMetadata> updateTriggerOperationSettings()

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

Returns
Type	Description
`OperationCallSettings<UpdateTriggerRequest,Trigger,OperationMetadata>`

updateTriggerSettings()

public UnaryCallSettings<UpdateTriggerRequest,Operation> updateTriggerSettings()

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

Returns
Type	Description
`UnaryCallSettings<UpdateTriggerRequest,Operation>`