software.amazon.awssdk.services.iam.model.GetOrganizationsAccessReportRequest Maven / Gradle / Ivy
Show all versions of iam Show documentation
/*
* 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.iam.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 GetOrganizationsAccessReportRequest extends IamRequest implements
ToCopyableBuilder {
private static final SdkField JOB_ID_FIELD = SdkField. builder(MarshallingType.STRING).memberName("JobId")
.getter(getter(GetOrganizationsAccessReportRequest::jobId)).setter(setter(Builder::jobId))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("JobId").build()).build();
private static final SdkField MAX_ITEMS_FIELD = SdkField. builder(MarshallingType.INTEGER)
.memberName("MaxItems").getter(getter(GetOrganizationsAccessReportRequest::maxItems))
.setter(setter(Builder::maxItems))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("MaxItems").build()).build();
private static final SdkField MARKER_FIELD = SdkField. builder(MarshallingType.STRING).memberName("Marker")
.getter(getter(GetOrganizationsAccessReportRequest::marker)).setter(setter(Builder::marker))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("Marker").build()).build();
private static final SdkField SORT_KEY_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("SortKey").getter(getter(GetOrganizationsAccessReportRequest::sortKeyAsString))
.setter(setter(Builder::sortKey))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("SortKey").build()).build();
private static final List> SDK_FIELDS = Collections.unmodifiableList(Arrays.asList(JOB_ID_FIELD, MAX_ITEMS_FIELD,
MARKER_FIELD, SORT_KEY_FIELD));
private final String jobId;
private final Integer maxItems;
private final String marker;
private final String sortKey;
private GetOrganizationsAccessReportRequest(BuilderImpl builder) {
super(builder);
this.jobId = builder.jobId;
this.maxItems = builder.maxItems;
this.marker = builder.marker;
this.sortKey = builder.sortKey;
}
/**
*
* The identifier of the request generated by the GenerateOrganizationsAccessReport operation.
*
*
* @return The identifier of the request generated by the GenerateOrganizationsAccessReport operation.
*/
public final String jobId() {
return jobId;
}
/**
*
* Use this only when paginating results to indicate the maximum number of items you want in the response. If
* additional items exist beyond the maximum you specify, the IsTruncated response element is
* true.
*
*
* If you do not include this parameter, the number of items defaults to 100. Note that IAM might return fewer
* results, even when there are more results available. In that case, the IsTruncated response element
* returns true, and Marker contains a value to include in the subsequent call that tells
* the service where to continue from.
*
*
* @return Use this only when paginating results to indicate the maximum number of items you want in the response.
* If additional items exist beyond the maximum you specify, the IsTruncated response element
* is true.
*
* If you do not include this parameter, the number of items defaults to 100. Note that IAM might return
* fewer results, even when there are more results available. In that case, the IsTruncated
* response element returns true, and Marker contains a value to include in the
* subsequent call that tells the service where to continue from.
*/
public final Integer maxItems() {
return maxItems;
}
/**
*
* Use this parameter only when paginating results and only after you receive a response indicating that the results
* are truncated. Set it to the value of the Marker element in the response that you received to
* indicate where the next call should start.
*
*
* @return Use this parameter only when paginating results and only after you receive a response indicating that the
* results are truncated. Set it to the value of the Marker element in the response that you
* received to indicate where the next call should start.
*/
public final String marker() {
return marker;
}
/**
*
* The key that is used to sort the results. If you choose the namespace key, the results are returned in
* alphabetical order. If you choose the time key, the results are sorted numerically by the date and time.
*
*
* If the service returns an enum value that is not available in the current SDK version, {@link #sortKey} will
* return {@link SortKeyType#UNKNOWN_TO_SDK_VERSION}. The raw value returned by the service is available from
* {@link #sortKeyAsString}.
*
*
* @return The key that is used to sort the results. If you choose the namespace key, the results are returned in
* alphabetical order. If you choose the time key, the results are sorted numerically by the date and time.
* @see SortKeyType
*/
public final SortKeyType sortKey() {
return SortKeyType.fromValue(sortKey);
}
/**
*
* The key that is used to sort the results. If you choose the namespace key, the results are returned in
* alphabetical order. If you choose the time key, the results are sorted numerically by the date and time.
*
*
* If the service returns an enum value that is not available in the current SDK version, {@link #sortKey} will
* return {@link SortKeyType#UNKNOWN_TO_SDK_VERSION}. The raw value returned by the service is available from
* {@link #sortKeyAsString}.
*
*
* @return The key that is used to sort the results. If you choose the namespace key, the results are returned in
* alphabetical order. If you choose the time key, the results are sorted numerically by the date and time.
* @see SortKeyType
*/
public final String sortKeyAsString() {
return sortKey;
}
@Override
public Builder toBuilder() {
return new BuilderImpl(this);
}
public static Builder builder() {
return new BuilderImpl();
}
public static Class serializableBuilderClass() {
return BuilderImpl.class;
}
@Override
public final int hashCode() {
int hashCode = 1;
hashCode = 31 * hashCode + super.hashCode();
hashCode = 31 * hashCode + Objects.hashCode(jobId());
hashCode = 31 * hashCode + Objects.hashCode(maxItems());
hashCode = 31 * hashCode + Objects.hashCode(marker());
hashCode = 31 * hashCode + Objects.hashCode(sortKeyAsString());
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 GetOrganizationsAccessReportRequest)) {
return false;
}
GetOrganizationsAccessReportRequest other = (GetOrganizationsAccessReportRequest) obj;
return Objects.equals(jobId(), other.jobId()) && Objects.equals(maxItems(), other.maxItems())
&& Objects.equals(marker(), other.marker()) && Objects.equals(sortKeyAsString(), other.sortKeyAsString());
}
/**
* 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("GetOrganizationsAccessReportRequest").add("JobId", jobId()).add("MaxItems", maxItems())
.add("Marker", marker()).add("SortKey", sortKeyAsString()).build();
}
public final Optional getValueForField(String fieldName, Class clazz) {
switch (fieldName) {
case "JobId":
return Optional.ofNullable(clazz.cast(jobId()));
case "MaxItems":
return Optional.ofNullable(clazz.cast(maxItems()));
case "Marker":
return Optional.ofNullable(clazz.cast(marker()));
case "SortKey":
return Optional.ofNullable(clazz.cast(sortKeyAsString()));
default:
return Optional.empty();
}
}
@Override
public final List> sdkFields() {
return SDK_FIELDS;
}
private static Function getter(Function g) {
return obj -> g.apply((GetOrganizationsAccessReportRequest) obj);
}
private static BiConsumer setter(BiConsumer s) {
return (obj, val) -> s.accept((Builder) obj, val);
}
public interface Builder extends IamRequest.Builder, SdkPojo, CopyableBuilder {
/**
*
* The identifier of the request generated by the GenerateOrganizationsAccessReport operation.
*
*
* @param jobId
* The identifier of the request generated by the GenerateOrganizationsAccessReport operation.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder jobId(String jobId);
/**
*
* Use this only when paginating results to indicate the maximum number of items you want in the response. If
* additional items exist beyond the maximum you specify, the IsTruncated response element is
* true.
*
*
* If you do not include this parameter, the number of items defaults to 100. Note that IAM might return fewer
* results, even when there are more results available. In that case, the IsTruncated response
* element returns true, and Marker contains a value to include in the subsequent call
* that tells the service where to continue from.
*
*
* @param maxItems
* Use this only when paginating results to indicate the maximum number of items you want in the
* response. If additional items exist beyond the maximum you specify, the IsTruncated
* response element is true.
*
* If you do not include this parameter, the number of items defaults to 100. Note that IAM might return
* fewer results, even when there are more results available. In that case, the IsTruncated
* response element returns true, and Marker contains a value to include in the
* subsequent call that tells the service where to continue from.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder maxItems(Integer maxItems);
/**
*
* Use this parameter only when paginating results and only after you receive a response indicating that the
* results are truncated. Set it to the value of the Marker element in the response that you
* received to indicate where the next call should start.
*
*
* @param marker
* Use this parameter only when paginating results and only after you receive a response indicating that
* the results are truncated. Set it to the value of the Marker element in the response that
* you received to indicate where the next call should start.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder marker(String marker);
/**
*
* The key that is used to sort the results. If you choose the namespace key, the results are returned in
* alphabetical order. If you choose the time key, the results are sorted numerically by the date and time.
*
*
* @param sortKey
* The key that is used to sort the results. If you choose the namespace key, the results are returned in
* alphabetical order. If you choose the time key, the results are sorted numerically by the date and
* time.
* @see SortKeyType
* @return Returns a reference to this object so that method calls can be chained together.
* @see SortKeyType
*/
Builder sortKey(String sortKey);
/**
*
* The key that is used to sort the results. If you choose the namespace key, the results are returned in
* alphabetical order. If you choose the time key, the results are sorted numerically by the date and time.
*
*
* @param sortKey
* The key that is used to sort the results. If you choose the namespace key, the results are returned in
* alphabetical order. If you choose the time key, the results are sorted numerically by the date and
* time.
* @see SortKeyType
* @return Returns a reference to this object so that method calls can be chained together.
* @see SortKeyType
*/
Builder sortKey(SortKeyType sortKey);
@Override
Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration);
@Override
Builder overrideConfiguration(Consumer builderConsumer);
}
static final class BuilderImpl extends IamRequest.BuilderImpl implements Builder {
private String jobId;
private Integer maxItems;
private String marker;
private String sortKey;
private BuilderImpl() {
}
private BuilderImpl(GetOrganizationsAccessReportRequest model) {
super(model);
jobId(model.jobId);
maxItems(model.maxItems);
marker(model.marker);
sortKey(model.sortKey);
}
public final String getJobId() {
return jobId;
}
public final void setJobId(String jobId) {
this.jobId = jobId;
}
@Override
public final Builder jobId(String jobId) {
this.jobId = jobId;
return this;
}
public final Integer getMaxItems() {
return maxItems;
}
public final void setMaxItems(Integer maxItems) {
this.maxItems = maxItems;
}
@Override
public final Builder maxItems(Integer maxItems) {
this.maxItems = maxItems;
return this;
}
public final String getMarker() {
return marker;
}
public final void setMarker(String marker) {
this.marker = marker;
}
@Override
public final Builder marker(String marker) {
this.marker = marker;
return this;
}
public final String getSortKey() {
return sortKey;
}
public final void setSortKey(String sortKey) {
this.sortKey = sortKey;
}
@Override
public final Builder sortKey(String sortKey) {
this.sortKey = sortKey;
return this;
}
@Override
public final Builder sortKey(SortKeyType sortKey) {
this.sortKey(sortKey == null ? null : sortKey.toString());
return this;
}
@Override
public Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration) {
super.overrideConfiguration(overrideConfiguration);
return this;
}
@Override
public Builder overrideConfiguration(Consumer builderConsumer) {
super.overrideConfiguration(builderConsumer);
return this;
}
@Override
public GetOrganizationsAccessReportRequest build() {
return new GetOrganizationsAccessReportRequest(this);
}
@Override
public List> sdkFields() {
return SDK_FIELDS;
}
}
}