software.amazon.awssdk.services.workdocs.model.DescribeGroupsRequest Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of workdocs Show documentation
Show all versions of workdocs Show documentation
The AWS Java SDK for Amazon WorkDocs module holds the client classes that are used for
communicating with Amazon WorkDocs Service.
/*
* Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
*
* Licensed under the Apache License, Version 2.0 (the "License"). You may not use this file except in compliance with
* the License. A copy of the License is located at
*
* http://aws.amazon.com/apache2.0
*
* or in the "license" file accompanying this file. This file is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR
* CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions
* and limitations under the License.
*/
package software.amazon.awssdk.services.workdocs.model;
import java.util.Arrays;
import java.util.Collections;
import java.util.List;
import java.util.Objects;
import java.util.Optional;
import java.util.function.BiConsumer;
import java.util.function.Consumer;
import java.util.function.Function;
import software.amazon.awssdk.annotations.Generated;
import software.amazon.awssdk.awscore.AwsRequestOverrideConfiguration;
import software.amazon.awssdk.core.SdkField;
import software.amazon.awssdk.core.SdkPojo;
import software.amazon.awssdk.core.protocol.MarshallLocation;
import software.amazon.awssdk.core.protocol.MarshallingType;
import software.amazon.awssdk.core.traits.LocationTrait;
import software.amazon.awssdk.utils.ToString;
import software.amazon.awssdk.utils.builder.CopyableBuilder;
import software.amazon.awssdk.utils.builder.ToCopyableBuilder;
/**
*/
@Generated("software.amazon.awssdk:codegen")
public final class DescribeGroupsRequest extends WorkDocsRequest implements
ToCopyableBuilder {
private static final SdkField AUTHENTICATION_TOKEN_FIELD = SdkField. builder(MarshallingType.STRING)
.getter(getter(DescribeGroupsRequest::authenticationToken)).setter(setter(Builder::authenticationToken))
.traits(LocationTrait.builder().location(MarshallLocation.HEADER).locationName("Authentication").build()).build();
private static final SdkField SEARCH_QUERY_FIELD = SdkField. builder(MarshallingType.STRING)
.getter(getter(DescribeGroupsRequest::searchQuery)).setter(setter(Builder::searchQuery))
.traits(LocationTrait.builder().location(MarshallLocation.QUERY_PARAM).locationName("searchQuery").build()).build();
private static final SdkField ORGANIZATION_ID_FIELD = SdkField. builder(MarshallingType.STRING)
.getter(getter(DescribeGroupsRequest::organizationId)).setter(setter(Builder::organizationId))
.traits(LocationTrait.builder().location(MarshallLocation.QUERY_PARAM).locationName("organizationId").build())
.build();
private static final SdkField MARKER_FIELD = SdkField. builder(MarshallingType.STRING)
.getter(getter(DescribeGroupsRequest::marker)).setter(setter(Builder::marker))
.traits(LocationTrait.builder().location(MarshallLocation.QUERY_PARAM).locationName("marker").build()).build();
private static final SdkField LIMIT_FIELD = SdkField. builder(MarshallingType.INTEGER)
.getter(getter(DescribeGroupsRequest::limit)).setter(setter(Builder::limit))
.traits(LocationTrait.builder().location(MarshallLocation.QUERY_PARAM).locationName("limit").build()).build();
private static final List> SDK_FIELDS = Collections.unmodifiableList(Arrays.asList(AUTHENTICATION_TOKEN_FIELD,
SEARCH_QUERY_FIELD, ORGANIZATION_ID_FIELD, MARKER_FIELD, LIMIT_FIELD));
private final String authenticationToken;
private final String searchQuery;
private final String organizationId;
private final String marker;
private final Integer limit;
private DescribeGroupsRequest(BuilderImpl builder) {
super(builder);
this.authenticationToken = builder.authenticationToken;
this.searchQuery = builder.searchQuery;
this.organizationId = builder.organizationId;
this.marker = builder.marker;
this.limit = builder.limit;
}
/**
*
* Amazon WorkDocs authentication token. Not required when using AWS administrator credentials to access the API.
*
*
* @return Amazon WorkDocs authentication token. Not required when using AWS administrator credentials to access the
* API.
*/
public String authenticationToken() {
return authenticationToken;
}
/**
*
* A query to describe groups by group name.
*
*
* @return A query to describe groups by group name.
*/
public String searchQuery() {
return searchQuery;
}
/**
*
* The ID of the organization.
*
*
* @return The ID of the organization.
*/
public String organizationId() {
return organizationId;
}
/**
*
* The marker for the next set of results. (You received this marker from a previous call.)
*
*
* @return The marker for the next set of results. (You received this marker from a previous call.)
*/
public String marker() {
return marker;
}
/**
*
* The maximum number of items to return with this call.
*
*
* @return The maximum number of items to return with this call.
*/
public Integer limit() {
return limit;
}
@Override
public Builder toBuilder() {
return new BuilderImpl(this);
}
public static Builder builder() {
return new BuilderImpl();
}
public static Class serializableBuilderClass() {
return BuilderImpl.class;
}
@Override
public int hashCode() {
int hashCode = 1;
hashCode = 31 * hashCode + super.hashCode();
hashCode = 31 * hashCode + Objects.hashCode(authenticationToken());
hashCode = 31 * hashCode + Objects.hashCode(searchQuery());
hashCode = 31 * hashCode + Objects.hashCode(organizationId());
hashCode = 31 * hashCode + Objects.hashCode(marker());
hashCode = 31 * hashCode + Objects.hashCode(limit());
return hashCode;
}
@Override
public boolean equals(Object obj) {
return super.equals(obj) && equalsBySdkFields(obj);
}
@Override
public boolean equalsBySdkFields(Object obj) {
if (this == obj) {
return true;
}
if (obj == null) {
return false;
}
if (!(obj instanceof DescribeGroupsRequest)) {
return false;
}
DescribeGroupsRequest other = (DescribeGroupsRequest) obj;
return Objects.equals(authenticationToken(), other.authenticationToken())
&& Objects.equals(searchQuery(), other.searchQuery()) && Objects.equals(organizationId(), other.organizationId())
&& Objects.equals(marker(), other.marker()) && Objects.equals(limit(), other.limit());
}
/**
* Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be
* redacted from this string using a placeholder value.
*/
@Override
public String toString() {
return ToString.builder("DescribeGroupsRequest")
.add("AuthenticationToken", authenticationToken() == null ? null : "*** Sensitive Data Redacted ***")
.add("SearchQuery", searchQuery() == null ? null : "*** Sensitive Data Redacted ***")
.add("OrganizationId", organizationId()).add("Marker", marker()).add("Limit", limit()).build();
}
public Optional getValueForField(String fieldName, Class clazz) {
switch (fieldName) {
case "AuthenticationToken":
return Optional.ofNullable(clazz.cast(authenticationToken()));
case "SearchQuery":
return Optional.ofNullable(clazz.cast(searchQuery()));
case "OrganizationId":
return Optional.ofNullable(clazz.cast(organizationId()));
case "Marker":
return Optional.ofNullable(clazz.cast(marker()));
case "Limit":
return Optional.ofNullable(clazz.cast(limit()));
default:
return Optional.empty();
}
}
@Override
public List> sdkFields() {
return SDK_FIELDS;
}
private static Function getter(Function g) {
return obj -> g.apply((DescribeGroupsRequest) obj);
}
private static BiConsumer setter(BiConsumer s) {
return (obj, val) -> s.accept((Builder) obj, val);
}
public interface Builder extends WorkDocsRequest.Builder, SdkPojo, CopyableBuilder {
/**
*
* Amazon WorkDocs authentication token. Not required when using AWS administrator credentials to access the
* API.
*
*
* @param authenticationToken
* Amazon WorkDocs authentication token. Not required when using AWS administrator credentials to access
* the API.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder authenticationToken(String authenticationToken);
/**
*
* A query to describe groups by group name.
*
*
* @param searchQuery
* A query to describe groups by group name.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder searchQuery(String searchQuery);
/**
*
* The ID of the organization.
*
*
* @param organizationId
* The ID of the organization.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder organizationId(String organizationId);
/**
*
* The marker for the next set of results. (You received this marker from a previous call.)
*
*
* @param marker
* The marker for the next set of results. (You received this marker from a previous call.)
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder marker(String marker);
/**
*
* The maximum number of items to return with this call.
*
*
* @param limit
* The maximum number of items to return with this call.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder limit(Integer limit);
@Override
Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration);
@Override
Builder overrideConfiguration(Consumer builderConsumer);
}
static final class BuilderImpl extends WorkDocsRequest.BuilderImpl implements Builder {
private String authenticationToken;
private String searchQuery;
private String organizationId;
private String marker;
private Integer limit;
private BuilderImpl() {
}
private BuilderImpl(DescribeGroupsRequest model) {
super(model);
authenticationToken(model.authenticationToken);
searchQuery(model.searchQuery);
organizationId(model.organizationId);
marker(model.marker);
limit(model.limit);
}
public final String getAuthenticationToken() {
return authenticationToken;
}
@Override
public final Builder authenticationToken(String authenticationToken) {
this.authenticationToken = authenticationToken;
return this;
}
public final void setAuthenticationToken(String authenticationToken) {
this.authenticationToken = authenticationToken;
}
public final String getSearchQuery() {
return searchQuery;
}
@Override
public final Builder searchQuery(String searchQuery) {
this.searchQuery = searchQuery;
return this;
}
public final void setSearchQuery(String searchQuery) {
this.searchQuery = searchQuery;
}
public final String getOrganizationId() {
return organizationId;
}
@Override
public final Builder organizationId(String organizationId) {
this.organizationId = organizationId;
return this;
}
public final void setOrganizationId(String organizationId) {
this.organizationId = organizationId;
}
public final String getMarker() {
return marker;
}
@Override
public final Builder marker(String marker) {
this.marker = marker;
return this;
}
public final void setMarker(String marker) {
this.marker = marker;
}
public final Integer getLimit() {
return limit;
}
@Override
public final Builder limit(Integer limit) {
this.limit = limit;
return this;
}
public final void setLimit(Integer limit) {
this.limit = limit;
}
@Override
public Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration) {
super.overrideConfiguration(overrideConfiguration);
return this;
}
@Override
public Builder overrideConfiguration(Consumer builderConsumer) {
super.overrideConfiguration(builderConsumer);
return this;
}
@Override
public DescribeGroupsRequest build() {
return new DescribeGroupsRequest(this);
}
@Override
public List> sdkFields() {
return SDK_FIELDS;
}
}
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy