Class StreamsServiceSettings (0.12.0)

public class StreamsServiceSettings extends ClientSettings<StreamsServiceSettings>

Settings class to configure an instance of StreamsServiceClient.

The default instance has everything set to sensible defaults:

The default service address (visionai.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 getCluster:


 // 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
 StreamsServiceSettings.Builder streamsServiceSettingsBuilder =
     StreamsServiceSettings.newBuilder();
 streamsServiceSettingsBuilder
     .getClusterSettings()
     .setRetrySettings(
         streamsServiceSettingsBuilder
             .getClusterSettings()
             .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());
 StreamsServiceSettings streamsServiceSettings = streamsServiceSettingsBuilder.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 createCluster:


 // 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
 StreamsServiceSettings.Builder streamsServiceSettingsBuilder =
     StreamsServiceSettings.newBuilder();
 TimedRetryAlgorithm timedRetryAlgorithm =
     OperationalTimedPollAlgorithm.create(
         RetrySettings.newBuilder()
             .setInitialRetryDelayDuration(Duration.ofMillis(500))
             .setRetryDelayMultiplier(1.5)
             .setMaxRetryDelayDuration(Duration.ofMillis(5000))
             .setTotalTimeoutDuration(Duration.ofHours(24))
             .build());
 streamsServiceSettingsBuilder
     .createClusterOperationSettings()
     .setPollingAlgorithm(timedRetryAlgorithm)
     .build();

Inheritance

java.lang.Object > ClientSettings > StreamsServiceSettings

Inherited Members

ClientSettings.<B>toBuilder()

ClientSettings.getApiKey()

ClientSettings.getBackgroundExecutorProvider()

ClientSettings.getClock()

ClientSettings.getCredentialsProvider()

ClientSettings.getEndpoint()

ClientSettings.getExecutorProvider()

ClientSettings.getGdchApiAudience()

ClientSettings.getHeaderProvider()

ClientSettings.getInternalHeaderProvider()

ClientSettings.getQuotaProjectId()

ClientSettings.getStubSettings()

ClientSettings.getTransportChannelProvider()

ClientSettings.getUniverseDomain()

ClientSettings.getWatchdogCheckInterval()

ClientSettings.getWatchdogCheckIntervalDuration()

ClientSettings.getWatchdogProvider()

ClientSettings.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

create(StreamsServiceStubSettings stub)

public static final StreamsServiceSettings create(StreamsServiceStubSettings stub)

Parameter
Name	Description
`stub`	`StreamsServiceStubSettings`

Returns
Type	Description
`StreamsServiceSettings`

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 gRPC ChannelProvider for this service.

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`

getDefaultServiceScopes()

public static List<String> getDefaultServiceScopes()

Returns the default service scopes.

Returns
Type	Description
`List<String>`

newBuilder()

public static StreamsServiceSettings.Builder newBuilder()

Returns a new gRPC builder for this class.

Returns
Type	Description
`StreamsServiceSettings.Builder`

newBuilder(ClientContext clientContext)

public static StreamsServiceSettings.Builder newBuilder(ClientContext clientContext)

Returns a new builder for this class.

Parameter
Name	Description
`clientContext`	`ClientContext`

Returns
Type	Description
`StreamsServiceSettings.Builder`

newHttpJsonBuilder()

public static StreamsServiceSettings.Builder newHttpJsonBuilder()

Returns a new REST builder for this class.

Returns
Type	Description
`StreamsServiceSettings.Builder`

Constructors

StreamsServiceSettings(StreamsServiceSettings.Builder settingsBuilder)

protected StreamsServiceSettings(StreamsServiceSettings.Builder settingsBuilder)

Parameter
Name	Description
`settingsBuilder`	`StreamsServiceSettings.Builder`

Methods

createClusterOperationSettings()

public OperationCallSettings<CreateClusterRequest,Cluster,OperationMetadata> createClusterOperationSettings()

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

Returns
Type	Description
`OperationCallSettings<CreateClusterRequest,Cluster,OperationMetadata>`

createClusterSettings()

public UnaryCallSettings<CreateClusterRequest,Operation> createClusterSettings()

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

Returns
Type	Description
`UnaryCallSettings<CreateClusterRequest,Operation>`

createEventOperationSettings()

public OperationCallSettings<CreateEventRequest,Event,OperationMetadata> createEventOperationSettings()

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

Returns
Type	Description
`OperationCallSettings<CreateEventRequest,Event,OperationMetadata>`

createEventSettings()

public UnaryCallSettings<CreateEventRequest,Operation> createEventSettings()

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

Returns
Type	Description
`UnaryCallSettings<CreateEventRequest,Operation>`

createSeriesOperationSettings()

public OperationCallSettings<CreateSeriesRequest,Series,OperationMetadata> createSeriesOperationSettings()

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

Returns
Type	Description
`OperationCallSettings<CreateSeriesRequest,Series,OperationMetadata>`

createSeriesSettings()

public UnaryCallSettings<CreateSeriesRequest,Operation> createSeriesSettings()

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

Returns
Type	Description
`UnaryCallSettings<CreateSeriesRequest,Operation>`

createStreamOperationSettings()

public OperationCallSettings<CreateStreamRequest,Stream,OperationMetadata> createStreamOperationSettings()

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

Returns
Type	Description
`OperationCallSettings<CreateStreamRequest,Stream,OperationMetadata>`

createStreamSettings()

public UnaryCallSettings<CreateStreamRequest,Operation> createStreamSettings()

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

Returns
Type	Description
`UnaryCallSettings<CreateStreamRequest,Operation>`

deleteClusterOperationSettings()

public OperationCallSettings<DeleteClusterRequest,Empty,OperationMetadata> deleteClusterOperationSettings()

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

Returns
Type	Description
`OperationCallSettings<DeleteClusterRequest,Empty,OperationMetadata>`

deleteClusterSettings()

public UnaryCallSettings<DeleteClusterRequest,Operation> deleteClusterSettings()

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

Returns
Type	Description
`UnaryCallSettings<DeleteClusterRequest,Operation>`

deleteEventOperationSettings()

public OperationCallSettings<DeleteEventRequest,Empty,OperationMetadata> deleteEventOperationSettings()

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

Returns
Type	Description
`OperationCallSettings<DeleteEventRequest,Empty,OperationMetadata>`

deleteEventSettings()

public UnaryCallSettings<DeleteEventRequest,Operation> deleteEventSettings()

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

Returns
Type	Description
`UnaryCallSettings<DeleteEventRequest,Operation>`

deleteSeriesOperationSettings()

public OperationCallSettings<DeleteSeriesRequest,Empty,OperationMetadata> deleteSeriesOperationSettings()

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

Returns
Type	Description
`OperationCallSettings<DeleteSeriesRequest,Empty,OperationMetadata>`

deleteSeriesSettings()

public UnaryCallSettings<DeleteSeriesRequest,Operation> deleteSeriesSettings()

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

Returns
Type	Description
`UnaryCallSettings<DeleteSeriesRequest,Operation>`

deleteStreamOperationSettings()

public OperationCallSettings<DeleteStreamRequest,Empty,OperationMetadata> deleteStreamOperationSettings()

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

Returns
Type	Description
`OperationCallSettings<DeleteStreamRequest,Empty,OperationMetadata>`

deleteStreamSettings()

public UnaryCallSettings<DeleteStreamRequest,Operation> deleteStreamSettings()

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

Returns
Type	Description
`UnaryCallSettings<DeleteStreamRequest,Operation>`

generateStreamHlsTokenSettings()

public UnaryCallSettings<GenerateStreamHlsTokenRequest,GenerateStreamHlsTokenResponse> generateStreamHlsTokenSettings()

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

Returns
Type	Description
`UnaryCallSettings<GenerateStreamHlsTokenRequest,GenerateStreamHlsTokenResponse>`

getClusterSettings()

public UnaryCallSettings<GetClusterRequest,Cluster> getClusterSettings()

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

Returns
Type	Description
`UnaryCallSettings<GetClusterRequest,Cluster>`

getEventSettings()

public UnaryCallSettings<GetEventRequest,Event> getEventSettings()

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

Returns
Type	Description
`UnaryCallSettings<GetEventRequest,Event>`

getSeriesSettings()

public UnaryCallSettings<GetSeriesRequest,Series> getSeriesSettings()

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

Returns
Type	Description
`UnaryCallSettings<GetSeriesRequest,Series>`

getStreamSettings()

public UnaryCallSettings<GetStreamRequest,Stream> getStreamSettings()

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

Returns
Type	Description
`UnaryCallSettings<GetStreamRequest,Stream>`

getStreamThumbnailOperationSettings()

public OperationCallSettings<GetStreamThumbnailRequest,GetStreamThumbnailResponse,OperationMetadata> getStreamThumbnailOperationSettings()

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

Returns
Type	Description
`OperationCallSettings<GetStreamThumbnailRequest,GetStreamThumbnailResponse,OperationMetadata>`

getStreamThumbnailSettings()

public UnaryCallSettings<GetStreamThumbnailRequest,Operation> getStreamThumbnailSettings()

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

Returns
Type	Description
`UnaryCallSettings<GetStreamThumbnailRequest,Operation>`

listClustersSettings()

public PagedCallSettings<ListClustersRequest,ListClustersResponse,StreamsServiceClient.ListClustersPagedResponse> listClustersSettings()

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

Returns
Type	Description
`PagedCallSettings<ListClustersRequest,ListClustersResponse,ListClustersPagedResponse>`

listEventsSettings()

public PagedCallSettings<ListEventsRequest,ListEventsResponse,StreamsServiceClient.ListEventsPagedResponse> listEventsSettings()

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

Returns
Type	Description
`PagedCallSettings<ListEventsRequest,ListEventsResponse,ListEventsPagedResponse>`

listSeriesSettings()

public PagedCallSettings<ListSeriesRequest,ListSeriesResponse,StreamsServiceClient.ListSeriesPagedResponse> listSeriesSettings()

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

Returns
Type	Description
`PagedCallSettings<ListSeriesRequest,ListSeriesResponse,ListSeriesPagedResponse>`

listStreamsSettings()

public PagedCallSettings<ListStreamsRequest,ListStreamsResponse,StreamsServiceClient.ListStreamsPagedResponse> listStreamsSettings()

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

Returns
Type	Description
`PagedCallSettings<ListStreamsRequest,ListStreamsResponse,ListStreamsPagedResponse>`

materializeChannelOperationSettings()

public OperationCallSettings<MaterializeChannelRequest,Channel,OperationMetadata> materializeChannelOperationSettings()

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

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

materializeChannelSettings()

public UnaryCallSettings<MaterializeChannelRequest,Operation> materializeChannelSettings()

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

Returns
Type	Description
`UnaryCallSettings<MaterializeChannelRequest,Operation>`

toBuilder()

public StreamsServiceSettings.Builder toBuilder()

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

Returns
Type	Description
`StreamsServiceSettings.Builder`

Overrides

ClientSettings<SettingsT>.<B>toBuilder()

updateClusterOperationSettings()

public OperationCallSettings<UpdateClusterRequest,Cluster,OperationMetadata> updateClusterOperationSettings()

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

Returns
Type	Description
`OperationCallSettings<UpdateClusterRequest,Cluster,OperationMetadata>`

updateClusterSettings()

public UnaryCallSettings<UpdateClusterRequest,Operation> updateClusterSettings()

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

Returns
Type	Description
`UnaryCallSettings<UpdateClusterRequest,Operation>`

updateEventOperationSettings()

public OperationCallSettings<UpdateEventRequest,Event,OperationMetadata> updateEventOperationSettings()

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

Returns
Type	Description
`OperationCallSettings<UpdateEventRequest,Event,OperationMetadata>`

updateEventSettings()

public UnaryCallSettings<UpdateEventRequest,Operation> updateEventSettings()

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

Returns
Type	Description
`UnaryCallSettings<UpdateEventRequest,Operation>`

updateSeriesOperationSettings()

public OperationCallSettings<UpdateSeriesRequest,Series,OperationMetadata> updateSeriesOperationSettings()

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

Returns
Type	Description
`OperationCallSettings<UpdateSeriesRequest,Series,OperationMetadata>`

updateSeriesSettings()

public UnaryCallSettings<UpdateSeriesRequest,Operation> updateSeriesSettings()

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

Returns
Type	Description
`UnaryCallSettings<UpdateSeriesRequest,Operation>`

updateStreamOperationSettings()

public OperationCallSettings<UpdateStreamRequest,Stream,OperationMetadata> updateStreamOperationSettings()

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

Returns
Type	Description
`OperationCallSettings<UpdateStreamRequest,Stream,OperationMetadata>`

updateStreamSettings()

public UnaryCallSettings<UpdateStreamRequest,Operation> updateStreamSettings()

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

Returns
Type	Description
`UnaryCallSettings<UpdateStreamRequest,Operation>`