Package io.apicurio.registry.rest.client.search.versions

Class VersionsRequestBuilder.PostQueryParameters

java.lang.Object

io.apicurio.registry.rest.client.search.versions.VersionsRequestBuilder.PostQueryParameters

All Implemented Interfaces:

com.microsoft.kiota.QueryParameters

Enclosing class:

VersionsRequestBuilder

@Generated("com.microsoft.kiota")
public class VersionsRequestBuilder.PostQueryParameters
extends Object
implements com.microsoft.kiota.QueryParameters

Returns a paginated list of all versions that match the posted content.This operation can fail for the following reasons:* Provided content (request body) was empty (HTTP error `400`)* A server error occurred (HTTP error `500`)

Field Summary

Fields

Modifier and Type	Field	Description
String	artifactId	Filter by artifact Id.
String	artifactType	Indicates the type of artifact represented by the content being used for the search.
Boolean	canonical	Parameter that can be set to `true` to indicate that the server should "canonicalize" the content when searching for matching artifacts.
String	groupId	Filter by group Id.
Integer	limit	The number of versions to return.
Integer	offset	The number of versions to skip before starting to collect the result set.
SortOrder	order	Sort order, ascending (`asc`) or descending (`desc`).
VersionSortBy	orderby	The field to sort by.

Constructor Summary

Constructors

Constructor	Description
PostQueryParameters()

Method Summary

Modifier and Type	Method	Description
Map<String,Object>	toQueryParameters()	Extracts the query parameters into a map for the URI template parsing.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

artifactId

@Nullable
public String artifactId

Filter by artifact Id.

artifactType

@Nullable
public String artifactType

Indicates the type of artifact represented by the content being used for the search. This is only needed when using the `canonical` query parameter, so that the server knows how to canonicalize the content prior to searching for matching versions.

canonical

@Nullable
public Boolean canonical

Parameter that can be set to `true` to indicate that the server should "canonicalize" the content when searching for matching artifacts. Canonicalization is unique to each artifact type, but typically involves removing any extra whitespace and formatting the content in a consistent manner. Must be used along with the `artifactType` query parameter.

groupId

@Nullable
public String groupId

Filter by group Id.

limit

@Nullable
public Integer limit

The number of versions to return. Defaults to 20.

offset

@Nullable
public Integer offset

The number of versions to skip before starting to collect the result set. Defaults to 0.

order

@Nullable
public SortOrder order

Sort order, ascending (`asc`) or descending (`desc`).

orderby

@Nullable
public VersionSortBy orderby

The field to sort by. Can be one of:* `name`* `createdOn`

Constructor Details

PostQueryParameters

public PostQueryParameters()

Method Details

toQueryParameters

@Nonnull
public Map<String,Object> toQueryParameters()

Extracts the query parameters into a map for the URI template parsing.

Specified by:

toQueryParameters in interface com.microsoft.kiota.QueryParameters

Returns:

a Map<String,Object>