Package io.apicurio.registry.rest.client.v2.search.artifacts

Class ArtifactsRequestBuilder.GetQueryParameters

java.lang.Object

io.apicurio.registry.rest.client.v2.search.artifacts.ArtifactsRequestBuilder.GetQueryParameters

All Implemented Interfaces:

com.microsoft.kiota.QueryParameters

Enclosing class:

ArtifactsRequestBuilder

@Generated("com.microsoft.kiota")
public class ArtifactsRequestBuilder.GetQueryParameters
extends Object
implements com.microsoft.kiota.QueryParameters

Returns a paginated list of all artifacts that match the provided filter criteria.

Field Summary

Fields

Modifier and Type	Field	Description
Long	contentId	Filter by contentId.
String	description	Filter by description.
Long	globalId	Filter by globalId.
String	group	Filter by artifact group.
String[]	labels	Filter by label.
Integer	limit	The number of artifacts to return.
String	name	Filter by artifact name.
Integer	offset	The number of artifacts to skip before starting to collect the result set.
SortOrder	order	Sort order, ascending (`asc`) or descending (`desc`).
SortBy	orderby	The field to sort by.
String[]	properties	Filter by one or more name/value property.

Constructor Summary

Constructors

Constructor	Description
GetQueryParameters()

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

contentId

@Nullable
public Long contentId

Filter by contentId.

description

@Nullable
public String description

Filter by description.

globalId

@Nullable
public Long globalId

Filter by globalId.

group

@Nullable
public String group

Filter by artifact group.

labels

@Nullable
public String[] labels

Filter by label. Include one or more label to only return artifacts containing all of thespecified labels.

limit

@Nullable
public Integer limit

The number of artifacts to return. Defaults to 20.

name

@Nullable
public String name

Filter by artifact name.

offset

@Nullable
public Integer offset

The number of artifacts 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 SortBy orderby

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

properties

@Nullable
public String[] properties

Filter by one or more name/value property. Separate each name/value pair using a colon. Forexample `properties=foo:bar` will return only artifacts with a custom property named `foo`and value `bar`.

Constructor Details

GetQueryParameters

public GetQueryParameters()

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>