software.amazon.awssdk.services.ecr.model.GetAuthorizationTokenRequest Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of ecr Show documentation
Show all versions of ecr Show documentation
The AWS Java SDK for the Amazon EC2 Container Registry holds the client classes that are used for
communicating with the
Amazon EC2 Container Registry 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.ecr.model;
import java.beans.Transient;
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 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.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 GetAuthorizationTokenRequest extends EcrRequest implements
ToCopyableBuilder {
private static final SdkField> REGISTRY_IDS_FIELD = SdkField
.> builder(MarshallingType.LIST)
.memberName("registryIds")
.getter(getter(GetAuthorizationTokenRequest::registryIds))
.setter(setter(Builder::registryIds))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("registryIds").build(),
ListTrait
.builder()
.memberLocationName(null)
.memberFieldInfo(
SdkField. builder(MarshallingType.STRING)
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD)
.locationName("member").build()).build()).build()).build();
private static final List> SDK_FIELDS = Collections.unmodifiableList(Arrays.asList(REGISTRY_IDS_FIELD));
private final List registryIds;
private GetAuthorizationTokenRequest(BuilderImpl builder) {
super(builder);
this.registryIds = builder.registryIds;
}
/**
* For responses, this returns true if the service returned a value for the RegistryIds property. This DOES NOT
* check that the value is non-empty (for which, you should check the {@code isEmpty()} method on the property).
* This is useful because the SDK will never return a null collection or map, but you may need to differentiate
* between the service returning nothing (or null) and the service returning an empty collection or map. For
* requests, this returns true if a value for the property was specified in the request builder, and false if a
* value was not specified.
*
* @deprecated This field is deprecated. The returned authorization token can be used to access any Amazon ECR
* registry that the IAM principal has access to, specifying a registry ID doesn't change the
* permissions scope of the authorization token.
*/
@Deprecated
public final boolean hasRegistryIds() {
return registryIds != null && !(registryIds instanceof SdkAutoConstructList);
}
/**
*
* A list of Amazon Web Services account IDs that are associated with the registries for which to get
* AuthorizationData objects. If you do not specify a registry, the default registry is assumed.
*
*
* Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
*
*
* This method will never return null. If you would like to know whether the service returned this field (so that
* you can differentiate between null and empty), you can use the {@link #hasRegistryIds} method.
*
*
* @return A list of Amazon Web Services account IDs that are associated with the registries for which to get
* AuthorizationData objects. If you do not specify a registry, the default registry is assumed.
* @deprecated This field is deprecated. The returned authorization token can be used to access any Amazon ECR
* registry that the IAM principal has access to, specifying a registry ID doesn't change the
* permissions scope of the authorization token.
*/
@Deprecated
public final List registryIds() {
return registryIds;
}
@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(hasRegistryIds() ? registryIds() : null);
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 GetAuthorizationTokenRequest)) {
return false;
}
GetAuthorizationTokenRequest other = (GetAuthorizationTokenRequest) obj;
return hasRegistryIds() == other.hasRegistryIds() && Objects.equals(registryIds(), other.registryIds());
}
/**
* 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("GetAuthorizationTokenRequest").add("RegistryIds", hasRegistryIds() ? registryIds() : null)
.build();
}
public final Optional getValueForField(String fieldName, Class clazz) {
switch (fieldName) {
case "registryIds":
return Optional.ofNullable(clazz.cast(registryIds()));
default:
return Optional.empty();
}
}
@Override
public final List> sdkFields() {
return SDK_FIELDS;
}
private static Function getter(Function g) {
return obj -> g.apply((GetAuthorizationTokenRequest) obj);
}
private static BiConsumer setter(BiConsumer s) {
return (obj, val) -> s.accept((Builder) obj, val);
}
public interface Builder extends EcrRequest.Builder, SdkPojo, CopyableBuilder {
/**
*
* A list of Amazon Web Services account IDs that are associated with the registries for which to get
* AuthorizationData objects. If you do not specify a registry, the default registry is assumed.
*
*
* @param registryIds
* A list of Amazon Web Services account IDs that are associated with the registries for which to get
* AuthorizationData objects. If you do not specify a registry, the default registry is assumed.
* @return Returns a reference to this object so that method calls can be chained together.
* @deprecated This field is deprecated. The returned authorization token can be used to access any Amazon ECR
* registry that the IAM principal has access to, specifying a registry ID doesn't change the
* permissions scope of the authorization token.
*/
@Deprecated
Builder registryIds(Collection registryIds);
/**
*
* A list of Amazon Web Services account IDs that are associated with the registries for which to get
* AuthorizationData objects. If you do not specify a registry, the default registry is assumed.
*
*
* @param registryIds
* A list of Amazon Web Services account IDs that are associated with the registries for which to get
* AuthorizationData objects. If you do not specify a registry, the default registry is assumed.
* @return Returns a reference to this object so that method calls can be chained together.
* @deprecated This field is deprecated. The returned authorization token can be used to access any Amazon ECR
* registry that the IAM principal has access to, specifying a registry ID doesn't change the
* permissions scope of the authorization token.
*/
@Deprecated
Builder registryIds(String... registryIds);
@Override
Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration);
@Override
Builder overrideConfiguration(Consumer builderConsumer);
}
static final class BuilderImpl extends EcrRequest.BuilderImpl implements Builder {
private List registryIds = DefaultSdkAutoConstructList.getInstance();
private BuilderImpl() {
}
private BuilderImpl(GetAuthorizationTokenRequest model) {
super(model);
registryIds(model.registryIds);
}
@Deprecated
public final Collection getRegistryIds() {
if (registryIds instanceof SdkAutoConstructList) {
return null;
}
return registryIds;
}
@Deprecated
public final void setRegistryIds(Collection registryIds) {
this.registryIds = GetAuthorizationTokenRegistryIdListCopier.copy(registryIds);
}
@Override
@Transient
@Deprecated
public final Builder registryIds(Collection registryIds) {
this.registryIds = GetAuthorizationTokenRegistryIdListCopier.copy(registryIds);
return this;
}
@Override
@Transient
@SafeVarargs
@Deprecated
public final Builder registryIds(String... registryIds) {
registryIds(Arrays.asList(registryIds));
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 GetAuthorizationTokenRequest build() {
return new GetAuthorizationTokenRequest(this);
}
@Override
public List> sdkFields() {
return SDK_FIELDS;
}
}
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy