Class LivestreamServiceSettings (0.3.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 total timeout of getChannel to 30 seconds:


 LivestreamServiceSettings.Builder livestreamServiceSettingsBuilder =
     LivestreamServiceSettings.newBuilder();
 livestreamServiceSettingsBuilder
     .getChannelSettings()
     .setRetrySettings(
         livestreamServiceSettingsBuilder
             .getChannelSettings()
             .getRetrySettings()
             .toBuilder()
             .setTotalTimeout(Duration.ofSeconds(30))
             .build());
 LivestreamServiceSettings livestreamServiceSettings = livestreamServiceSettingsBuilder.build();
 

Inheritance

java.lang.Object > ClientSettings > LivestreamServiceSettings

Static Methods

create(LivestreamServiceStubSettings stub)

public static final LivestreamServiceSettings create(LivestreamServiceStubSettings stub)
Parameter
NameDescription
stubLivestreamServiceStubSettings
Returns
TypeDescription
LivestreamServiceSettings
Exceptions
TypeDescription
IOException

defaultApiClientHeaderProviderBuilder()

public static ApiClientHeaderProvider.Builder defaultApiClientHeaderProviderBuilder()
Returns
TypeDescription
Builder

defaultCredentialsProviderBuilder()

public static GoogleCredentialsProvider.Builder defaultCredentialsProviderBuilder()

Returns a builder for the default credentials for this service.

Returns
TypeDescription
Builder

defaultExecutorProviderBuilder()

public static InstantiatingExecutorProvider.Builder defaultExecutorProviderBuilder()

Returns a builder for the default ExecutorProvider for this service.

Returns
TypeDescription
Builder

defaultGrpcTransportProviderBuilder()

public static InstantiatingGrpcChannelProvider.Builder defaultGrpcTransportProviderBuilder()

Returns a builder for the default ChannelProvider for this service.

Returns
TypeDescription
Builder

defaultTransportChannelProvider()

public static TransportChannelProvider defaultTransportChannelProvider()
Returns
TypeDescription
TransportChannelProvider

getDefaultEndpoint()

public static String getDefaultEndpoint()

Returns the default service endpoint.

Returns
TypeDescription
String

getDefaultServiceScopes()

public static List<String> getDefaultServiceScopes()

Returns the default service scopes.

Returns
TypeDescription
List<String>

newBuilder()

public static LivestreamServiceSettings.Builder newBuilder()

Returns a new builder for this class.

Returns
TypeDescription
LivestreamServiceSettings.Builder

newBuilder(ClientContext clientContext)

public static LivestreamServiceSettings.Builder newBuilder(ClientContext clientContext)

Returns a new builder for this class.

Parameter
NameDescription
clientContextClientContext
Returns
TypeDescription
LivestreamServiceSettings.Builder

Constructors

LivestreamServiceSettings(LivestreamServiceSettings.Builder settingsBuilder)

protected LivestreamServiceSettings(LivestreamServiceSettings.Builder settingsBuilder)
Parameter
NameDescription
settingsBuilderLivestreamServiceSettings.Builder

Methods

createChannelOperationSettings()

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

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

Returns
TypeDescription
OperationCallSettings<CreateChannelRequest,Channel,OperationMetadata>

createChannelSettings()

public UnaryCallSettings<CreateChannelRequest,Operation> createChannelSettings()

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

Returns
TypeDescription
UnaryCallSettings<CreateChannelRequest,Operation>

createEventSettings()

public UnaryCallSettings<CreateEventRequest,Event> createEventSettings()

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

Returns
TypeDescription
UnaryCallSettings<CreateEventRequest,Event>

createInputOperationSettings()

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

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

Returns
TypeDescription
OperationCallSettings<CreateInputRequest,Input,OperationMetadata>

createInputSettings()

public UnaryCallSettings<CreateInputRequest,Operation> createInputSettings()

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

Returns
TypeDescription
UnaryCallSettings<CreateInputRequest,Operation>

deleteChannelOperationSettings()

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

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

Returns
TypeDescription
OperationCallSettings<DeleteChannelRequest,Empty,OperationMetadata>

deleteChannelSettings()

public UnaryCallSettings<DeleteChannelRequest,Operation> deleteChannelSettings()

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

Returns
TypeDescription
UnaryCallSettings<DeleteChannelRequest,Operation>

deleteEventSettings()

public UnaryCallSettings<DeleteEventRequest,Empty> deleteEventSettings()

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

Returns
TypeDescription
UnaryCallSettings<DeleteEventRequest,Empty>

deleteInputOperationSettings()

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

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

Returns
TypeDescription
OperationCallSettings<DeleteInputRequest,Empty,OperationMetadata>

deleteInputSettings()

public UnaryCallSettings<DeleteInputRequest,Operation> deleteInputSettings()

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

Returns
TypeDescription
UnaryCallSettings<DeleteInputRequest,Operation>

getChannelSettings()

public UnaryCallSettings<GetChannelRequest,Channel> getChannelSettings()

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

Returns
TypeDescription
UnaryCallSettings<GetChannelRequest,Channel>

getEventSettings()

public UnaryCallSettings<GetEventRequest,Event> getEventSettings()

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

Returns
TypeDescription
UnaryCallSettings<GetEventRequest,Event>

getInputSettings()

public UnaryCallSettings<GetInputRequest,Input> getInputSettings()

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

Returns
TypeDescription
UnaryCallSettings<GetInputRequest,Input>

listChannelsSettings()

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

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

Returns
TypeDescription
PagedCallSettings<ListChannelsRequest,ListChannelsResponse,ListChannelsPagedResponse>

listEventsSettings()

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

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

Returns
TypeDescription
PagedCallSettings<ListEventsRequest,ListEventsResponse,ListEventsPagedResponse>

listInputsSettings()

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

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

Returns
TypeDescription
PagedCallSettings<ListInputsRequest,ListInputsResponse,ListInputsPagedResponse>

startChannelOperationSettings()

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

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

Returns
TypeDescription
OperationCallSettings<StartChannelRequest,ChannelOperationResponse,OperationMetadata>

startChannelSettings()

public UnaryCallSettings<StartChannelRequest,Operation> startChannelSettings()

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

Returns
TypeDescription
UnaryCallSettings<StartChannelRequest,Operation>

stopChannelOperationSettings()

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

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

Returns
TypeDescription
OperationCallSettings<StopChannelRequest,ChannelOperationResponse,OperationMetadata>

stopChannelSettings()

public UnaryCallSettings<StopChannelRequest,Operation> stopChannelSettings()

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

Returns
TypeDescription
UnaryCallSettings<StopChannelRequest,Operation>

toBuilder()

public LivestreamServiceSettings.Builder toBuilder()

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

Returns
TypeDescription
LivestreamServiceSettings.Builder
Overrides

updateChannelOperationSettings()

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

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

Returns
TypeDescription
OperationCallSettings<UpdateChannelRequest,Channel,OperationMetadata>

updateChannelSettings()

public UnaryCallSettings<UpdateChannelRequest,Operation> updateChannelSettings()

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

Returns
TypeDescription
UnaryCallSettings<UpdateChannelRequest,Operation>

updateInputOperationSettings()

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

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

Returns
TypeDescription
OperationCallSettings<UpdateInputRequest,Input,OperationMetadata>

updateInputSettings()

public UnaryCallSettings<UpdateInputRequest,Operation> updateInputSettings()

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

Returns
TypeDescription
UnaryCallSettings<UpdateInputRequest,Operation>