software.amazon.awssdk.services.workdocs.model.DescribeGroupsRequest Maven / Gradle / Ivy
/*
* 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)
.memberName("AuthenticationToken").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)
.memberName("SearchQuery").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)
.memberName("OrganizationId").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).memberName("Marker")
.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).memberName("Limit")
.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 final String authenticationToken() {
return authenticationToken;
}
/**
*
* A query to describe groups by group name.
*
*
* @return A query to describe groups by group name.
*/
public final String searchQuery() {
return searchQuery;
}
/**
*
* The ID of the organization.
*
*
* @return The ID of the organization.
*/
public final 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 final 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 final Integer limit() {
return limit;
}
@Override
public Builder toBuilder() {
return new BuilderImpl(this);
}
public static Builder builder() {
return new BuilderImpl();
}
public static Class extends Builder> serializableBuilderClass() {
return BuilderImpl.class;
}
@Override
public final 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 final boolean equals(Object obj) {
return super.equals(obj) && equalsBySdkFields(obj);
}
@Override
public final 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 final 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 final 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 final List> sdkFields() {
return SDK_FIELDS;
}
private static Function
© 2015 - 2025 Weber Informatics LLC | Privacy Policy