com.google.cloud.visionai.v1

Class LiveVideoAnalyticsSettings

java.lang.Object

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

com.google.cloud.visionai.v1.LiveVideoAnalyticsSettings

@Generated(value="by gapic-generator-java")
public class LiveVideoAnalyticsSettings
extends com.google.api.gax.rpc.ClientSettings<LiveVideoAnalyticsSettings>

Settings class to configure an instance of LiveVideoAnalyticsClient.

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 resolveOperatorInfo:

 // 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
 LiveVideoAnalyticsSettings.Builder liveVideoAnalyticsSettingsBuilder =
     LiveVideoAnalyticsSettings.newBuilder();
 liveVideoAnalyticsSettingsBuilder
     .resolveOperatorInfoSettings()
     .setRetrySettings(
         liveVideoAnalyticsSettingsBuilder
             .resolveOperatorInfoSettings()
             .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());
 LiveVideoAnalyticsSettings liveVideoAnalyticsSettings =
     liveVideoAnalyticsSettingsBuilder.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 createOperator:

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

Nested Class Summary

Nested Classes

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

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
com.google.api.gax.rpc.OperationCallSettings<BatchRunProcessRequest,BatchRunProcessResponse,OperationMetadata>	batchRunProcessOperationSettings() Returns the object with the settings used for calls to batchRunProcess.
com.google.api.gax.rpc.UnaryCallSettings<BatchRunProcessRequest,com.google.longrunning.Operation>	batchRunProcessSettings() Returns the object with the settings used for calls to batchRunProcess.
static LiveVideoAnalyticsSettings	create(LiveVideoAnalyticsStubSettings stub)
com.google.api.gax.rpc.OperationCallSettings<CreateAnalysisRequest,Analysis,OperationMetadata>	createAnalysisOperationSettings() Returns the object with the settings used for calls to createAnalysis.
com.google.api.gax.rpc.UnaryCallSettings<CreateAnalysisRequest,com.google.longrunning.Operation>	createAnalysisSettings() Returns the object with the settings used for calls to createAnalysis.
com.google.api.gax.rpc.OperationCallSettings<CreateOperatorRequest,Operator,OperationMetadata>	createOperatorOperationSettings() Returns the object with the settings used for calls to createOperator.
com.google.api.gax.rpc.UnaryCallSettings<CreateOperatorRequest,com.google.longrunning.Operation>	createOperatorSettings() Returns the object with the settings used for calls to createOperator.
com.google.api.gax.rpc.OperationCallSettings<CreateProcessRequest,Process,OperationMetadata>	createProcessOperationSettings() Returns the object with the settings used for calls to createProcess.
com.google.api.gax.rpc.UnaryCallSettings<CreateProcessRequest,com.google.longrunning.Operation>	createProcessSettings() Returns the object with the settings used for calls to createProcess.
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<DeleteAnalysisRequest,com.google.protobuf.Empty,OperationMetadata>	deleteAnalysisOperationSettings() Returns the object with the settings used for calls to deleteAnalysis.
com.google.api.gax.rpc.UnaryCallSettings<DeleteAnalysisRequest,com.google.longrunning.Operation>	deleteAnalysisSettings() Returns the object with the settings used for calls to deleteAnalysis.
com.google.api.gax.rpc.OperationCallSettings<DeleteOperatorRequest,com.google.protobuf.Empty,OperationMetadata>	deleteOperatorOperationSettings() Returns the object with the settings used for calls to deleteOperator.
com.google.api.gax.rpc.UnaryCallSettings<DeleteOperatorRequest,com.google.longrunning.Operation>	deleteOperatorSettings() Returns the object with the settings used for calls to deleteOperator.
com.google.api.gax.rpc.OperationCallSettings<DeleteProcessRequest,com.google.protobuf.Empty,OperationMetadata>	deleteProcessOperationSettings() Returns the object with the settings used for calls to deleteProcess.
com.google.api.gax.rpc.UnaryCallSettings<DeleteProcessRequest,com.google.longrunning.Operation>	deleteProcessSettings() Returns the object with the settings used for calls to deleteProcess.
com.google.api.gax.rpc.UnaryCallSettings<GetAnalysisRequest,Analysis>	getAnalysisSettings() Returns the object with the settings used for calls to getAnalysis.
static String	getDefaultEndpoint() Returns the default service endpoint.
static List<String>	getDefaultServiceScopes() Returns the default service scopes.
com.google.api.gax.rpc.UnaryCallSettings<GetOperatorRequest,Operator>	getOperatorSettings() Returns the object with the settings used for calls to getOperator.
com.google.api.gax.rpc.UnaryCallSettings<GetProcessRequest,Process>	getProcessSettings() Returns the object with the settings used for calls to getProcess.
com.google.api.gax.rpc.PagedCallSettings<ListAnalysesRequest,ListAnalysesResponse,LiveVideoAnalyticsClient.ListAnalysesPagedResponse>	listAnalysesSettings() Returns the object with the settings used for calls to listAnalyses.
com.google.api.gax.rpc.PagedCallSettings<ListOperatorsRequest,ListOperatorsResponse,LiveVideoAnalyticsClient.ListOperatorsPagedResponse>	listOperatorsSettings() Returns the object with the settings used for calls to listOperators.
com.google.api.gax.rpc.PagedCallSettings<ListProcessesRequest,ListProcessesResponse,LiveVideoAnalyticsClient.ListProcessesPagedResponse>	listProcessesSettings() Returns the object with the settings used for calls to listProcesses.
com.google.api.gax.rpc.PagedCallSettings<ListPublicOperatorsRequest,ListPublicOperatorsResponse,LiveVideoAnalyticsClient.ListPublicOperatorsPagedResponse>	listPublicOperatorsSettings() Returns the object with the settings used for calls to listPublicOperators.
static LiveVideoAnalyticsSettings.Builder	newBuilder() Returns a new gRPC builder for this class.
static LiveVideoAnalyticsSettings.Builder	newBuilder(com.google.api.gax.rpc.ClientContext clientContext) Returns a new builder for this class.
static LiveVideoAnalyticsSettings.Builder	newHttpJsonBuilder() Returns a new REST builder for this class.
com.google.api.gax.rpc.UnaryCallSettings<ResolveOperatorInfoRequest,ResolveOperatorInfoResponse>	resolveOperatorInfoSettings() Returns the object with the settings used for calls to resolveOperatorInfo.
LiveVideoAnalyticsSettings.Builder	toBuilder() Returns a builder containing all the values of this settings class.
com.google.api.gax.rpc.OperationCallSettings<UpdateAnalysisRequest,Analysis,OperationMetadata>	updateAnalysisOperationSettings() Returns the object with the settings used for calls to updateAnalysis.
com.google.api.gax.rpc.UnaryCallSettings<UpdateAnalysisRequest,com.google.longrunning.Operation>	updateAnalysisSettings() Returns the object with the settings used for calls to updateAnalysis.
com.google.api.gax.rpc.OperationCallSettings<UpdateOperatorRequest,Operator,OperationMetadata>	updateOperatorOperationSettings() Returns the object with the settings used for calls to updateOperator.
com.google.api.gax.rpc.UnaryCallSettings<UpdateOperatorRequest,com.google.longrunning.Operation>	updateOperatorSettings() Returns the object with the settings used for calls to updateOperator.
com.google.api.gax.rpc.OperationCallSettings<UpdateProcessRequest,Process,OperationMetadata>	updateProcessOperationSettings() Returns the object with the settings used for calls to updateProcess.
com.google.api.gax.rpc.UnaryCallSettings<UpdateProcessRequest,com.google.longrunning.Operation>	updateProcessSettings() Returns the object with the settings used for calls to updateProcess.

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

