Package io.apicurio.registry.rest.client.groups.item.contracts

Class ContractsRequestBuilder

java.lang.Object
com.microsoft.kiota.BaseRequestBuilder
io.apicurio.registry.rest.client.groups.item.contracts.ContractsRequestBuilder
@Generated("com.microsoft.kiota") public class ContractsRequestBuilder extends com.microsoft.kiota.BaseRequestBuilder
Manage ODCS data contracts within a group.

  • Constructor Details

    • ContractsRequestBuilder

      public ContractsRequestBuilder(@Nonnull HashMap<String,Object> pathParameters, @Nonnull com.microsoft.kiota.RequestAdapter requestAdapter)
      Instantiates a new ContractsRequestBuilder and sets the default values.
      Parameters:
      pathParameters - Path parameters for the request
      requestAdapter - The request adapter to use to execute the requests.

    • ContractsRequestBuilder

      public ContractsRequestBuilder(@Nonnull String rawUrl, @Nonnull com.microsoft.kiota.RequestAdapter requestAdapter)
      Instantiates a new ContractsRequestBuilder and sets the default values.
      Parameters:
      rawUrl - The raw URL to use for the request builder.
      requestAdapter - The request adapter to use to execute the requests.

  • Method Details

    • byContractId

      @Nonnull public WithContractItemRequestBuilder byContractId(@Nonnull String contractId)
      Manage a specific ODCS contract.
      Parameters:
      contractId - The contract ID.
      Returns:
      a WithContractItemRequestBuilder

    • get

      @Nullable public List<OdcsContractSummary> get()
      Returns ODCS contracts in the specified group with pagination.
      Returns:
      a List<OdcsContractSummary>
      Throws:
      ProblemDetails - When receiving a 500 status code

    • get

      @Nullable public List<OdcsContractSummary> get(@Nullable Consumer<ContractsRequestBuilder.GetRequestConfiguration> requestConfiguration)
      Returns ODCS contracts in the specified group with pagination.
      Parameters:
      requestConfiguration - Configuration for the request such as headers, query parameters, and middleware options.
      Returns:
      a List<OdcsContractSummary>
      Throws:
      ProblemDetails - When receiving a 500 status code

    • post

      @Nullable public OdcsContractResult post(@Nonnull InputStream body)
      Submits an ODCS v3.1 YAML contract. The contract is parsed, stored as an ODCS_CONTRACT artifact, and its contents are projected onto the referenced schema artifact (labels, rules, field tags).
      Parameters:
      body - Binary request body
      Returns:
      a OdcsContractResult
      Throws:
      ProblemDetails - When receiving a 400 status code
      ProblemDetails - When receiving a 500 status code

    • post

      @Nullable public OdcsContractResult post(@Nonnull InputStream body, @Nullable Consumer<ContractsRequestBuilder.PostRequestConfiguration> requestConfiguration)
      Submits an ODCS v3.1 YAML contract. The contract is parsed, stored as an ODCS_CONTRACT artifact, and its contents are projected onto the referenced schema artifact (labels, rules, field tags).
      Parameters:
      body - Binary request body
      requestConfiguration - Configuration for the request such as headers, query parameters, and middleware options.
      Returns:
      a OdcsContractResult
      Throws:
      ProblemDetails - When receiving a 400 status code
      ProblemDetails - When receiving a 500 status code

    • toGetRequestInformation

      @Nonnull public com.microsoft.kiota.RequestInformation toGetRequestInformation()
      Returns ODCS contracts in the specified group with pagination.
      Returns:
      a RequestInformation

    • toGetRequestInformation

      @Nonnull public com.microsoft.kiota.RequestInformation toGetRequestInformation(@Nullable Consumer<ContractsRequestBuilder.GetRequestConfiguration> requestConfiguration)
      Returns ODCS contracts in the specified group with pagination.
      Parameters:
      requestConfiguration - Configuration for the request such as headers, query parameters, and middleware options.
      Returns:
      a RequestInformation

    • toPostRequestInformation

      @Nonnull public com.microsoft.kiota.RequestInformation toPostRequestInformation(@Nonnull InputStream body)
      Submits an ODCS v3.1 YAML contract. The contract is parsed, stored as an ODCS_CONTRACT artifact, and its contents are projected onto the referenced schema artifact (labels, rules, field tags).
      Parameters:
      body - Binary request body
      Returns:
      a RequestInformation

    • toPostRequestInformation

      @Nonnull public com.microsoft.kiota.RequestInformation toPostRequestInformation(@Nonnull InputStream body, @Nullable Consumer<ContractsRequestBuilder.PostRequestConfiguration> requestConfiguration)
      Submits an ODCS v3.1 YAML contract. The contract is parsed, stored as an ODCS_CONTRACT artifact, and its contents are projected onto the referenced schema artifact (labels, rules, field tags).
      Parameters:
      body - Binary request body
      requestConfiguration - Configuration for the request such as headers, query parameters, and middleware options.
      Returns:
      a RequestInformation

    • withUrl

      @Nonnull public ContractsRequestBuilder withUrl(@Nonnull String rawUrl)
      Returns a request builder with the provided arbitrary URL. Using this method means any other path or query parameters are ignored.
      Parameters:
      rawUrl - The raw URL to use for the request builder.
      Returns:
      a ContractsRequestBuilder