software.amazon.awssdk.services.ecr.model.AuthorizationData Maven / Gradle / Ivy
/*
* Copyright 2014-2019 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.io.Serializable;
import java.time.Instant;
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.Function;
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.LocationTrait;
import software.amazon.awssdk.utils.ToString;
import software.amazon.awssdk.utils.builder.CopyableBuilder;
import software.amazon.awssdk.utils.builder.ToCopyableBuilder;
/**
*
* An object representing authorization data for an Amazon ECR registry.
*
*/
@Generated("software.amazon.awssdk:codegen")
public final class AuthorizationData implements SdkPojo, Serializable,
ToCopyableBuilder {
private static final SdkField AUTHORIZATION_TOKEN_FIELD = SdkField. builder(MarshallingType.STRING)
.getter(getter(AuthorizationData::authorizationToken)).setter(setter(Builder::authorizationToken))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("authorizationToken").build())
.build();
private static final SdkField EXPIRES_AT_FIELD = SdkField. builder(MarshallingType.INSTANT)
.getter(getter(AuthorizationData::expiresAt)).setter(setter(Builder::expiresAt))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("expiresAt").build()).build();
private static final SdkField PROXY_ENDPOINT_FIELD = SdkField. builder(MarshallingType.STRING)
.getter(getter(AuthorizationData::proxyEndpoint)).setter(setter(Builder::proxyEndpoint))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("proxyEndpoint").build()).build();
private static final List> SDK_FIELDS = Collections.unmodifiableList(Arrays.asList(AUTHORIZATION_TOKEN_FIELD,
EXPIRES_AT_FIELD, PROXY_ENDPOINT_FIELD));
private static final long serialVersionUID = 1L;
private final String authorizationToken;
private final Instant expiresAt;
private final String proxyEndpoint;
private AuthorizationData(BuilderImpl builder) {
this.authorizationToken = builder.authorizationToken;
this.expiresAt = builder.expiresAt;
this.proxyEndpoint = builder.proxyEndpoint;
}
/**
*
* A base64-encoded string that contains authorization data for the specified Amazon ECR registry. When the string
* is decoded, it is presented in the format user:password for private registry authentication using
* docker login.
*
*
* @return A base64-encoded string that contains authorization data for the specified Amazon ECR registry. When the
* string is decoded, it is presented in the format user:password for private registry
* authentication using docker login.
*/
public String authorizationToken() {
return authorizationToken;
}
/**
*
* The Unix time in seconds and milliseconds when the authorization token expires. Authorization tokens are valid
* for 12 hours.
*
*
* @return The Unix time in seconds and milliseconds when the authorization token expires. Authorization tokens are
* valid for 12 hours.
*/
public Instant expiresAt() {
return expiresAt;
}
/**
*
* The registry URL to use for this authorization token in a docker login command. The Amazon ECR
* registry URL format is https://aws_account_id.dkr.ecr.region.amazonaws.com. For example,
* https://012345678910.dkr.ecr.us-east-1.amazonaws.com..
*
*
* @return The registry URL to use for this authorization token in a docker login command. The Amazon
* ECR registry URL format is https://aws_account_id.dkr.ecr.region.amazonaws.com. For example,
* https://012345678910.dkr.ecr.us-east-1.amazonaws.com..
*/
public String proxyEndpoint() {
return proxyEndpoint;
}
@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 + Objects.hashCode(authorizationToken());
hashCode = 31 * hashCode + Objects.hashCode(expiresAt());
hashCode = 31 * hashCode + Objects.hashCode(proxyEndpoint());
return hashCode;
}
@Override
public boolean equals(Object obj) {
if (this == obj) {
return true;
}
if (obj == null) {
return false;
}
if (!(obj instanceof AuthorizationData)) {
return false;
}
AuthorizationData other = (AuthorizationData) obj;
return Objects.equals(authorizationToken(), other.authorizationToken()) && Objects.equals(expiresAt(), other.expiresAt())
&& Objects.equals(proxyEndpoint(), other.proxyEndpoint());
}
/**
* 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("AuthorizationData").add("AuthorizationToken", authorizationToken())
.add("ExpiresAt", expiresAt()).add("ProxyEndpoint", proxyEndpoint()).build();
}
public Optional getValueForField(String fieldName, Class clazz) {
switch (fieldName) {
case "authorizationToken":
return Optional.ofNullable(clazz.cast(authorizationToken()));
case "expiresAt":
return Optional.ofNullable(clazz.cast(expiresAt()));
case "proxyEndpoint":
return Optional.ofNullable(clazz.cast(proxyEndpoint()));
default:
return Optional.empty();
}
}
@Override
public List> sdkFields() {
return SDK_FIELDS;
}
private static Function getter(Function g) {
return obj -> g.apply((AuthorizationData) obj);
}
private static BiConsumer setter(BiConsumer s) {
return (obj, val) -> s.accept((Builder) obj, val);
}
public interface Builder extends SdkPojo, CopyableBuilder {
/**
*
* A base64-encoded string that contains authorization data for the specified Amazon ECR registry. When the
* string is decoded, it is presented in the format user:password for private registry
* authentication using docker login.
*
*
* @param authorizationToken
* A base64-encoded string that contains authorization data for the specified Amazon ECR registry. When
* the string is decoded, it is presented in the format user:password for private registry
* authentication using docker login.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder authorizationToken(String authorizationToken);
/**
*
* The Unix time in seconds and milliseconds when the authorization token expires. Authorization tokens are
* valid for 12 hours.
*
*
* @param expiresAt
* The Unix time in seconds and milliseconds when the authorization token expires. Authorization tokens
* are valid for 12 hours.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder expiresAt(Instant expiresAt);
/**
*
* The registry URL to use for this authorization token in a docker login command. The Amazon ECR
* registry URL format is https://aws_account_id.dkr.ecr.region.amazonaws.com. For example,
* https://012345678910.dkr.ecr.us-east-1.amazonaws.com..
*
*
* @param proxyEndpoint
* The registry URL to use for this authorization token in a docker login command. The
* Amazon ECR registry URL format is https://aws_account_id.dkr.ecr.region.amazonaws.com.
* For example, https://012345678910.dkr.ecr.us-east-1.amazonaws.com..
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder proxyEndpoint(String proxyEndpoint);
}
static final class BuilderImpl implements Builder {
private String authorizationToken;
private Instant expiresAt;
private String proxyEndpoint;
private BuilderImpl() {
}
private BuilderImpl(AuthorizationData model) {
authorizationToken(model.authorizationToken);
expiresAt(model.expiresAt);
proxyEndpoint(model.proxyEndpoint);
}
public final String getAuthorizationToken() {
return authorizationToken;
}
@Override
public final Builder authorizationToken(String authorizationToken) {
this.authorizationToken = authorizationToken;
return this;
}
public final void setAuthorizationToken(String authorizationToken) {
this.authorizationToken = authorizationToken;
}
public final Instant getExpiresAt() {
return expiresAt;
}
@Override
public final Builder expiresAt(Instant expiresAt) {
this.expiresAt = expiresAt;
return this;
}
public final void setExpiresAt(Instant expiresAt) {
this.expiresAt = expiresAt;
}
public final String getProxyEndpoint() {
return proxyEndpoint;
}
@Override
public final Builder proxyEndpoint(String proxyEndpoint) {
this.proxyEndpoint = proxyEndpoint;
return this;
}
public final void setProxyEndpoint(String proxyEndpoint) {
this.proxyEndpoint = proxyEndpoint;
}
@Override
public AuthorizationData build() {
return new AuthorizationData(this);
}
@Override
public List> sdkFields() {
return SDK_FIELDS;
}
}
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy