Package io.apicurio.registry.rest.client.groups.item.artifacts.item.versions.item

Class WithVersionExpressionItemRequestBuilder

java.lang.Object
com.microsoft.kiota.BaseRequestBuilder
io.apicurio.registry.rest.client.groups.item.artifacts.item.versions.item.WithVersionExpressionItemRequestBuilder
@Generated("com.microsoft.kiota") public class WithVersionExpressionItemRequestBuilder extends com.microsoft.kiota.BaseRequestBuilder
Manage a single version of a single artifact in the registry.

  • Constructor Details

    • WithVersionExpressionItemRequestBuilder

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

    • WithVersionExpressionItemRequestBuilder

      public WithVersionExpressionItemRequestBuilder(@Nonnull String rawUrl, @Nonnull com.microsoft.kiota.RequestAdapter requestAdapter)
      Instantiates a new WithVersionExpressionItemRequestBuilder 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

    • comments

      @Nonnull public CommentsRequestBuilder comments()
      Manage a collection of comments for an artifact version
      Returns:
      a CommentsRequestBuilder

    • content

      @Nonnull public ContentRequestBuilder content()
      Manage a single version of a single artifact in the registry.
      Returns:
      a ContentRequestBuilder

    • contract

      @Nonnull public ContractRequestBuilder contract()
      The contract property
      Returns:
      a ContractRequestBuilder

    • export

      @Nonnull public ExportRequestBuilder export()
      Export a Protobuf artifact version with dependencies as a ZIP file.
      Returns:
      a ExportRequestBuilder

    • references

      @Nonnull public ReferencesRequestBuilder references()
      Manage the references for a single version of an artifact in the registry.
      Returns:
      a ReferencesRequestBuilder

    • render

      @Nonnull public RenderRequestBuilder render()
      Render a prompt template artifact by substituting variables.
      Returns:
      a RenderRequestBuilder

    • state

      @Nonnull public StateRequestBuilder state()
      Manage the state of an artifact version.
      Returns:
      a StateRequestBuilder

    • delete

      public void delete()
      Deletes a single version of the artifact. Parameters `groupId`, `artifactId` and the unique `version`are needed. If this is the only version of the artifact, this operation is the same as deleting the entire artifact.This feature is disabled by default and it's discouraged for normal usage. To enable it, set the `registry.rest.artifact.deletion.enabled` property to true. This operation can fail for the following reasons:* No artifact with this `artifactId` exists (HTTP error `404`)* No version with this `version` exists (HTTP error `404`) * Feature is disabled (HTTP error `405`) * A server error occurred (HTTP error `500`)
      Throws:
      ProblemDetails - When receiving a 400 status code
      ProblemDetails - When receiving a 401 status code
      ProblemDetails - When receiving a 403 status code
      ProblemDetails - When receiving a 404 status code
      ProblemDetails - When receiving a 405 status code
      ProblemDetails - When receiving a 500 status code

    • delete

      public void delete(@Nullable Consumer<WithVersionExpressionItemRequestBuilder.DeleteRequestConfiguration> requestConfiguration)
      Deletes a single version of the artifact. Parameters `groupId`, `artifactId` and the unique `version`are needed. If this is the only version of the artifact, this operation is the same as deleting the entire artifact.This feature is disabled by default and it's discouraged for normal usage. To enable it, set the `registry.rest.artifact.deletion.enabled` property to true. This operation can fail for the following reasons:* No artifact with this `artifactId` exists (HTTP error `404`)* No version with this `version` exists (HTTP error `404`) * Feature is disabled (HTTP error `405`) * A server error occurred (HTTP error `500`)
      Parameters:
      requestConfiguration - Configuration for the request such as headers, query parameters, and middleware options.
      Throws:
      ProblemDetails - When receiving a 400 status code
      ProblemDetails - When receiving a 401 status code
      ProblemDetails - When receiving a 403 status code
      ProblemDetails - When receiving a 404 status code
      ProblemDetails - When receiving a 405 status code
      ProblemDetails - When receiving a 500 status code

    • get

      @Nullable public VersionMetaData get()
      Retrieves the metadata for a single version of the artifact. The version metadata is a subset of the artifact metadata and only includes the metadata that is specific tothe version (for example, this doesn't include `modifiedOn`).This operation can fail for the following reasons:* No artifact with this `artifactId` exists (HTTP error `404`)* No version with this `version` exists (HTTP error `404`)* A server error occurred (HTTP error `500`)
      Returns:
      a VersionMetaData
      Throws:
      ProblemDetails - When receiving a 400 status code
      ProblemDetails - When receiving a 401 status code
      ProblemDetails - When receiving a 403 status code
      ProblemDetails - When receiving a 404 status code
      ProblemDetails - When receiving a 500 status code

    • get

      @Nullable public VersionMetaData get(@Nullable Consumer<WithVersionExpressionItemRequestBuilder.GetRequestConfiguration> requestConfiguration)
      Retrieves the metadata for a single version of the artifact. The version metadata is a subset of the artifact metadata and only includes the metadata that is specific tothe version (for example, this doesn't include `modifiedOn`).This operation can fail for the following reasons:* No artifact with this `artifactId` exists (HTTP error `404`)* No version with this `version` exists (HTTP error `404`)* A server error occurred (HTTP error `500`)
      Parameters:
      requestConfiguration - Configuration for the request such as headers, query parameters, and middleware options.
      Returns:
      a VersionMetaData
      Throws:
      ProblemDetails - When receiving a 400 status code
      ProblemDetails - When receiving a 401 status code
      ProblemDetails - When receiving a 403 status code
      ProblemDetails - When receiving a 404 status code
      ProblemDetails - When receiving a 500 status code

    • put

      public void put(@Nonnull EditableVersionMetaData body)
      Updates the user-editable portion of the artifact version's metadata. Only some of the metadata fields are editable by the user. For example, `description` is editable, but `createdOn` is not.This operation can fail for the following reasons:* No artifact with this `artifactId` exists (HTTP error `404`)* No version with this `version` exists (HTTP error `404`)* A server error occurred (HTTP error `500`)
      Parameters:
      body - The request body
      Throws:
      ProblemDetails - When receiving a 400 status code
      ProblemDetails - When receiving a 401 status code
      ProblemDetails - When receiving a 403 status code
      ProblemDetails - When receiving a 404 status code
      ProblemDetails - When receiving a 500 status code

    • put

      public void put(@Nonnull EditableVersionMetaData body, @Nullable Consumer<WithVersionExpressionItemRequestBuilder.PutRequestConfiguration> requestConfiguration)
      Updates the user-editable portion of the artifact version's metadata. Only some of the metadata fields are editable by the user. For example, `description` is editable, but `createdOn` is not.This operation can fail for the following reasons:* No artifact with this `artifactId` exists (HTTP error `404`)* No version with this `version` exists (HTTP error `404`)* A server error occurred (HTTP error `500`)
      Parameters:
      body - The request body
      requestConfiguration - Configuration for the request such as headers, query parameters, and middleware options.
      Throws:
      ProblemDetails - When receiving a 400 status code
      ProblemDetails - When receiving a 401 status code
      ProblemDetails - When receiving a 403 status code
      ProblemDetails - When receiving a 404 status code
      ProblemDetails - When receiving a 500 status code

    • toDeleteRequestInformation

      @Nonnull public com.microsoft.kiota.RequestInformation toDeleteRequestInformation()
      Deletes a single version of the artifact. Parameters `groupId`, `artifactId` and the unique `version`are needed. If this is the only version of the artifact, this operation is the same as deleting the entire artifact.This feature is disabled by default and it's discouraged for normal usage. To enable it, set the `registry.rest.artifact.deletion.enabled` property to true. This operation can fail for the following reasons:* No artifact with this `artifactId` exists (HTTP error `404`)* No version with this `version` exists (HTTP error `404`) * Feature is disabled (HTTP error `405`) * A server error occurred (HTTP error `500`)
      Returns:
      a RequestInformation

    • toDeleteRequestInformation

      @Nonnull public com.microsoft.kiota.RequestInformation toDeleteRequestInformation(@Nullable Consumer<WithVersionExpressionItemRequestBuilder.DeleteRequestConfiguration> requestConfiguration)
      Deletes a single version of the artifact. Parameters `groupId`, `artifactId` and the unique `version`are needed. If this is the only version of the artifact, this operation is the same as deleting the entire artifact.This feature is disabled by default and it's discouraged for normal usage. To enable it, set the `registry.rest.artifact.deletion.enabled` property to true. This operation can fail for the following reasons:* No artifact with this `artifactId` exists (HTTP error `404`)* No version with this `version` exists (HTTP error `404`) * Feature is disabled (HTTP error `405`) * A server error occurred (HTTP error `500`)
      Parameters:
      requestConfiguration - Configuration for the request such as headers, query parameters, and middleware options.
      Returns:
      a RequestInformation

    • toGetRequestInformation

      @Nonnull public com.microsoft.kiota.RequestInformation toGetRequestInformation()
      Retrieves the metadata for a single version of the artifact. The version metadata is a subset of the artifact metadata and only includes the metadata that is specific tothe version (for example, this doesn't include `modifiedOn`).This operation can fail for the following reasons:* No artifact with this `artifactId` exists (HTTP error `404`)* No version with this `version` exists (HTTP error `404`)* A server error occurred (HTTP error `500`)
      Returns:
      a RequestInformation

    • toGetRequestInformation

      @Nonnull public com.microsoft.kiota.RequestInformation toGetRequestInformation(@Nullable Consumer<WithVersionExpressionItemRequestBuilder.GetRequestConfiguration> requestConfiguration)
      Retrieves the metadata for a single version of the artifact. The version metadata is a subset of the artifact metadata and only includes the metadata that is specific tothe version (for example, this doesn't include `modifiedOn`).This operation can fail for the following reasons:* No artifact with this `artifactId` exists (HTTP error `404`)* No version with this `version` exists (HTTP error `404`)* A server error occurred (HTTP error `500`)
      Parameters:
      requestConfiguration - Configuration for the request such as headers, query parameters, and middleware options.
      Returns:
      a RequestInformation

    • toPutRequestInformation

      @Nonnull public com.microsoft.kiota.RequestInformation toPutRequestInformation(@Nonnull EditableVersionMetaData body)
      Updates the user-editable portion of the artifact version's metadata. Only some of the metadata fields are editable by the user. For example, `description` is editable, but `createdOn` is not.This operation can fail for the following reasons:* No artifact with this `artifactId` exists (HTTP error `404`)* No version with this `version` exists (HTTP error `404`)* A server error occurred (HTTP error `500`)
      Parameters:
      body - The request body
      Returns:
      a RequestInformation

    • toPutRequestInformation

      @Nonnull public com.microsoft.kiota.RequestInformation toPutRequestInformation(@Nonnull EditableVersionMetaData body, @Nullable Consumer<WithVersionExpressionItemRequestBuilder.PutRequestConfiguration> requestConfiguration)
      Updates the user-editable portion of the artifact version's metadata. Only some of the metadata fields are editable by the user. For example, `description` is editable, but `createdOn` is not.This operation can fail for the following reasons:* No artifact with this `artifactId` exists (HTTP error `404`)* No version with this `version` exists (HTTP error `404`)* A server error occurred (HTTP error `500`)
      Parameters:
      body - The request body
      requestConfiguration - Configuration for the request such as headers, query parameters, and middleware options.
      Returns:
      a RequestInformation

    • withUrl

      @Nonnull public WithVersionExpressionItemRequestBuilder 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 WithVersionExpressionItemRequestBuilder