Package com.azure.analytics.synapse.artifacts

Class ArtifactsClientBuilder

java.lang.Object
com.azure.analytics.synapse.artifacts.ArtifactsClientBuilder
All Implemented Interfaces:
ConfigurationTrait<ArtifactsClientBuilder>, EndpointTrait<ArtifactsClientBuilder>, HttpTrait<ArtifactsClientBuilder>, TokenCredentialTrait<ArtifactsClientBuilder>
public final class ArtifactsClientBuilder extends Object implements HttpTrait<ArtifactsClientBuilder>, ConfigurationTrait<ArtifactsClientBuilder>, TokenCredentialTrait<ArtifactsClientBuilder>, EndpointTrait<ArtifactsClientBuilder>
A builder for creating a new instance of the ArtifactsClient type.

  • Constructor Details

    • ArtifactsClientBuilder

      public ArtifactsClientBuilder()
      Create an instance of the ArtifactsClientBuilder.

  • Method Details

    • pipeline

      public ArtifactsClientBuilder pipeline(HttpPipeline pipeline)
      Sets the HttpPipeline to use for the service client.

      Note: It is important to understand the precedence order of the HttpTrait APIs. In particular, if a HttpPipeline is specified, this takes precedence over all other APIs in the trait, and they will be ignored. If no HttpPipeline is specified, a HTTP pipeline will be constructed internally based on the settings provided to this trait. Additionally, there may be other APIs in types that implement this trait that are also ignored if an HttpPipeline is specified, so please be sure to refer to the documentation of types that implement this trait to understand the full set of implications.

      .
      Specified by:
      pipeline in interface HttpTrait<ArtifactsClientBuilder>
      Parameters:
      pipeline - HttpPipeline to use for sending service requests and receiving responses.
      Returns:
      Returns the same concrete type with the appropriate properties updated, to allow for fluent chaining of operations.

    • httpClient

      public ArtifactsClientBuilder httpClient(HttpClient httpClient)
      Sets the HttpClient to use for sending and receiving requests to and from the service.

      Note: It is important to understand the precedence order of the HttpTrait APIs. In particular, if a HttpPipeline is specified, this takes precedence over all other APIs in the trait, and they will be ignored. If no HttpPipeline is specified, a HTTP pipeline will be constructed internally based on the settings provided to this trait. Additionally, there may be other APIs in types that implement this trait that are also ignored if an HttpPipeline is specified, so please be sure to refer to the documentation of types that implement this trait to understand the full set of implications.

      .
      Specified by:
      httpClient in interface HttpTrait<ArtifactsClientBuilder>
      Parameters:
      httpClient - The HttpClient to use for requests.
      Returns:
      Returns the same concrete type with the appropriate properties updated, to allow for fluent chaining of operations.

    • httpLogOptions

      public ArtifactsClientBuilder httpLogOptions(HttpLogOptions httpLogOptions)
      Sets the logging configuration to use when sending and receiving requests to and from the service. If a logLevel is not provided, default value of HttpLogDetailLevel.NONE is set.

      Note: It is important to understand the precedence order of the HttpTrait APIs. In particular, if a HttpPipeline is specified, this takes precedence over all other APIs in the trait, and they will be ignored. If no HttpPipeline is specified, a HTTP pipeline will be constructed internally based on the settings provided to this trait. Additionally, there may be other APIs in types that implement this trait that are also ignored if an HttpPipeline is specified, so please be sure to refer to the documentation of types that implement this trait to understand the full set of implications.

      .
      Specified by:
      httpLogOptions in interface HttpTrait<ArtifactsClientBuilder>
      Parameters:
      httpLogOptions - The logging configuration to use when sending and receiving requests to and from the service.
      Returns:
      Returns the same concrete type with the appropriate properties updated, to allow for fluent chaining of operations.

    • clientOptions

      public ArtifactsClientBuilder clientOptions(ClientOptions clientOptions)
      Allows for setting common properties such as application ID, headers, proxy configuration, etc. Note that it is recommended that this method be called with an instance of the HttpClientOptions class (a subclass of the ClientOptions base class). The HttpClientOptions subclass provides more configuration options suitable for HTTP clients, which is applicable for any class that implements this HttpTrait interface.

      Note: It is important to understand the precedence order of the HttpTrait APIs. In particular, if a HttpPipeline is specified, this takes precedence over all other APIs in the trait, and they will be ignored. If no HttpPipeline is specified, a HTTP pipeline will be constructed internally based on the settings provided to this trait. Additionally, there may be other APIs in types that implement this trait that are also ignored if an HttpPipeline is specified, so please be sure to refer to the documentation of types that implement this trait to understand the full set of implications.

      .
      Specified by:
      clientOptions in interface HttpTrait<ArtifactsClientBuilder>
      Parameters:
      clientOptions - A configured instance of HttpClientOptions.
      Returns:
      Returns the same concrete type with the appropriate properties updated, to allow for fluent chaining of operations.
      See Also:

    • retryOptions

      public ArtifactsClientBuilder retryOptions(RetryOptions retryOptions)
      Sets the RetryOptions for all the requests made through the client.

      Note: It is important to understand the precedence order of the HttpTrait APIs. In particular, if a HttpPipeline is specified, this takes precedence over all other APIs in the trait, and they will be ignored. If no HttpPipeline is specified, a HTTP pipeline will be constructed internally based on the settings provided to this trait. Additionally, there may be other APIs in types that implement this trait that are also ignored if an HttpPipeline is specified, so please be sure to refer to the documentation of types that implement this trait to understand the full set of implications.

      .
      Specified by:
      retryOptions in interface HttpTrait<ArtifactsClientBuilder>
      Parameters:
      retryOptions - The RetryOptions to use for all the requests made through the client.
      Returns:
      Returns the same concrete type with the appropriate properties updated, to allow for fluent chaining of operations.

    • addPolicy

      public ArtifactsClientBuilder addPolicy(HttpPipelinePolicy customPolicy)
      Adds a pipeline policy to apply on each request sent.

      Note: It is important to understand the precedence order of the HttpTrait APIs. In particular, if a HttpPipeline is specified, this takes precedence over all other APIs in the trait, and they will be ignored. If no HttpPipeline is specified, a HTTP pipeline will be constructed internally based on the settings provided to this trait. Additionally, there may be other APIs in types that implement this trait that are also ignored if an HttpPipeline is specified, so please be sure to refer to the documentation of types that implement this trait to understand the full set of implications.

      .
      Specified by:
      addPolicy in interface HttpTrait<ArtifactsClientBuilder>
      Parameters:
      customPolicy - A pipeline policy.
      Returns:
      Returns the same concrete type with the appropriate properties updated, to allow for fluent chaining of operations.

    • configuration

      public ArtifactsClientBuilder configuration(Configuration configuration)
      Sets the client-specific configuration used to retrieve client or global configuration properties when building a client..
      Specified by:
      configuration in interface ConfigurationTrait<ArtifactsClientBuilder>
      Parameters:
      configuration - Configuration store used to retrieve client configurations.
      Returns:
      Returns the same concrete type with the appropriate properties updated, to allow for fluent chaining of operations.

    • credential

      public ArtifactsClientBuilder credential(TokenCredential tokenCredential)
      Sets the TokenCredential used to authorize requests sent to the service. Refer to the Azure SDK for Java identity and authentication documentation for more details on proper usage of the TokenCredential type..
      Specified by:
      credential in interface TokenCredentialTrait<ArtifactsClientBuilder>
      Parameters:
      tokenCredential - TokenCredential used to authorize requests sent to the service.
      Returns:
      Returns the same concrete type with the appropriate properties updated, to allow for fluent chaining of operations.

    • endpoint

      public ArtifactsClientBuilder endpoint(String endpoint)
      Sets the service endpoint that will be connected to by clients..
      Specified by:
      endpoint in interface EndpointTrait<ArtifactsClientBuilder>
      Parameters:
      endpoint - The URL of the service endpoint.
      Returns:
      Returns the same concrete type with the appropriate properties updated, to allow for fluent chaining of operations.

    • serializerAdapter

      public ArtifactsClientBuilder serializerAdapter(SerializerAdapter serializerAdapter)
      Sets The serializer to serialize an object into a string.
      Parameters:
      serializerAdapter - the serializerAdapter value.
      Returns:
      the ArtifactsClientBuilder.

    • retryPolicy

      public ArtifactsClientBuilder retryPolicy(RetryPolicy retryPolicy)
      Sets The retry policy that will attempt to retry failed requests, if applicable.
      Parameters:
      retryPolicy - the retryPolicy value.
      Returns:
      the ArtifactsClientBuilder.

    • buildLinkConnectionAsyncClient

      public LinkConnectionAsyncClient buildLinkConnectionAsyncClient()
      Builds an instance of LinkConnectionAsyncClient class.
      Returns:
      an instance of LinkConnectionAsyncClient.

    • buildKqlScriptsAsyncClient

      public KqlScriptsAsyncClient buildKqlScriptsAsyncClient()
      Builds an instance of KqlScriptsAsyncClient class.
      Returns:
      an instance of KqlScriptsAsyncClient.

    • buildKqlScriptAsyncClient

      public KqlScriptAsyncClient buildKqlScriptAsyncClient()
      Builds an instance of KqlScriptAsyncClient class.
      Returns:
      an instance of KqlScriptAsyncClient.

    • buildMetastoreAsyncClient

      public MetastoreAsyncClient buildMetastoreAsyncClient()
      Builds an instance of MetastoreAsyncClient class.
      Returns:
      an instance of MetastoreAsyncClient.

    • buildSparkConfigurationAsyncClient

      public SparkConfigurationAsyncClient buildSparkConfigurationAsyncClient()
      Builds an instance of SparkConfigurationAsyncClient class.
      Returns:
      an instance of SparkConfigurationAsyncClient.

    • buildBigDataPoolsAsyncClient

      public BigDataPoolsAsyncClient buildBigDataPoolsAsyncClient()
      Builds an instance of BigDataPoolsAsyncClient class.
      Returns:
      an instance of BigDataPoolsAsyncClient.

    • buildDataFlowAsyncClient

      public DataFlowAsyncClient buildDataFlowAsyncClient()
      Builds an instance of DataFlowAsyncClient class.
      Returns:
      an instance of DataFlowAsyncClient.

    • buildDataFlowDebugSessionAsyncClient

      public DataFlowDebugSessionAsyncClient buildDataFlowDebugSessionAsyncClient()
      Builds an instance of DataFlowDebugSessionAsyncClient class.
      Returns:
      an instance of DataFlowDebugSessionAsyncClient.

    • buildDatasetAsyncClient

      public DatasetAsyncClient buildDatasetAsyncClient()
      Builds an instance of DatasetAsyncClient class.
      Returns:
      an instance of DatasetAsyncClient.

    • buildWorkspaceGitRepoManagementAsyncClient

      public WorkspaceGitRepoManagementAsyncClient buildWorkspaceGitRepoManagementAsyncClient()
      Builds an instance of WorkspaceGitRepoManagementAsyncClient class.
      Returns:
      an instance of WorkspaceGitRepoManagementAsyncClient.

    • buildIntegrationRuntimesAsyncClient

      public IntegrationRuntimesAsyncClient buildIntegrationRuntimesAsyncClient()
      Builds an instance of IntegrationRuntimesAsyncClient class.
      Returns:
      an instance of IntegrationRuntimesAsyncClient.

    • buildLibraryAsyncClient

      public LibraryAsyncClient buildLibraryAsyncClient()
      Builds an instance of LibraryAsyncClient class.
      Returns:
      an instance of LibraryAsyncClient.

    • buildLinkedServiceAsyncClient

      public LinkedServiceAsyncClient buildLinkedServiceAsyncClient()
      Builds an instance of LinkedServiceAsyncClient class.
      Returns:
      an instance of LinkedServiceAsyncClient.

    • buildNotebookAsyncClient

      public NotebookAsyncClient buildNotebookAsyncClient()
      Builds an instance of NotebookAsyncClient class.
      Returns:
      an instance of NotebookAsyncClient.

    • buildNotebookOperationResultAsyncClient

      public NotebookOperationResultAsyncClient buildNotebookOperationResultAsyncClient()
      Builds an instance of NotebookOperationResultAsyncClient class.
      Returns:
      an instance of NotebookOperationResultAsyncClient.

    • buildPipelineAsyncClient

      public PipelineAsyncClient buildPipelineAsyncClient()
      Builds an instance of PipelineAsyncClient class.
      Returns:
      an instance of PipelineAsyncClient.

    • buildPipelineRunAsyncClient

      public PipelineRunAsyncClient buildPipelineRunAsyncClient()
      Builds an instance of PipelineRunAsyncClient class.
      Returns:
      an instance of PipelineRunAsyncClient.

    • buildSparkJobDefinitionAsyncClient

      public SparkJobDefinitionAsyncClient buildSparkJobDefinitionAsyncClient()
      Builds an instance of SparkJobDefinitionAsyncClient class.
      Returns:
      an instance of SparkJobDefinitionAsyncClient.

    • buildSqlPoolsAsyncClient

      public SqlPoolsAsyncClient buildSqlPoolsAsyncClient()
      Builds an instance of SqlPoolsAsyncClient class.
      Returns:
      an instance of SqlPoolsAsyncClient.

    • buildSqlScriptAsyncClient

      public SqlScriptAsyncClient buildSqlScriptAsyncClient()
      Builds an instance of SqlScriptAsyncClient class.
      Returns:
      an instance of SqlScriptAsyncClient.

    • buildTriggerAsyncClient

      public TriggerAsyncClient buildTriggerAsyncClient()
      Builds an instance of TriggerAsyncClient class.
      Returns:
      an instance of TriggerAsyncClient.

    • buildTriggerRunAsyncClient

      public TriggerRunAsyncClient buildTriggerRunAsyncClient()
      Builds an instance of TriggerRunAsyncClient class.
      Returns:
      an instance of TriggerRunAsyncClient.

    • buildWorkspaceAsyncClient

      public WorkspaceAsyncClient buildWorkspaceAsyncClient()
      Builds an instance of WorkspaceAsyncClient class.
      Returns:
      an instance of WorkspaceAsyncClient.

    • buildLinkConnectionClient

      public LinkConnectionClient buildLinkConnectionClient()
      Builds an instance of LinkConnectionClient class.
      Returns:
      an instance of LinkConnectionClient.

    • buildKqlScriptsClient

      public KqlScriptsClient buildKqlScriptsClient()
      Builds an instance of KqlScriptsClient class.
      Returns:
      an instance of KqlScriptsClient.

    • buildKqlScriptClient

      public KqlScriptClient buildKqlScriptClient()
      Builds an instance of KqlScriptClient class.
      Returns:
      an instance of KqlScriptClient.

    • buildMetastoreClient

      public MetastoreClient buildMetastoreClient()
      Builds an instance of MetastoreClient class.
      Returns:
      an instance of MetastoreClient.

    • buildSparkConfigurationClient

      public SparkConfigurationClient buildSparkConfigurationClient()
      Builds an instance of SparkConfigurationClient class.
      Returns:
      an instance of SparkConfigurationClient.

    • buildBigDataPoolsClient

      public BigDataPoolsClient buildBigDataPoolsClient()
      Builds an instance of BigDataPoolsClient class.
      Returns:
      an instance of BigDataPoolsClient.

    • buildDataFlowClient

      public DataFlowClient buildDataFlowClient()
      Builds an instance of DataFlowClient class.
      Returns:
      an instance of DataFlowClient.

    • buildDataFlowDebugSessionClient

      public DataFlowDebugSessionClient buildDataFlowDebugSessionClient()
      Builds an instance of DataFlowDebugSessionClient class.
      Returns:
      an instance of DataFlowDebugSessionClient.

    • buildDatasetClient

      public DatasetClient buildDatasetClient()
      Builds an instance of DatasetClient class.
      Returns:
      an instance of DatasetClient.

    • buildWorkspaceGitRepoManagementClient

      public WorkspaceGitRepoManagementClient buildWorkspaceGitRepoManagementClient()
      Builds an instance of WorkspaceGitRepoManagementClient class.
      Returns:
      an instance of WorkspaceGitRepoManagementClient.

    • buildIntegrationRuntimesClient

      public IntegrationRuntimesClient buildIntegrationRuntimesClient()
      Builds an instance of IntegrationRuntimesClient class.
      Returns:
      an instance of IntegrationRuntimesClient.

    • buildLibraryClient

      public LibraryClient buildLibraryClient()
      Builds an instance of LibraryClient class.
      Returns:
      an instance of LibraryClient.

    • buildLinkedServiceClient

      public LinkedServiceClient buildLinkedServiceClient()
      Builds an instance of LinkedServiceClient class.
      Returns:
      an instance of LinkedServiceClient.

    • buildNotebookClient

      public NotebookClient buildNotebookClient()
      Builds an instance of NotebookClient class.
      Returns:
      an instance of NotebookClient.

    • buildNotebookOperationResultClient

      public NotebookOperationResultClient buildNotebookOperationResultClient()
      Builds an instance of NotebookOperationResultClient class.
      Returns:
      an instance of NotebookOperationResultClient.

    • buildPipelineClient

      public PipelineClient buildPipelineClient()
      Builds an instance of PipelineClient class.
      Returns:
      an instance of PipelineClient.

    • buildPipelineRunClient

      public PipelineRunClient buildPipelineRunClient()
      Builds an instance of PipelineRunClient class.
      Returns:
      an instance of PipelineRunClient.

    • buildSparkJobDefinitionClient

      public SparkJobDefinitionClient buildSparkJobDefinitionClient()
      Builds an instance of SparkJobDefinitionClient class.
      Returns:
      an instance of SparkJobDefinitionClient.

    • buildSqlPoolsClient

      public SqlPoolsClient buildSqlPoolsClient()
      Builds an instance of SqlPoolsClient class.
      Returns:
      an instance of SqlPoolsClient.

    • buildSqlScriptClient

      public SqlScriptClient buildSqlScriptClient()
      Builds an instance of SqlScriptClient class.
      Returns:
      an instance of SqlScriptClient.

    • buildTriggerClient

      public TriggerClient buildTriggerClient()
      Builds an instance of TriggerClient class.
      Returns:
      an instance of TriggerClient.

    • buildTriggerRunClient

      public TriggerRunClient buildTriggerRunClient()
      Builds an instance of TriggerRunClient class.
      Returns:
      an instance of TriggerRunClient.

    • buildWorkspaceClient

      public WorkspaceClient buildWorkspaceClient()
      Builds an instance of WorkspaceClient class.
      Returns:
      an instance of WorkspaceClient.