Package com.azure.verticals.agrifood.farming

Class PlantingDataClientBuilder

java.lang.Object
com.azure.verticals.agrifood.farming.PlantingDataClientBuilder
All Implemented Interfaces:
com.azure.core.client.traits.ConfigurationTrait<PlantingDataClientBuilder>, com.azure.core.client.traits.EndpointTrait<PlantingDataClientBuilder>, com.azure.core.client.traits.HttpTrait<PlantingDataClientBuilder>, com.azure.core.client.traits.TokenCredentialTrait<PlantingDataClientBuilder>
public final class PlantingDataClientBuilder extends Object implements com.azure.core.client.traits.HttpTrait<PlantingDataClientBuilder>, com.azure.core.client.traits.ConfigurationTrait<PlantingDataClientBuilder>, com.azure.core.client.traits.TokenCredentialTrait<PlantingDataClientBuilder>, com.azure.core.client.traits.EndpointTrait<PlantingDataClientBuilder>
A builder for creating a new instance of the PlantingDataClient type.

  • Constructor Details

    • PlantingDataClientBuilder

      public PlantingDataClientBuilder()
      Create an instance of the PlantingDataClientBuilder.

  • Method Details

    • pipeline

      public PlantingDataClientBuilder pipeline(com.azure.core.http.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 com.azure.core.client.traits.HttpTrait<PlantingDataClientBuilder>
      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 PlantingDataClientBuilder httpClient(com.azure.core.http.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 com.azure.core.client.traits.HttpTrait<PlantingDataClientBuilder>
      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 PlantingDataClientBuilder httpLogOptions(com.azure.core.http.policy.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 com.azure.core.client.traits.HttpTrait<PlantingDataClientBuilder>
      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 PlantingDataClientBuilder clientOptions(com.azure.core.util.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 com.azure.core.client.traits.HttpTrait<PlantingDataClientBuilder>
      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:
      • HttpClientOptions

    • retryOptions

      public PlantingDataClientBuilder retryOptions(com.azure.core.http.policy.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 com.azure.core.client.traits.HttpTrait<PlantingDataClientBuilder>
      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 PlantingDataClientBuilder addPolicy(com.azure.core.http.policy.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 com.azure.core.client.traits.HttpTrait<PlantingDataClientBuilder>
      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 PlantingDataClientBuilder configuration(com.azure.core.util.Configuration configuration)
      Sets the client-specific configuration used to retrieve client or global configuration properties when building a client..
      Specified by:
      configuration in interface com.azure.core.client.traits.ConfigurationTrait<PlantingDataClientBuilder>
      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 PlantingDataClientBuilder credential(com.azure.core.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 com.azure.core.client.traits.TokenCredentialTrait<PlantingDataClientBuilder>
      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 PlantingDataClientBuilder endpoint(String endpoint)
      Sets the service endpoint that will be connected to by clients..
      Specified by:
      endpoint in interface com.azure.core.client.traits.EndpointTrait<PlantingDataClientBuilder>
      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.

    • serviceVersion

      public PlantingDataClientBuilder serviceVersion(FarmBeatsServiceVersion serviceVersion)
      Sets Service version.
      Parameters:
      serviceVersion - the serviceVersion value.
      Returns:
      the PlantingDataClientBuilder.

    • retryPolicy

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

    • buildAsyncClient

      public PlantingDataAsyncClient buildAsyncClient()
      Builds an instance of PlantingDataAsyncClient class.
      Returns:
      an instance of PlantingDataAsyncClient.

    • buildClient

      public PlantingDataClient buildClient()
      Builds an instance of PlantingDataClient class.
      Returns:
      an instance of PlantingDataClient.