Class LineageSettings (0.45.0) 

public class LineageSettings extends ClientSettings<LineageSettings>

Settings class to configure an instance of LineageClient.

The default instance has everything set to sensible defaults:

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


 // 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
 LineageSettings.Builder lineageSettingsBuilder = LineageSettings.newBuilder();
 lineageSettingsBuilder
     .processOpenLineageRunEventSettings()
     .setRetrySettings(
         lineageSettingsBuilder
             .processOpenLineageRunEventSettings()
             .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());
 LineageSettings lineageSettings = lineageSettingsBuilder.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 deleteProcess:


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

Inheritance

java.lang.Object > ClientSettings > LineageSettings

Static Methods

create(LineageStubSettings stub)

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

Returns a new gRPC builder for this class.

Returns
Type Description
LineageSettings.Builder

newBuilder(ClientContext clientContext)

public static LineageSettings.Builder newBuilder(ClientContext clientContext)

Returns a new builder for this class.

Parameter
Name Description
clientContext ClientContext
Returns
Type Description
LineageSettings.Builder

newHttpJsonBuilder()

public static LineageSettings.Builder newHttpJsonBuilder()

Returns a new REST builder for this class.

Returns
Type Description
LineageSettings.Builder

Constructors

LineageSettings(LineageSettings.Builder settingsBuilder)

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

Methods

batchSearchLinkProcessesSettings()

public PagedCallSettings<BatchSearchLinkProcessesRequest,BatchSearchLinkProcessesResponse,LineageClient.BatchSearchLinkProcessesPagedResponse> batchSearchLinkProcessesSettings()

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

Returns
Type Description
PagedCallSettings<BatchSearchLinkProcessesRequest,BatchSearchLinkProcessesResponse,BatchSearchLinkProcessesPagedResponse>

createLineageEventSettings()

public UnaryCallSettings<CreateLineageEventRequest,LineageEvent> createLineageEventSettings()

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

Returns
Type Description
UnaryCallSettings<CreateLineageEventRequest,LineageEvent>

createProcessSettings()

public UnaryCallSettings<CreateProcessRequest,Process> createProcessSettings()

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

Returns
Type Description
UnaryCallSettings<CreateProcessRequest,Process>

createRunSettings()

public UnaryCallSettings<CreateRunRequest,Run> createRunSettings()

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

Returns
Type Description
UnaryCallSettings<CreateRunRequest,Run>

deleteLineageEventSettings()

public UnaryCallSettings<DeleteLineageEventRequest,Empty> deleteLineageEventSettings()

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

Returns
Type Description
UnaryCallSettings<DeleteLineageEventRequest,Empty>

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>

deleteRunOperationSettings()

public OperationCallSettings<DeleteRunRequest,Empty,OperationMetadata> deleteRunOperationSettings()

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

Returns
Type Description
OperationCallSettings<DeleteRunRequest,Empty,OperationMetadata>

deleteRunSettings()

public UnaryCallSettings<DeleteRunRequest,Operation> deleteRunSettings()

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

Returns
Type Description
UnaryCallSettings<DeleteRunRequest,Operation>

getLineageEventSettings()

public UnaryCallSettings<GetLineageEventRequest,LineageEvent> getLineageEventSettings()

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

Returns
Type Description
UnaryCallSettings<GetLineageEventRequest,LineageEvent>

getProcessSettings()

public UnaryCallSettings<GetProcessRequest,Process> getProcessSettings()

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

Returns
Type Description
UnaryCallSettings<GetProcessRequest,Process>

getRunSettings()

public UnaryCallSettings<GetRunRequest,Run> getRunSettings()

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

Returns
Type Description
UnaryCallSettings<GetRunRequest,Run>

listLineageEventsSettings()

public PagedCallSettings<ListLineageEventsRequest,ListLineageEventsResponse,LineageClient.ListLineageEventsPagedResponse> listLineageEventsSettings()

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

Returns
Type Description
PagedCallSettings<ListLineageEventsRequest,ListLineageEventsResponse,ListLineageEventsPagedResponse>

listProcessesSettings()

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

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

Returns
Type Description
PagedCallSettings<ListProcessesRequest,ListProcessesResponse,ListProcessesPagedResponse>

listRunsSettings()

public PagedCallSettings<ListRunsRequest,ListRunsResponse,LineageClient.ListRunsPagedResponse> listRunsSettings()

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

Returns
Type Description
PagedCallSettings<ListRunsRequest,ListRunsResponse,ListRunsPagedResponse>

processOpenLineageRunEventSettings()

public UnaryCallSettings<ProcessOpenLineageRunEventRequest,ProcessOpenLineageRunEventResponse> processOpenLineageRunEventSettings()

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

Returns
Type Description
UnaryCallSettings<ProcessOpenLineageRunEventRequest,ProcessOpenLineageRunEventResponse>

searchLinksSettings()

public PagedCallSettings<SearchLinksRequest,SearchLinksResponse,LineageClient.SearchLinksPagedResponse> searchLinksSettings()

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

Returns
Type Description
PagedCallSettings<SearchLinksRequest,SearchLinksResponse,SearchLinksPagedResponse>

toBuilder()

public LineageSettings.Builder toBuilder()

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

Returns
Type Description
LineageSettings.Builder
Overrides

updateProcessSettings()

public UnaryCallSettings<UpdateProcessRequest,Process> updateProcessSettings()

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

Returns
Type Description
UnaryCallSettings<UpdateProcessRequest,Process>

updateRunSettings()

public UnaryCallSettings<UpdateRunRequest,Run> updateRunSettings()

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

Returns
Type Description
UnaryCallSettings<UpdateRunRequest,Run>