io.apicurio.registry.rest.client.search.groups.GroupsRequestBuilder Maven / Gradle / Ivy
package io.apicurio.registry.rest.client.search.groups;
import com.microsoft.kiota.BaseRequestBuilder;
import com.microsoft.kiota.BaseRequestConfiguration;
import com.microsoft.kiota.HttpMethod;
import com.microsoft.kiota.QueryParameters;
import com.microsoft.kiota.RequestAdapter;
import com.microsoft.kiota.RequestInformation;
import com.microsoft.kiota.RequestOption;
import com.microsoft.kiota.serialization.Parsable;
import com.microsoft.kiota.serialization.ParsableFactory;
import io.apicurio.registry.rest.client.models.GroupSearchResults;
import io.apicurio.registry.rest.client.models.GroupSortBy;
import io.apicurio.registry.rest.client.models.ProblemDetails;
import io.apicurio.registry.rest.client.models.SortOrder;
import java.util.Collection;
import java.util.HashMap;
import java.util.Map;
import java.util.Objects;
/**
* Search for groups in the registry.
*/
@jakarta.annotation.Generated("com.microsoft.kiota")
public class GroupsRequestBuilder extends BaseRequestBuilder {
/**
* Instantiates a new {@link GroupsRequestBuilder} and sets the default values.
* @param pathParameters Path parameters for the request
* @param requestAdapter The request adapter to use to execute the requests.
*/
public GroupsRequestBuilder(@jakarta.annotation.Nonnull final HashMap pathParameters, @jakarta.annotation.Nonnull final RequestAdapter requestAdapter) {
super(requestAdapter, "{+baseurl}/search/groups{?description*,groupId*,labels*,limit*,offset*,order*,orderby*}", pathParameters);
}
/**
* Instantiates a new {@link GroupsRequestBuilder} and sets the default values.
* @param rawUrl The raw URL to use for the request builder.
* @param requestAdapter The request adapter to use to execute the requests.
*/
public GroupsRequestBuilder(@jakarta.annotation.Nonnull final String rawUrl, @jakarta.annotation.Nonnull final RequestAdapter requestAdapter) {
super(requestAdapter, "{+baseurl}/search/groups{?description*,groupId*,labels*,limit*,offset*,order*,orderby*}", rawUrl);
}
/**
* Returns a paginated list of all groups that match the provided filter criteria.This operation can fail for the following reasons:* A server error occurred (HTTP error `500`)
* @return a {@link GroupSearchResults}
* @throws ProblemDetails When receiving a 500 status code
*/
@jakarta.annotation.Nullable
public GroupSearchResults get() {
return get(null);
}
/**
* Returns a paginated list of all groups that match the provided filter criteria.This operation can fail for the following reasons:* A server error occurred (HTTP error `500`)
* @param requestConfiguration Configuration for the request such as headers, query parameters, and middleware options.
* @return a {@link GroupSearchResults}
* @throws ProblemDetails When receiving a 500 status code
*/
@jakarta.annotation.Nullable
public GroupSearchResults get(@jakarta.annotation.Nullable final java.util.function.Consumer requestConfiguration) {
final RequestInformation requestInfo = toGetRequestInformation(requestConfiguration);
final HashMap> errorMapping = new HashMap>();
errorMapping.put("500", ProblemDetails::createFromDiscriminatorValue);
return this.requestAdapter.send(requestInfo, errorMapping, GroupSearchResults::createFromDiscriminatorValue);
}
/**
* Returns a paginated list of all groups that match the provided filter criteria.This operation can fail for the following reasons:* A server error occurred (HTTP error `500`)
* @return a {@link RequestInformation}
*/
@jakarta.annotation.Nonnull
public RequestInformation toGetRequestInformation() {
return toGetRequestInformation(null);
}
/**
* Returns a paginated list of all groups that match the provided filter criteria.This operation can fail for the following reasons:* A server error occurred (HTTP error `500`)
* @param requestConfiguration Configuration for the request such as headers, query parameters, and middleware options.
* @return a {@link RequestInformation}
*/
@jakarta.annotation.Nonnull
public RequestInformation toGetRequestInformation(@jakarta.annotation.Nullable final java.util.function.Consumer requestConfiguration) {
final RequestInformation requestInfo = new RequestInformation(HttpMethod.GET, urlTemplate, pathParameters);
requestInfo.configure(requestConfiguration, GetRequestConfiguration::new, x -> x.queryParameters);
requestInfo.headers.tryAdd("Accept", "application/json");
return requestInfo;
}
/**
* Returns a request builder with the provided arbitrary URL. Using this method means any other path or query parameters are ignored.
* @param rawUrl The raw URL to use for the request builder.
* @return a {@link GroupsRequestBuilder}
*/
@jakarta.annotation.Nonnull
public GroupsRequestBuilder withUrl(@jakarta.annotation.Nonnull final String rawUrl) {
Objects.requireNonNull(rawUrl);
return new GroupsRequestBuilder(rawUrl, requestAdapter);
}
/**
* Returns a paginated list of all groups that match the provided filter criteria.This operation can fail for the following reasons:* A server error occurred (HTTP error `500`)
*/
@jakarta.annotation.Generated("com.microsoft.kiota")
public class GetQueryParameters implements QueryParameters {
/**
* Filter by description.
*/
@jakarta.annotation.Nullable
public String description;
/**
* Filter by group name.
*/
@jakarta.annotation.Nullable
public String groupId;
/**
* Filter by one or more name/value label. Separate each name/value pair using a colon. Forexample `labels=foo:bar` will return only artifacts with a label named `foo`and value `bar`.
*/
@jakarta.annotation.Nullable
public String[] labels;
/**
* The number of artifacts to return. Defaults to 20.
*/
@jakarta.annotation.Nullable
public Integer limit;
/**
* The number of artifacts to skip before starting to collect the result set. Defaults to 0.
*/
@jakarta.annotation.Nullable
public Integer offset;
/**
* Sort order, ascending (`asc`) or descending (`desc`).
*/
@jakarta.annotation.Nullable
public SortOrder order;
/**
* The field to sort by. Can be one of:* `name`* `createdOn`
*/
@jakarta.annotation.Nullable
public GroupSortBy orderby;
/**
* Extracts the query parameters into a map for the URI template parsing.
* @return a {@link Map}
*/
@jakarta.annotation.Nonnull
public Map toQueryParameters() {
final Map allQueryParams = new HashMap();
allQueryParams.put("order", order);
allQueryParams.put("orderby", orderby);
allQueryParams.put("description", description);
allQueryParams.put("groupId", groupId);
allQueryParams.put("limit", limit);
allQueryParams.put("offset", offset);
allQueryParams.put("labels", labels);
return allQueryParams;
}
}
/**
* Configuration for the request such as headers, query parameters, and middleware options.
*/
@jakarta.annotation.Generated("com.microsoft.kiota")
public class GetRequestConfiguration extends BaseRequestConfiguration {
/**
* Request query parameters
*/
@jakarta.annotation.Nullable
public GetQueryParameters queryParameters = new GetQueryParameters();
}
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy