Class LiveVideoAnalyticsSettings (0.11.0)

public class LiveVideoAnalyticsSettings extends 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 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 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();

Inheritance

java.lang.Object > ClientSettings > LiveVideoAnalyticsSettings

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(LiveVideoAnalyticsStubSettings stub)

public static final LiveVideoAnalyticsSettings create(LiveVideoAnalyticsStubSettings stub)

Parameter
Name	Description
`stub`	`LiveVideoAnalyticsStubSettings`

Returns
Type	Description
`LiveVideoAnalyticsSettings`

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 LiveVideoAnalyticsSettings.Builder newBuilder()

Returns a new gRPC builder for this class.

Returns
Type	Description
`LiveVideoAnalyticsSettings.Builder`

newBuilder(ClientContext clientContext)

public static LiveVideoAnalyticsSettings.Builder newBuilder(ClientContext clientContext)

Returns a new builder for this class.

Parameter
Name	Description
`clientContext`	`ClientContext`

Returns
Type	Description
`LiveVideoAnalyticsSettings.Builder`

newHttpJsonBuilder()

public static LiveVideoAnalyticsSettings.Builder newHttpJsonBuilder()

Returns a new REST builder for this class.

Returns
Type	Description
`LiveVideoAnalyticsSettings.Builder`

Constructors

LiveVideoAnalyticsSettings(LiveVideoAnalyticsSettings.Builder settingsBuilder)

protected LiveVideoAnalyticsSettings(LiveVideoAnalyticsSettings.Builder settingsBuilder)

Parameter
Name	Description
`settingsBuilder`	`LiveVideoAnalyticsSettings.Builder`

Methods

batchRunProcessOperationSettings()

public OperationCallSettings<BatchRunProcessRequest,BatchRunProcessResponse,OperationMetadata> batchRunProcessOperationSettings()

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

Returns
Type	Description
`OperationCallSettings<BatchRunProcessRequest,BatchRunProcessResponse,OperationMetadata>`

batchRunProcessSettings()

public UnaryCallSettings<BatchRunProcessRequest,Operation> batchRunProcessSettings()

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

Returns
Type	Description
`UnaryCallSettings<BatchRunProcessRequest,Operation>`

createAnalysisOperationSettings()

public OperationCallSettings<CreateAnalysisRequest,Analysis,OperationMetadata> createAnalysisOperationSettings()

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

Returns
Type	Description
`OperationCallSettings<CreateAnalysisRequest,Analysis,OperationMetadata>`

createAnalysisSettings()

public UnaryCallSettings<CreateAnalysisRequest,Operation> createAnalysisSettings()

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

Returns
Type	Description
`UnaryCallSettings<CreateAnalysisRequest,Operation>`

createOperatorOperationSettings()

public OperationCallSettings<CreateOperatorRequest,Operator,OperationMetadata> createOperatorOperationSettings()

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

Returns
Type	Description
`OperationCallSettings<CreateOperatorRequest,Operator,OperationMetadata>`

createOperatorSettings()

public UnaryCallSettings<CreateOperatorRequest,Operation> createOperatorSettings()

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

Returns
Type	Description
`UnaryCallSettings<CreateOperatorRequest,Operation>`

createProcessOperationSettings()

public OperationCallSettings<CreateProcessRequest,Process,OperationMetadata> createProcessOperationSettings()

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

Returns
Type	Description
`OperationCallSettings<CreateProcessRequest,Process,OperationMetadata>`

createProcessSettings()

public UnaryCallSettings<CreateProcessRequest,Operation> createProcessSettings()

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

Returns
Type	Description
`UnaryCallSettings<CreateProcessRequest,Operation>`

deleteAnalysisOperationSettings()

public OperationCallSettings<DeleteAnalysisRequest,Empty,OperationMetadata> deleteAnalysisOperationSettings()

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

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

deleteAnalysisSettings()

public UnaryCallSettings<DeleteAnalysisRequest,Operation> deleteAnalysisSettings()

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

Returns
Type	Description
`UnaryCallSettings<DeleteAnalysisRequest,Operation>`

deleteOperatorOperationSettings()

public OperationCallSettings<DeleteOperatorRequest,Empty,OperationMetadata> deleteOperatorOperationSettings()

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

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

deleteOperatorSettings()

public UnaryCallSettings<DeleteOperatorRequest,Operation> deleteOperatorSettings()

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

Returns
Type	Description
`UnaryCallSettings<DeleteOperatorRequest,Operation>`

deleteProcessOperationSettings()

