Class LivestreamServiceSettings (0.56.0) 

public class LivestreamServiceSettings extends ClientSettings<LivestreamServiceSettings>

Settings class to configure an instance of LivestreamServiceClient.

The default instance has everything set to sensible defaults:

  • The default service address (livestream.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 getChannel:


 // 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
 LivestreamServiceSettings.Builder livestreamServiceSettingsBuilder =
     LivestreamServiceSettings.newBuilder();
 livestreamServiceSettingsBuilder
     .getChannelSettings()
     .setRetrySettings(
         livestreamServiceSettingsBuilder
             .getChannelSettings()
             .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());
 LivestreamServiceSettings livestreamServiceSettings = livestreamServiceSettingsBuilder.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 createChannel:


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

Inheritance

java.lang.Object > ClientSettings > LivestreamServiceSettings

Static Methods

create(LivestreamServiceStubSettings stub)

public static final LivestreamServiceSettings create(LivestreamServiceStubSettings stub)
Parameter
Name Description
stub LivestreamServiceStubSettings
Returns
Type Description
LivestreamServiceSettings
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 LivestreamServiceSettings.Builder newBuilder()

Returns a new gRPC builder for this class.

Returns
Type Description
LivestreamServiceSettings.Builder

newBuilder(ClientContext clientContext)

public static LivestreamServiceSettings.Builder newBuilder(ClientContext clientContext)

Returns a new builder for this class.

Parameter
Name Description
clientContext ClientContext
Returns
Type Description
LivestreamServiceSettings.Builder

newHttpJsonBuilder()

public static LivestreamServiceSettings.Builder newHttpJsonBuilder()

Returns a new REST builder for this class.

Returns
Type Description
LivestreamServiceSettings.Builder

Constructors

LivestreamServiceSettings(LivestreamServiceSettings.Builder settingsBuilder)

protected LivestreamServiceSettings(LivestreamServiceSettings.Builder settingsBuilder)
Parameter
Name Description
settingsBuilder LivestreamServiceSettings.Builder

Methods

createAssetOperationSettings()

public OperationCallSettings<CreateAssetRequest,Asset,OperationMetadata> createAssetOperationSettings()

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

Returns
Type Description
OperationCallSettings<CreateAssetRequest,Asset,OperationMetadata>

createAssetSettings()

public UnaryCallSettings<CreateAssetRequest,Operation> createAssetSettings()

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

Returns
Type Description
UnaryCallSettings<CreateAssetRequest,Operation>

createChannelOperationSettings()

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

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

Returns
Type Description
OperationCallSettings<CreateChannelRequest,Channel,OperationMetadata>

createChannelSettings()

public UnaryCallSettings<CreateChannelRequest,Operation> createChannelSettings()

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

Returns
Type Description
UnaryCallSettings<CreateChannelRequest,Operation>

createClipOperationSettings()

public OperationCallSettings<CreateClipRequest,Clip,OperationMetadata> createClipOperationSettings()

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

Returns
Type Description
OperationCallSettings<CreateClipRequest,Clip,OperationMetadata>

createClipSettings()

public UnaryCallSettings<CreateClipRequest,Operation> createClipSettings()

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

Returns
Type Description
UnaryCallSettings<CreateClipRequest,Operation>

createEventSettings()

public UnaryCallSettings<CreateEventRequest,Event> createEventSettings()

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

Returns
Type Description
UnaryCallSettings<CreateEventRequest,Event>

createInputOperationSettings()

public OperationCallSettings<CreateInputRequest,Input,OperationMetadata> createInputOperationSettings()

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

Returns
Type Description
OperationCallSettings<CreateInputRequest,Input,OperationMetadata>

createInputSettings()

public UnaryCallSettings<CreateInputRequest,Operation> createInputSettings()

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

Returns
Type Description
UnaryCallSettings<CreateInputRequest,Operation>

deleteAssetOperationSettings()

public OperationCallSettings<DeleteAssetRequest,Empty,OperationMetadata> deleteAssetOperationSettings()

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

Returns
Type Description
OperationCallSettings<DeleteAssetRequest,Empty,OperationMetadata>

deleteAssetSettings()

public UnaryCallSettings<DeleteAssetRequest,Operation> deleteAssetSettings()

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

Returns
Type Description
UnaryCallSettings<DeleteAssetRequest,Operation>

deleteChannelOperationSettings()

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

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

Returns
Type Description
OperationCallSettings<DeleteChannelRequest,Empty,OperationMetadata>

deleteChannelSettings()

public UnaryCallSettings<DeleteChannelRequest,Operation> deleteChannelSettings()

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

Returns
Type Description
UnaryCallSettings<DeleteChannelRequest,Operation>

deleteClipOperationSettings()

public OperationCallSettings<DeleteClipRequest,Empty,OperationMetadata> deleteClipOperationSettings()

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

Returns
Type Description
OperationCallSettings<DeleteClipRequest,Empty,OperationMetadata>

deleteClipSettings()

public UnaryCallSettings<DeleteClipRequest,Operation> deleteClipSettings()

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

Returns
Type Description
UnaryCallSettings<DeleteClipRequest,Operation>

deleteEventSettings()

public UnaryCallSettings<DeleteEventRequest,Empty> deleteEventSettings()

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

Returns
Type Description
UnaryCallSettings<DeleteEventRequest,Empty>

deleteInputOperationSettings()

public OperationCallSettings<DeleteInputRequest,Empty,OperationMetadata> deleteInputOperationSettings()

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

Returns
Type Description
OperationCallSettings<DeleteInputRequest,Empty,OperationMetadata>

deleteInputSettings()

public UnaryCallSettings<DeleteInputRequest,Operation> deleteInputSettings()

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

Returns
Type Description
UnaryCallSettings<DeleteInputRequest,Operation>

getAssetSettings()

public UnaryCallSettings<GetAssetRequest,Asset> getAssetSettings()

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

Returns
Type Description
UnaryCallSettings<GetAssetRequest,Asset>

getChannelSettings()

public UnaryCallSettings<GetChannelRequest,Channel> getChannelSettings()

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

Returns
Type Description
UnaryCallSettings<GetChannelRequest,Channel>

getClipSettings()

public UnaryCallSettings<GetClipRequest,Clip> getClipSettings()

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

Returns
Type Description
UnaryCallSettings<GetClipRequest,Clip>

getEventSettings()

public UnaryCallSettings<GetEventRequest,Event> getEventSettings()

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

Returns
Type Description
UnaryCallSettings<GetEventRequest,Event>

getInputSettings()

public UnaryCallSettings<GetInputRequest,Input> getInputSettings()

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

Returns
Type Description
UnaryCallSettings<GetInputRequest,Input>

getLocationSettings()

public UnaryCallSettings<GetLocationRequest,Location> getLocationSettings()

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

Returns
Type Description
UnaryCallSettings<com.google.cloud.location.GetLocationRequest,com.google.cloud.location.Location>

getPoolSettings()

public UnaryCallSettings<GetPoolRequest,Pool> getPoolSettings()

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

Returns
Type Description
UnaryCallSettings<GetPoolRequest,Pool>

listAssetsSettings()

public PagedCallSettings<ListAssetsRequest,ListAssetsResponse,LivestreamServiceClient.ListAssetsPagedResponse> listAssetsSettings()

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

Returns
Type Description
PagedCallSettings<ListAssetsRequest,ListAssetsResponse,ListAssetsPagedResponse>

listChannelsSettings()

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

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

Returns
Type Description
PagedCallSettings<ListChannelsRequest,ListChannelsResponse,ListChannelsPagedResponse>

listClipsSettings()

public PagedCallSettings<ListClipsRequest,ListClipsResponse,LivestreamServiceClient.ListClipsPagedResponse> listClipsSettings()

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

Returns
Type Description
PagedCallSettings<ListClipsRequest,ListClipsResponse,ListClipsPagedResponse>

listEventsSettings()

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

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

Returns
Type Description
PagedCallSettings<ListEventsRequest,ListEventsResponse,ListEventsPagedResponse>

listInputsSettings()

public PagedCallSettings<ListInputsRequest,ListInputsResponse,LivestreamServiceClient.ListInputsPagedResponse> listInputsSettings()

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

Returns
Type Description
PagedCallSettings<ListInputsRequest,ListInputsResponse,ListInputsPagedResponse>

listLocationsSettings()

public PagedCallSettings<ListLocationsRequest,ListLocationsResponse,LivestreamServiceClient.ListLocationsPagedResponse> listLocationsSettings()

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

Returns
Type Description
PagedCallSettings<com.google.cloud.location.ListLocationsRequest,com.google.cloud.location.ListLocationsResponse,ListLocationsPagedResponse>

startChannelOperationSettings()

public OperationCallSettings<StartChannelRequest,ChannelOperationResponse,OperationMetadata> startChannelOperationSettings()

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

Returns
Type Description
OperationCallSettings<StartChannelRequest,ChannelOperationResponse,OperationMetadata>

startChannelSettings()

public UnaryCallSettings<StartChannelRequest,Operation> startChannelSettings()

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

Returns
Type Description
UnaryCallSettings<StartChannelRequest,Operation>

stopChannelOperationSettings()

public OperationCallSettings<StopChannelRequest,ChannelOperationResponse,OperationMetadata> stopChannelOperationSettings()

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

Returns
Type Description
OperationCallSettings<StopChannelRequest,ChannelOperationResponse,OperationMetadata>

stopChannelSettings()

public UnaryCallSettings<StopChannelRequest,Operation> stopChannelSettings()

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

Returns
Type Description
UnaryCallSettings<StopChannelRequest,Operation>

toBuilder()

public LivestreamServiceSettings.Builder toBuilder()

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

Returns
Type Description
LivestreamServiceSettings.Builder
Overrides

updateChannelOperationSettings()

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

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

Returns
Type Description
OperationCallSettings<UpdateChannelRequest,Channel,OperationMetadata>

updateChannelSettings()

public UnaryCallSettings<UpdateChannelRequest,Operation> updateChannelSettings()

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

Returns
Type Description
UnaryCallSettings<UpdateChannelRequest,Operation>

updateInputOperationSettings()

public OperationCallSettings<UpdateInputRequest,Input,OperationMetadata> updateInputOperationSettings()

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

Returns
Type Description
OperationCallSettings<UpdateInputRequest,Input,OperationMetadata>

updateInputSettings()

public UnaryCallSettings<UpdateInputRequest,Operation> updateInputSettings()

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

Returns
Type Description
UnaryCallSettings<UpdateInputRequest,Operation>

updatePoolOperationSettings()

public OperationCallSettings<UpdatePoolRequest,Pool,OperationMetadata> updatePoolOperationSettings()

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

Returns
Type Description
OperationCallSettings<UpdatePoolRequest,Pool,OperationMetadata>

updatePoolSettings()

public UnaryCallSettings<UpdatePoolRequest,Operation> updatePoolSettings()

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

Returns
Type Description
UnaryCallSettings<UpdatePoolRequest,Operation>