LiveVideoAnalyticsSettings

protected LiveVideoAnalyticsSettings(LiveVideoAnalyticsSettings.Builder settingsBuilder)
                              throws IOException

Throws:

IOException

Method Detail

listPublicOperatorsSettings

public com.google.api.gax.rpc.PagedCallSettings<ListPublicOperatorsRequest,ListPublicOperatorsResponse,LiveVideoAnalyticsClient.ListPublicOperatorsPagedResponse> listPublicOperatorsSettings()

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

resolveOperatorInfoSettings

public com.google.api.gax.rpc.UnaryCallSettings<ResolveOperatorInfoRequest,ResolveOperatorInfoResponse> resolveOperatorInfoSettings()

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

listOperatorsSettings

public com.google.api.gax.rpc.PagedCallSettings<ListOperatorsRequest,ListOperatorsResponse,LiveVideoAnalyticsClient.ListOperatorsPagedResponse> listOperatorsSettings()

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

getOperatorSettings

public com.google.api.gax.rpc.UnaryCallSettings<GetOperatorRequest,Operator> getOperatorSettings()

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

createOperatorSettings

public com.google.api.gax.rpc.UnaryCallSettings<CreateOperatorRequest,com.google.longrunning.Operation> createOperatorSettings()

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

createOperatorOperationSettings

