Class EventarcSettings (1.2.4)

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


 EventarcSettings.Builder eventarcSettingsBuilder = EventarcSettings.newBuilder();
 eventarcSettingsBuilder
     .getTriggerSettings()
     .setRetrySettings(
         eventarcSettingsBuilder
             .getTriggerSettings()
             .getRetrySettings()
             .toBuilder()
             .setTotalTimeout(Duration.ofSeconds(30))
             .build());
 EventarcSettings eventarcSettings = eventarcSettingsBuilder.build();
 

Inheritance

java.lang.Object > ClientSettings > EventarcSettings

Static Methods

create(EventarcStubSettings stub)

public static final EventarcSettings create(EventarcStubSettings stub)
Parameter
NameDescription
stubEventarcStubSettings
Returns
TypeDescription
EventarcSettings
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 EventarcSettings.Builder newBuilder()

Returns a new builder for this class.

Returns
TypeDescription
EventarcSettings.Builder

newBuilder(ClientContext clientContext)

public static EventarcSettings.Builder newBuilder(ClientContext clientContext)

Returns a new builder for this class.

Parameter
NameDescription
clientContextClientContext
Returns
TypeDescription
EventarcSettings.Builder

Constructors

EventarcSettings(EventarcSettings.Builder settingsBuilder)

protected EventarcSettings(EventarcSettings.Builder settingsBuilder)
Parameter
NameDescription
settingsBuilderEventarcSettings.Builder

Methods

createChannelConnectionOperationSettings()

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

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

Returns
TypeDescription
OperationCallSettings<CreateChannelConnectionRequest,ChannelConnection,OperationMetadata>

createChannelConnectionSettings()

public UnaryCallSettings<CreateChannelConnectionRequest,Operation> createChannelConnectionSettings()

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

Returns
TypeDescription
UnaryCallSettings<CreateChannelConnectionRequest,Operation>

createChannelOperationSettings()

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

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

Returns
TypeDescription
OperationCallSettings<CreateChannelRequest,Channel,OperationMetadata>

createChannelSettings()

public UnaryCallSettings<CreateChannelRequest,Operation> createChannelSettings()

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

Returns
TypeDescription
UnaryCallSettings<CreateChannelRequest,Operation>

createTriggerOperationSettings()

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

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

Returns
TypeDescription
OperationCallSettings<CreateTriggerRequest,Trigger,OperationMetadata>

createTriggerSettings()

public UnaryCallSettings<CreateTriggerRequest,Operation> createTriggerSettings()

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

Returns
TypeDescription
UnaryCallSettings<CreateTriggerRequest,Operation>

deleteChannelConnectionOperationSettings()

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

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

Returns
TypeDescription
OperationCallSettings<DeleteChannelConnectionRequest,ChannelConnection,OperationMetadata>

deleteChannelConnectionSettings()

public UnaryCallSettings<DeleteChannelConnectionRequest,Operation> deleteChannelConnectionSettings()

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

Returns
TypeDescription
UnaryCallSettings<DeleteChannelConnectionRequest,Operation>

deleteChannelOperationSettings()

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

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

Returns
TypeDescription
OperationCallSettings<DeleteChannelRequest,Channel,OperationMetadata>

deleteChannelSettings()

public UnaryCallSettings<DeleteChannelRequest,Operation> deleteChannelSettings()

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

Returns
TypeDescription
UnaryCallSettings<DeleteChannelRequest,Operation>

deleteTriggerOperationSettings()

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

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

Returns
TypeDescription
OperationCallSettings<DeleteTriggerRequest,Trigger,OperationMetadata>

deleteTriggerSettings()

public UnaryCallSettings<DeleteTriggerRequest,Operation> deleteTriggerSettings()

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

Returns
TypeDescription
UnaryCallSettings<DeleteTriggerRequest,Operation>

getChannelConnectionSettings()

public UnaryCallSettings<GetChannelConnectionRequest,ChannelConnection> getChannelConnectionSettings()

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

Returns
TypeDescription
UnaryCallSettings<GetChannelConnectionRequest,ChannelConnection>

getChannelSettings()

public UnaryCallSettings<GetChannelRequest,Channel> getChannelSettings()

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

Returns
TypeDescription
UnaryCallSettings<GetChannelRequest,Channel>

getTriggerSettings()

public UnaryCallSettings<GetTriggerRequest,Trigger> getTriggerSettings()

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

Returns
TypeDescription
UnaryCallSettings<GetTriggerRequest,Trigger>

listChannelConnectionsSettings()

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

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

Returns
TypeDescription
PagedCallSettings<ListChannelConnectionsRequest,ListChannelConnectionsResponse,ListChannelConnectionsPagedResponse>

listChannelsSettings()

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

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

Returns
TypeDescription
PagedCallSettings<ListChannelsRequest,ListChannelsResponse,ListChannelsPagedResponse>

listTriggersSettings()

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

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

Returns
TypeDescription
PagedCallSettings<ListTriggersRequest,ListTriggersResponse,ListTriggersPagedResponse>

toBuilder()

public EventarcSettings.Builder toBuilder()

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

Returns
TypeDescription
EventarcSettings.Builder
Overrides

updateChannelOperationSettings()

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

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

Returns
TypeDescription
OperationCallSettings<UpdateChannelRequest,Channel,OperationMetadata>

updateChannelSettings()

public UnaryCallSettings<UpdateChannelRequest,Operation> updateChannelSettings()

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

Returns
TypeDescription
UnaryCallSettings<UpdateChannelRequest,Operation>

updateTriggerOperationSettings()

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

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

Returns
TypeDescription
OperationCallSettings<UpdateTriggerRequest,Trigger,OperationMetadata>

updateTriggerSettings()

public UnaryCallSettings<UpdateTriggerRequest,Operation> updateTriggerSettings()

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

Returns
TypeDescription
UnaryCallSettings<UpdateTriggerRequest,Operation>