software.amazon.awssdk.services.iam.model.GetOrganizationsAccessReportResponse 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.iam.model;
import java.time.Instant;
import java.util.Arrays;
import java.util.Collection;
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 java.util.stream.Collectors;
import java.util.stream.Stream;
import software.amazon.awssdk.annotations.Generated;
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.ListTrait;
import software.amazon.awssdk.core.traits.LocationTrait;
import software.amazon.awssdk.core.util.DefaultSdkAutoConstructList;
import software.amazon.awssdk.core.util.SdkAutoConstructList;
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 GetOrganizationsAccessReportResponse extends IamResponse implements
ToCopyableBuilder {
private static final SdkField JOB_STATUS_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("JobStatus").getter(getter(GetOrganizationsAccessReportResponse::jobStatusAsString))
.setter(setter(Builder::jobStatus))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("JobStatus").build()).build();
private static final SdkField JOB_CREATION_DATE_FIELD = SdkField. builder(MarshallingType.INSTANT)
.memberName("JobCreationDate").getter(getter(GetOrganizationsAccessReportResponse::jobCreationDate))
.setter(setter(Builder::jobCreationDate))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("JobCreationDate").build()).build();
private static final SdkField JOB_COMPLETION_DATE_FIELD = SdkField. builder(MarshallingType.INSTANT)
.memberName("JobCompletionDate").getter(getter(GetOrganizationsAccessReportResponse::jobCompletionDate))
.setter(setter(Builder::jobCompletionDate))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("JobCompletionDate").build()).build();
private static final SdkField NUMBER_OF_SERVICES_ACCESSIBLE_FIELD = SdkField
. builder(MarshallingType.INTEGER)
.memberName("NumberOfServicesAccessible")
.getter(getter(GetOrganizationsAccessReportResponse::numberOfServicesAccessible))
.setter(setter(Builder::numberOfServicesAccessible))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("NumberOfServicesAccessible").build())
.build();
private static final SdkField NUMBER_OF_SERVICES_NOT_ACCESSED_FIELD = SdkField
. builder(MarshallingType.INTEGER)
.memberName("NumberOfServicesNotAccessed")
.getter(getter(GetOrganizationsAccessReportResponse::numberOfServicesNotAccessed))
.setter(setter(Builder::numberOfServicesNotAccessed))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("NumberOfServicesNotAccessed")
.build()).build();
private static final SdkField> ACCESS_DETAILS_FIELD = SdkField
.> builder(MarshallingType.LIST)
.memberName("AccessDetails")
.getter(getter(GetOrganizationsAccessReportResponse::accessDetails))
.setter(setter(Builder::accessDetails))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("AccessDetails").build(),
ListTrait
.builder()
.memberLocationName(null)
.memberFieldInfo(
SdkField. builder(MarshallingType.SDK_POJO)
.constructor(AccessDetail::builder)
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD)
.locationName("member").build()).build()).build()).build();
private static final SdkField IS_TRUNCATED_FIELD = SdkField. builder(MarshallingType.BOOLEAN)
.memberName("IsTruncated").getter(getter(GetOrganizationsAccessReportResponse::isTruncated))
.setter(setter(Builder::isTruncated))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("IsTruncated").build()).build();
private static final SdkField MARKER_FIELD = SdkField. builder(MarshallingType.STRING).memberName("Marker")
.getter(getter(GetOrganizationsAccessReportResponse::marker)).setter(setter(Builder::marker))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("Marker").build()).build();
private static final SdkField ERROR_DETAILS_FIELD = SdkField. builder(MarshallingType.SDK_POJO)
.memberName("ErrorDetails").getter(getter(GetOrganizationsAccessReportResponse::errorDetails))
.setter(setter(Builder::errorDetails)).constructor(ErrorDetails::builder)
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("ErrorDetails").build()).build();
private static final List> SDK_FIELDS = Collections.unmodifiableList(Arrays.asList(JOB_STATUS_FIELD,
JOB_CREATION_DATE_FIELD, JOB_COMPLETION_DATE_FIELD, NUMBER_OF_SERVICES_ACCESSIBLE_FIELD,
NUMBER_OF_SERVICES_NOT_ACCESSED_FIELD, ACCESS_DETAILS_FIELD, IS_TRUNCATED_FIELD, MARKER_FIELD, ERROR_DETAILS_FIELD));
private final String jobStatus;
private final Instant jobCreationDate;
private final Instant jobCompletionDate;
private final Integer numberOfServicesAccessible;
private final Integer numberOfServicesNotAccessed;
private final List accessDetails;
private final Boolean isTruncated;
private final String marker;
private final ErrorDetails errorDetails;
private GetOrganizationsAccessReportResponse(BuilderImpl builder) {
super(builder);
this.jobStatus = builder.jobStatus;
this.jobCreationDate = builder.jobCreationDate;
this.jobCompletionDate = builder.jobCompletionDate;
this.numberOfServicesAccessible = builder.numberOfServicesAccessible;
this.numberOfServicesNotAccessed = builder.numberOfServicesNotAccessed;
this.accessDetails = builder.accessDetails;
this.isTruncated = builder.isTruncated;
this.marker = builder.marker;
this.errorDetails = builder.errorDetails;
}
/**
*
* The status of the job.
*
*
* If the service returns an enum value that is not available in the current SDK version, {@link #jobStatus} will
* return {@link JobStatusType#UNKNOWN_TO_SDK_VERSION}. The raw value returned by the service is available from
* {@link #jobStatusAsString}.
*
*
* @return The status of the job.
* @see JobStatusType
*/
public JobStatusType jobStatus() {
return JobStatusType.fromValue(jobStatus);
}
/**
*
* The status of the job.
*
*
* If the service returns an enum value that is not available in the current SDK version, {@link #jobStatus} will
* return {@link JobStatusType#UNKNOWN_TO_SDK_VERSION}. The raw value returned by the service is available from
* {@link #jobStatusAsString}.
*
*
* @return The status of the job.
* @see JobStatusType
*/
public String jobStatusAsString() {
return jobStatus;
}
/**
*
* The date and time, in ISO 8601 date-time format, when the report job
* was created.
*
*
* @return The date and time, in ISO 8601 date-time format, when the
* report job was created.
*/
public Instant jobCreationDate() {
return jobCreationDate;
}
/**
*
* The date and time, in ISO 8601 date-time format, when the generated
* report job was completed or failed.
*
*
* This field is null if the job is still in progress, as indicated by a job status value of
* IN_PROGRESS
.
*
*
* @return The date and time, in ISO 8601 date-time format, when the
* generated report job was completed or failed.
*
* This field is null if the job is still in progress, as indicated by a job status value of
* IN_PROGRESS
.
*/
public Instant jobCompletionDate() {
return jobCompletionDate;
}
/**
*
* The number of services that the applicable SCPs allow account principals to access.
*
*
* @return The number of services that the applicable SCPs allow account principals to access.
*/
public Integer numberOfServicesAccessible() {
return numberOfServicesAccessible;
}
/**
*
* The number of services that account principals are allowed but did not attempt to access.
*
*
* @return The number of services that account principals are allowed but did not attempt to access.
*/
public Integer numberOfServicesNotAccessed() {
return numberOfServicesNotAccessed;
}
/**
* Returns true if the AccessDetails property was specified by the sender (it may be empty), or false if the sender
* did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.
*/
public boolean hasAccessDetails() {
return accessDetails != null && !(accessDetails instanceof SdkAutoConstructList);
}
/**
*
* An object that contains details about the most recent attempt to access the service.
*
*
* Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
*
*
* You can use {@link #hasAccessDetails()} to see if a value was sent in this field.
*
*
* @return An object that contains details about the most recent attempt to access the service.
*/
public List accessDetails() {
return accessDetails;
}
/**
*
* A flag that indicates whether there are more items to return. If your results were truncated, you can make a
* subsequent pagination request using the Marker
request parameter to retrieve more items. Note that
* IAM might return fewer than the MaxItems
number of results even when there are more results
* available. We recommend that you check IsTruncated
after every call to ensure that you receive all
* your results.
*
*
* @return A flag that indicates whether there are more items to return. If your results were truncated, you can
* make a subsequent pagination request using the Marker
request parameter to retrieve more
* items. Note that IAM might return fewer than the MaxItems
number of results even when there
* are more results available. We recommend that you check IsTruncated
after every call to
* ensure that you receive all your results.
*/
public Boolean isTruncated() {
return isTruncated;
}
/**
*
* When IsTruncated
is true
, this element is present and contains the value to use for the
* Marker
parameter in a subsequent pagination request.
*
*
* @return When IsTruncated
is true
, this element is present and contains the value to use
* for the Marker
parameter in a subsequent pagination request.
*/
public String marker() {
return marker;
}
/**
* Returns the value of the ErrorDetails property for this object.
*
* @return The value of the ErrorDetails property for this object.
*/
public ErrorDetails errorDetails() {
return errorDetails;
}
@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 int hashCode() {
int hashCode = 1;
hashCode = 31 * hashCode + super.hashCode();
hashCode = 31 * hashCode + Objects.hashCode(jobStatusAsString());
hashCode = 31 * hashCode + Objects.hashCode(jobCreationDate());
hashCode = 31 * hashCode + Objects.hashCode(jobCompletionDate());
hashCode = 31 * hashCode + Objects.hashCode(numberOfServicesAccessible());
hashCode = 31 * hashCode + Objects.hashCode(numberOfServicesNotAccessed());
hashCode = 31 * hashCode + Objects.hashCode(accessDetails());
hashCode = 31 * hashCode + Objects.hashCode(isTruncated());
hashCode = 31 * hashCode + Objects.hashCode(marker());
hashCode = 31 * hashCode + Objects.hashCode(errorDetails());
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 GetOrganizationsAccessReportResponse)) {
return false;
}
GetOrganizationsAccessReportResponse other = (GetOrganizationsAccessReportResponse) obj;
return Objects.equals(jobStatusAsString(), other.jobStatusAsString())
&& Objects.equals(jobCreationDate(), other.jobCreationDate())
&& Objects.equals(jobCompletionDate(), other.jobCompletionDate())
&& Objects.equals(numberOfServicesAccessible(), other.numberOfServicesAccessible())
&& Objects.equals(numberOfServicesNotAccessed(), other.numberOfServicesNotAccessed())
&& Objects.equals(accessDetails(), other.accessDetails()) && Objects.equals(isTruncated(), other.isTruncated())
&& Objects.equals(marker(), other.marker()) && Objects.equals(errorDetails(), other.errorDetails());
}
/**
* 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("GetOrganizationsAccessReportResponse").add("JobStatus", jobStatusAsString())
.add("JobCreationDate", jobCreationDate()).add("JobCompletionDate", jobCompletionDate())
.add("NumberOfServicesAccessible", numberOfServicesAccessible())
.add("NumberOfServicesNotAccessed", numberOfServicesNotAccessed()).add("AccessDetails", accessDetails())
.add("IsTruncated", isTruncated()).add("Marker", marker()).add("ErrorDetails", errorDetails()).build();
}
public Optional getValueForField(String fieldName, Class clazz) {
switch (fieldName) {
case "JobStatus":
return Optional.ofNullable(clazz.cast(jobStatusAsString()));
case "JobCreationDate":
return Optional.ofNullable(clazz.cast(jobCreationDate()));
case "JobCompletionDate":
return Optional.ofNullable(clazz.cast(jobCompletionDate()));
case "NumberOfServicesAccessible":
return Optional.ofNullable(clazz.cast(numberOfServicesAccessible()));
case "NumberOfServicesNotAccessed":
return Optional.ofNullable(clazz.cast(numberOfServicesNotAccessed()));
case "AccessDetails":
return Optional.ofNullable(clazz.cast(accessDetails()));
case "IsTruncated":
return Optional.ofNullable(clazz.cast(isTruncated()));
case "Marker":
return Optional.ofNullable(clazz.cast(marker()));
case "ErrorDetails":
return Optional.ofNullable(clazz.cast(errorDetails()));
default:
return Optional.empty();
}
}
@Override
public List> sdkFields() {
return SDK_FIELDS;
}
private static Function