public com.google.api.gax.rpc.OperationCallSettings<CreateOperatorRequest,Operator,OperationMetadata> createOperatorOperationSettings()

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

updateOperatorSettings

public com.google.api.gax.rpc.UnaryCallSettings<UpdateOperatorRequest,com.google.longrunning.Operation> updateOperatorSettings()

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

updateOperatorOperationSettings

public com.google.api.gax.rpc.OperationCallSettings<UpdateOperatorRequest,Operator,OperationMetadata> updateOperatorOperationSettings()

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

deleteOperatorSettings

public com.google.api.gax.rpc.UnaryCallSettings<DeleteOperatorRequest,com.google.longrunning.Operation> deleteOperatorSettings()

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

deleteOperatorOperationSettings

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

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

listAnalysesSettings

public com.google.api.gax.rpc.PagedCallSettings<ListAnalysesRequest,ListAnalysesResponse,LiveVideoAnalyticsClient.ListAnalysesPagedResponse> listAnalysesSettings()

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

getAnalysisSettings

public com.google.api.gax.rpc.UnaryCallSettings<GetAnalysisRequest,Analysis> getAnalysisSettings()

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

createAnalysisSettings

public com.google.api.gax.rpc.UnaryCallSettings<CreateAnalysisRequest,com.google.longrunning.Operation> createAnalysisSettings()

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

createAnalysisOperationSettings

public com.google.api.gax.rpc.OperationCallSettings<CreateAnalysisRequest,Analysis,OperationMetadata> createAnalysisOperationSettings()

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

updateAnalysisSettings

public com.google.api.gax.rpc.UnaryCallSettings<UpdateAnalysisRequest,com.google.longrunning.Operation> updateAnalysisSettings()

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

updateAnalysisOperationSettings

public com.google.api.gax.rpc.OperationCallSettings<UpdateAnalysisRequest,Analysis,OperationMetadata> updateAnalysisOperationSettings()

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

deleteAnalysisSettings

public com.google.api.gax.rpc.UnaryCallSettings<DeleteAnalysisRequest,com.google.longrunning.Operation> deleteAnalysisSettings()

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

deleteAnalysisOperationSettings

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

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

listProcessesSettings

public com.google.api.gax.rpc.PagedCallSettings<ListProcessesRequest,ListProcessesResponse,LiveVideoAnalyticsClient.ListProcessesPagedResponse> listProcessesSettings()

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

getProcessSettings

public com.google.api.gax.rpc.UnaryCallSettings<GetProcessRequest,Process> getProcessSettings()

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

createProcessSettings

public com.google.api.gax.rpc.UnaryCallSettings<CreateProcessRequest,com.google.longrunning.Operation> createProcessSettings()

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

createProcessOperationSettings

public com.google.api.gax.rpc.OperationCallSettings<CreateProcessRequest,Process,OperationMetadata> createProcessOperationSettings()

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

updateProcessSettings

public com.google.api.gax.rpc.UnaryCallSettings<UpdateProcessRequest,com.google.longrunning.Operation> updateProcessSettings()

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

updateProcessOperationSettings

public com.google.api.gax.rpc.OperationCallSettings<UpdateProcessRequest,Process,OperationMetadata> updateProcessOperationSettings()

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

deleteProcessSettings

public com.google.api.gax.rpc.UnaryCallSettings<DeleteProcessRequest,com.google.longrunning.Operation> deleteProcessSettings()

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

deleteProcessOperationSettings

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

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

batchRunProcessSettings

public com.google.api.gax.rpc.UnaryCallSettings<BatchRunProcessRequest,com.google.longrunning.Operation> batchRunProcessSettings()

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

batchRunProcessOperationSettings

public com.google.api.gax.rpc.OperationCallSettings<BatchRunProcessRequest,BatchRunProcessResponse,OperationMetadata> batchRunProcessOperationSettings()

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

create

public static final LiveVideoAnalyticsSettings create(LiveVideoAnalyticsStubSettings 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 LiveVideoAnalyticsSettings.Builder newBuilder()

Returns a new gRPC builder for this class.

newHttpJsonBuilder

public static LiveVideoAnalyticsSettings.Builder newHttpJsonBuilder()

Returns a new REST builder for this class.

newBuilder

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

Returns a new builder for this class.

toBuilder

public LiveVideoAnalyticsSettings.Builder toBuilder()

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

Specified by:

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