public OperationCallSettings<DeleteProcessRequest,Empty,OperationMetadata> deleteProcessOperationSettings()

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

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

deleteProcessSettings()

public UnaryCallSettings<DeleteProcessRequest,Operation> deleteProcessSettings()

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

Returns
Type	Description
`UnaryCallSettings<DeleteProcessRequest,Operation>`

getAnalysisSettings()

public UnaryCallSettings<GetAnalysisRequest,Analysis> getAnalysisSettings()

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

Returns
Type	Description
`UnaryCallSettings<GetAnalysisRequest,Analysis>`

getOperatorSettings()

public UnaryCallSettings<GetOperatorRequest,Operator> getOperatorSettings()

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

Returns
Type	Description
`UnaryCallSettings<GetOperatorRequest,Operator>`

getProcessSettings()

public UnaryCallSettings<GetProcessRequest,Process> getProcessSettings()

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

Returns
Type	Description
`UnaryCallSettings<GetProcessRequest,Process>`

listAnalysesSettings()

public PagedCallSettings<ListAnalysesRequest,ListAnalysesResponse,LiveVideoAnalyticsClient.ListAnalysesPagedResponse> listAnalysesSettings()

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

Returns
Type	Description
`PagedCallSettings<ListAnalysesRequest,ListAnalysesResponse,ListAnalysesPagedResponse>`

listOperatorsSettings()

public PagedCallSettings<ListOperatorsRequest,ListOperatorsResponse,LiveVideoAnalyticsClient.ListOperatorsPagedResponse> listOperatorsSettings()

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

Returns
Type	Description
`PagedCallSettings<ListOperatorsRequest,ListOperatorsResponse,ListOperatorsPagedResponse>`

listProcessesSettings()

public PagedCallSettings<ListProcessesRequest,ListProcessesResponse,LiveVideoAnalyticsClient.ListProcessesPagedResponse> listProcessesSettings()

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

Returns
Type	Description
`PagedCallSettings<ListProcessesRequest,ListProcessesResponse,ListProcessesPagedResponse>`

listPublicOperatorsSettings()

public PagedCallSettings<ListPublicOperatorsRequest,ListPublicOperatorsResponse,LiveVideoAnalyticsClient.ListPublicOperatorsPagedResponse> listPublicOperatorsSettings()

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

Returns
Type	Description
`PagedCallSettings<ListPublicOperatorsRequest,ListPublicOperatorsResponse,ListPublicOperatorsPagedResponse>`

resolveOperatorInfoSettings()

public UnaryCallSettings<ResolveOperatorInfoRequest,ResolveOperatorInfoResponse> resolveOperatorInfoSettings()

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

Returns
Type	Description
`UnaryCallSettings<ResolveOperatorInfoRequest,ResolveOperatorInfoResponse>`

toBuilder()

public LiveVideoAnalyticsSettings.Builder toBuilder()

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

Returns
Type	Description
`LiveVideoAnalyticsSettings.Builder`

Overrides

ClientSettings<SettingsT>.<B>toBuilder()

updateAnalysisOperationSettings()

public OperationCallSettings<UpdateAnalysisRequest,Analysis,OperationMetadata> updateAnalysisOperationSettings()

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

Returns
Type	Description
`OperationCallSettings<UpdateAnalysisRequest,Analysis,OperationMetadata>`

updateAnalysisSettings()

public UnaryCallSettings<UpdateAnalysisRequest,Operation> updateAnalysisSettings()

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

Returns
Type	Description
`UnaryCallSettings<UpdateAnalysisRequest,Operation>`

updateOperatorOperationSettings()

public OperationCallSettings<UpdateOperatorRequest,Operator,OperationMetadata> updateOperatorOperationSettings()

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

Returns
Type	Description
`OperationCallSettings<UpdateOperatorRequest,Operator,OperationMetadata>`

updateOperatorSettings()

public UnaryCallSettings<UpdateOperatorRequest,Operation> updateOperatorSettings()

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

Returns
Type	Description
`UnaryCallSettings<UpdateOperatorRequest,Operation>`

updateProcessOperationSettings()

public OperationCallSettings<UpdateProcessRequest,Process,OperationMetadata> updateProcessOperationSettings()

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

Returns
Type	Description
`OperationCallSettings<UpdateProcessRequest,Process,OperationMetadata>`

updateProcessSettings()

public UnaryCallSettings<UpdateProcessRequest,Operation> updateProcessSettings()

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

Returns
Type	Description
`UnaryCallSettings<UpdateProcessRequest,Operation>`