com.google.cloud.visionai.v1

Class StreamsServiceSettings

java.lang.Object

com.google.api.gax.rpc.ClientSettings<StreamsServiceSettings>

com.google.cloud.visionai.v1.StreamsServiceSettings

@Generated(value="by gapic-generator-java")
public class StreamsServiceSettings
extends com.google.api.gax.rpc.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](https://cloud.google.com/java/docs/reference/gax/latest/com.google.api.gax.retrying.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](https://github.com/googleapis/google-cloud-java/blob/main/docs/client_retries.md) 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();
 

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	StreamsServiceSettings.Builder Builder for StreamsServiceSettings.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	StreamsServiceSettings(StreamsServiceSettings.Builder settingsBuilder)

Method Summary

Modifier and Type	Method and Description
static StreamsServiceSettings	create(StreamsServiceStubSettings stub)
com.google.api.gax.rpc.OperationCallSettings<CreateClusterRequest,Cluster,OperationMetadata>	createClusterOperationSettings() Returns the object with the settings used for calls to createCluster.
com.google.api.gax.rpc.UnaryCallSettings<CreateClusterRequest,com.google.longrunning.Operation>	createClusterSettings() Returns the object with the settings used for calls to createCluster.
com.google.api.gax.rpc.OperationCallSettings<CreateEventRequest,Event,OperationMetadata>	createEventOperationSettings() Returns the object with the settings used for calls to createEvent.
com.google.api.gax.rpc.UnaryCallSettings<CreateEventRequest,com.google.longrunning.Operation>	createEventSettings() Returns the object with the settings used for calls to createEvent.
com.google.api.gax.rpc.OperationCallSettings<CreateSeriesRequest,Series,OperationMetadata>	createSeriesOperationSettings() Returns the object with the settings used for calls to createSeries.
com.google.api.gax.rpc.UnaryCallSettings<CreateSeriesRequest,com.google.longrunning.Operation>	createSeriesSettings() Returns the object with the settings used for calls to createSeries.
com.google.api.gax.rpc.OperationCallSettings<CreateStreamRequest,Stream,OperationMetadata>	createStreamOperationSettings() Returns the object with the settings used for calls to createStream.
com.google.api.gax.rpc.UnaryCallSettings<CreateStreamRequest,com.google.longrunning.Operation>	createStreamSettings() Returns the object with the settings used for calls to createStream.
static com.google.api.gax.rpc.ApiClientHeaderProvider.Builder	defaultApiClientHeaderProviderBuilder()
static com.google.api.gax.core.GoogleCredentialsProvider.Builder	defaultCredentialsProviderBuilder() Returns a builder for the default credentials for this service.
static com.google.api.gax.core.InstantiatingExecutorProvider.Builder	defaultExecutorProviderBuilder() Returns a builder for the default ExecutorProvider for this service.
static com.google.api.gax.grpc.InstantiatingGrpcChannelProvider.Builder	defaultGrpcTransportProviderBuilder() Returns a builder for the default gRPC ChannelProvider for this service.
static com.google.api.gax.httpjson.InstantiatingHttpJsonChannelProvider.Builder	defaultHttpJsonTransportProviderBuilder() Returns a builder for the default REST ChannelProvider for this service.
static com.google.api.gax.rpc.TransportChannelProvider	defaultTransportChannelProvider()
com.google.api.gax.rpc.OperationCallSettings<DeleteClusterRequest,com.google.protobuf.Empty,OperationMetadata>	deleteClusterOperationSettings() Returns the object with the settings used for calls to deleteCluster.
com.google.api.gax.rpc.UnaryCallSettings<DeleteClusterRequest,com.google.longrunning.Operation>	deleteClusterSettings() Returns the object with the settings used for calls to deleteCluster.
com.google.api.gax.rpc.OperationCallSettings<DeleteEventRequest,com.google.protobuf.Empty,OperationMetadata>	deleteEventOperationSettings() Returns the object with the settings used for calls to deleteEvent.
com.google.api.gax.rpc.UnaryCallSettings<DeleteEventRequest,com.google.longrunning.Operation>	deleteEventSettings() Returns the object with the settings used for calls to deleteEvent.
com.google.api.gax.rpc.OperationCallSettings<DeleteSeriesRequest,com.google.protobuf.Empty,OperationMetadata>	deleteSeriesOperationSettings() Returns the object with the settings used for calls to deleteSeries.
com.google.api.gax.rpc.UnaryCallSettings<DeleteSeriesRequest,com.google.longrunning.Operation>	deleteSeriesSettings() Returns the object with the settings used for calls to deleteSeries.
com.google.api.gax.rpc.OperationCallSettings<DeleteStreamRequest,com.google.protobuf.Empty,OperationMetadata>	deleteStreamOperationSettings() Returns the object with the settings used for calls to deleteStream.
com.google.api.gax.rpc.UnaryCallSettings<DeleteStreamRequest,com.google.longrunning.Operation>	deleteStreamSettings() Returns the object with the settings used for calls to deleteStream.
com.google.api.gax.rpc.UnaryCallSettings<GenerateStreamHlsTokenRequest,GenerateStreamHlsTokenResponse>	generateStreamHlsTokenSettings() Returns the object with the settings used for calls to generateStreamHlsToken.
com.google.api.gax.rpc.UnaryCallSettings<GetClusterRequest,Cluster>	getClusterSettings() Returns the object with the settings used for calls to getCluster.
static String	getDefaultEndpoint() Returns the default service endpoint.
static List<String>	getDefaultServiceScopes() Returns the default service scopes.
com.google.api.gax.rpc.UnaryCallSettings<GetEventRequest,Event>	getEventSettings() Returns the object with the settings used for calls to getEvent.
com.google.api.gax.rpc.UnaryCallSettings<GetSeriesRequest,Series>	getSeriesSettings() Returns the object with the settings used for calls to getSeries.
com.google.api.gax.rpc.UnaryCallSettings<GetStreamRequest,Stream>	getStreamSettings() Returns the object with the settings used for calls to getStream.
com.google.api.gax.rpc.OperationCallSettings<GetStreamThumbnailRequest,GetStreamThumbnailResponse,OperationMetadata>	getStreamThumbnailOperationSettings() Returns the object with the settings used for calls to getStreamThumbnail.
com.google.api.gax.rpc.UnaryCallSettings<GetStreamThumbnailRequest,com.google.longrunning.Operation>	getStreamThumbnailSettings() Returns the object with the settings used for calls to getStreamThumbnail.
com.google.api.gax.rpc.PagedCallSettings<ListClustersRequest,ListClustersResponse,StreamsServiceClient.ListClustersPagedResponse>	listClustersSettings() Returns the object with the settings used for calls to listClusters.
com.google.api.gax.rpc.PagedCallSettings<ListEventsRequest,ListEventsResponse,StreamsServiceClient.ListEventsPagedResponse>	listEventsSettings() Returns the object with the settings used for calls to listEvents.
com.google.api.gax.rpc.PagedCallSettings<ListSeriesRequest,ListSeriesResponse,StreamsServiceClient.ListSeriesPagedResponse>	listSeriesSettings() Returns the object with the settings used for calls to listSeries.
com.google.api.gax.rpc.PagedCallSettings<ListStreamsRequest,ListStreamsResponse,StreamsServiceClient.ListStreamsPagedResponse>	listStreamsSettings() Returns the object with the settings used for calls to listStreams.
com.google.api.gax.rpc.OperationCallSettings<MaterializeChannelRequest,Channel,OperationMetadata>	materializeChannelOperationSettings() Returns the object with the settings used for calls to materializeChannel.
com.google.api.gax.rpc.UnaryCallSettings<MaterializeChannelRequest,com.google.longrunning.Operation>	materializeChannelSettings() Returns the object with the settings used for calls to materializeChannel.
static StreamsServiceSettings.Builder	newBuilder() Returns a new gRPC builder for this class.
static StreamsServiceSettings.Builder	newBuilder(com.google.api.gax.rpc.ClientContext clientContext) Returns a new builder for this class.
static StreamsServiceSettings.Builder	newHttpJsonBuilder() Returns a new REST builder for this class.
StreamsServiceSettings.Builder	toBuilder() Returns a builder containing all the values of this settings class.
com.google.api.gax.rpc.OperationCallSettings<UpdateClusterRequest,Cluster,OperationMetadata>	updateClusterOperationSettings() Returns the object with the settings used for calls to updateCluster.
com.google.api.gax.rpc.UnaryCallSettings<UpdateClusterRequest,com.google.longrunning.Operation>	updateClusterSettings() Returns the object with the settings used for calls to updateCluster.
com.google.api.gax.rpc.OperationCallSettings<UpdateEventRequest,Event,OperationMetadata>	updateEventOperationSettings() Returns the object with the settings used for calls to updateEvent.
com.google.api.gax.rpc.UnaryCallSettings<UpdateEventRequest,com.google.longrunning.Operation>	updateEventSettings() Returns the object with the settings used for calls to updateEvent.
com.google.api.gax.rpc.OperationCallSettings<UpdateSeriesRequest,Series,OperationMetadata>	updateSeriesOperationSettings() Returns the object with the settings used for calls to updateSeries.
com.google.api.gax.rpc.UnaryCallSettings<UpdateSeriesRequest,com.google.longrunning.Operation>	updateSeriesSettings() Returns the object with the settings used for calls to updateSeries.
com.google.api.gax.rpc.OperationCallSettings<UpdateStreamRequest,Stream,OperationMetadata>	updateStreamOperationSettings() Returns the object with the settings used for calls to updateStream.
com.google.api.gax.rpc.UnaryCallSettings<UpdateStreamRequest,com.google.longrunning.Operation>	updateStreamSettings() Returns the object with the settings used for calls to updateStream.

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

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

StreamsServiceSettings

protected StreamsServiceSettings(StreamsServiceSettings.Builder settingsBuilder)
                          throws IOException

Throws:

IOException

Method Detail

listClustersSettings

public com.google.api.gax.rpc.PagedCallSettings<ListClustersRequest,ListClustersResponse,StreamsServiceClient.ListClustersPagedResponse> listClustersSettings()

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

getClusterSettings

public com.google.api.gax.rpc.UnaryCallSettings<GetClusterRequest,Cluster> getClusterSettings()

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

createClusterSettings

public com.google.api.gax.rpc.UnaryCallSettings<CreateClusterRequest,com.google.longrunning.Operation> createClusterSettings()

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

createClusterOperationSettings

public com.google.api.gax.rpc.OperationCallSettings<CreateClusterRequest,Cluster,OperationMetadata> createClusterOperationSettings()

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

updateClusterSettings

public com.google.api.gax.rpc.UnaryCallSettings<UpdateClusterRequest,com.google.longrunning.Operation> updateClusterSettings()

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

updateClusterOperationSettings

public com.google.api.gax.rpc.OperationCallSettings<UpdateClusterRequest,Cluster,OperationMetadata> updateClusterOperationSettings()

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

deleteClusterSettings

public com.google.api.gax.rpc.UnaryCallSettings<DeleteClusterRequest,com.google.longrunning.Operation> deleteClusterSettings()

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

deleteClusterOperationSettings

public com.google.api.gax.rpc.OperationCallSettings<DeleteClusterRequest,com.google.protobuf.Empty,OperationMetadata> deleteClusterOperationSettings()

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

listStreamsSettings

public com.google.api.gax.rpc.PagedCallSettings<ListStreamsRequest,ListStreamsResponse,StreamsServiceClient.ListStreamsPagedResponse> listStreamsSettings()

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

getStreamSettings

public com.google.api.gax.rpc.UnaryCallSettings<GetStreamRequest,Stream> getStreamSettings()

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

createStreamSettings

public com.google.api.gax.rpc.UnaryCallSettings<CreateStreamRequest,com.google.longrunning.Operation> createStreamSettings()

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

createStreamOperationSettings

public com.google.api.gax.rpc.OperationCallSettings<CreateStreamRequest,Stream,OperationMetadata> createStreamOperationSettings()

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

updateStreamSettings

public com.google.api.gax.rpc.UnaryCallSettings<UpdateStreamRequest,com.google.longrunning.Operation> updateStreamSettings()

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

updateStreamOperationSettings

public com.google.api.gax.rpc.OperationCallSettings<UpdateStreamRequest,Stream,OperationMetadata> updateStreamOperationSettings()

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

deleteStreamSettings

public com.google.api.gax.rpc.UnaryCallSettings<DeleteStreamRequest,com.google.longrunning.Operation> deleteStreamSettings()

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

deleteStreamOperationSettings

public com.google.api.gax.rpc.OperationCallSettings<DeleteStreamRequest,com.google.protobuf.Empty,OperationMetadata> deleteStreamOperationSettings()

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

getStreamThumbnailSettings

public com.google.api.gax.rpc.UnaryCallSettings<GetStreamThumbnailRequest,com.google.longrunning.Operation> getStreamThumbnailSettings()

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

getStreamThumbnailOperationSettings

public com.google.api.gax.rpc.OperationCallSettings<GetStreamThumbnailRequest,GetStreamThumbnailResponse,OperationMetadata> getStreamThumbnailOperationSettings()

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

generateStreamHlsTokenSettings

public com.google.api.gax.rpc.UnaryCallSettings<GenerateStreamHlsTokenRequest,GenerateStreamHlsTokenResponse> generateStreamHlsTokenSettings()

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

listEventsSettings

public com.google.api.gax.rpc.PagedCallSettings<ListEventsRequest,ListEventsResponse,StreamsServiceClient.ListEventsPagedResponse> listEventsSettings()

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

getEventSettings

public com.google.api.gax.rpc.UnaryCallSettings<GetEventRequest,Event> getEventSettings()

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

createEventSettings

public com.google.api.gax.rpc.UnaryCallSettings<CreateEventRequest,com.google.longrunning.Operation> createEventSettings()

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

createEventOperationSettings

public com.google.api.gax.rpc.OperationCallSettings<CreateEventRequest,Event,OperationMetadata> createEventOperationSettings()

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

updateEventSettings

public com.google.api.gax.rpc.UnaryCallSettings<UpdateEventRequest,com.google.longrunning.Operation> updateEventSettings()

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

updateEventOperationSettings

public com.google.api.gax.rpc.OperationCallSettings<UpdateEventRequest,Event,OperationMetadata> updateEventOperationSettings()

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

deleteEventSettings

public com.google.api.gax.rpc.UnaryCallSettings<DeleteEventRequest,com.google.longrunning.Operation> deleteEventSettings()

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

deleteEventOperationSettings

public com.google.api.gax.rpc.OperationCallSettings<DeleteEventRequest,com.google.protobuf.Empty,OperationMetadata> deleteEventOperationSettings()

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

listSeriesSettings

public com.google.api.gax.rpc.PagedCallSettings<ListSeriesRequest,ListSeriesResponse,StreamsServiceClient.ListSeriesPagedResponse> listSeriesSettings()

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

getSeriesSettings

public com.google.api.gax.rpc.UnaryCallSettings<GetSeriesRequest,Series> getSeriesSettings()

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

createSeriesSettings

public com.google.api.gax.rpc.UnaryCallSettings<CreateSeriesRequest,com.google.longrunning.Operation> createSeriesSettings()

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

createSeriesOperationSettings

public com.google.api.gax.rpc.OperationCallSettings<CreateSeriesRequest,Series,OperationMetadata> createSeriesOperationSettings()

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

updateSeriesSettings

public com.google.api.gax.rpc.UnaryCallSettings<UpdateSeriesRequest,com.google.longrunning.Operation> updateSeriesSettings()

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

updateSeriesOperationSettings

public com.google.api.gax.rpc.OperationCallSettings<UpdateSeriesRequest,Series,OperationMetadata> updateSeriesOperationSettings()

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

deleteSeriesSettings

public com.google.api.gax.rpc.UnaryCallSettings<DeleteSeriesRequest,com.google.longrunning.Operation> deleteSeriesSettings()

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

deleteSeriesOperationSettings

public com.google.api.gax.rpc.OperationCallSettings<DeleteSeriesRequest,com.google.protobuf.Empty,OperationMetadata> deleteSeriesOperationSettings()

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

materializeChannelSettings

public com.google.api.gax.rpc.UnaryCallSettings<MaterializeChannelRequest,com.google.longrunning.Operation> materializeChannelSettings()

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

materializeChannelOperationSettings

public com.google.api.gax.rpc.OperationCallSettings<MaterializeChannelRequest,Channel,OperationMetadata> materializeChannelOperationSettings()

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

create

public static final StreamsServiceSettings create(StreamsServiceStubSettings stub)
                                           throws IOException

Throws:

IOException

defaultExecutorProviderBuilder

public static com.google.api.gax.core.InstantiatingExecutorProvider.Builder defaultExecutorProviderBuilder()

Returns a builder for the default ExecutorProvider for this service.

getDefaultEndpoint

public static String getDefaultEndpoint()

Returns the default service endpoint.

getDefaultServiceScopes

public static List<String> getDefaultServiceScopes()

Returns the default service scopes.

defaultCredentialsProviderBuilder

public static com.google.api.gax.core.GoogleCredentialsProvider.Builder defaultCredentialsProviderBuilder()

Returns a builder for the default credentials for this service.

defaultGrpcTransportProviderBuilder

public static com.google.api.gax.grpc.InstantiatingGrpcChannelProvider.Builder defaultGrpcTransportProviderBuilder()

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

defaultHttpJsonTransportProviderBuilder

@BetaApi
public static com.google.api.gax.httpjson.InstantiatingHttpJsonChannelProvider.Builder defaultHttpJsonTransportProviderBuilder()

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

defaultTransportChannelProvider

public static com.google.api.gax.rpc.TransportChannelProvider defaultTransportChannelProvider()

defaultApiClientHeaderProviderBuilder

public static com.google.api.gax.rpc.ApiClientHeaderProvider.Builder defaultApiClientHeaderProviderBuilder()

newBuilder

public static StreamsServiceSettings.Builder newBuilder()

Returns a new gRPC builder for this class.

newHttpJsonBuilder

public static StreamsServiceSettings.Builder newHttpJsonBuilder()

Returns a new REST builder for this class.

newBuilder

public static StreamsServiceSettings.Builder newBuilder(com.google.api.gax.rpc.ClientContext clientContext)

Returns a new builder for this class.

toBuilder

public StreamsServiceSettings.Builder toBuilder()

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

Specified by:

toBuilder in class com.google.api.gax.rpc.ClientSettings<StreamsServiceSettings>