com.amazonaws.services.codebuild.model.RegistryCredential Maven / Gradle / Ivy
Show all versions of aws-java-sdk-codebuild Show documentation
/*
* Copyright 2019-2024 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 com.amazonaws.services.codebuild.model;
import java.io.Serializable;
import javax.annotation.Generated;
import com.amazonaws.protocol.StructuredPojo;
import com.amazonaws.protocol.ProtocolMarshaller;
/**
*
* Information about credentials that provide access to a private Docker registry. When this is set:
*
*
* -
*
* imagePullCredentialsType must be set to SERVICE_ROLE.
*
*
* -
*
* images cannot be curated or an Amazon ECR image.
*
*
*
*
* For more information, see Private Registry with
* Secrets Manager Sample for CodeBuild.
*
*
* @see AWS API
* Documentation
*/
@Generated("com.amazonaws:aws-java-sdk-code-generator")
public class RegistryCredential implements Serializable, Cloneable, StructuredPojo {
/**
*
* The Amazon Resource Name (ARN) or name of credentials created using Secrets Manager.
*
*
*
* The credential can use the name of the credentials only if they exist in your current Amazon Web
* Services Region.
*
*
*/
private String credential;
/**
*
* The service that created the credentials to access a private Docker registry. The valid value, SECRETS_MANAGER,
* is for Secrets Manager.
*
*/
private String credentialProvider;
/**
*
* The Amazon Resource Name (ARN) or name of credentials created using Secrets Manager.
*
*
*
* The credential can use the name of the credentials only if they exist in your current Amazon Web
* Services Region.
*
*
*
* @param credential
* The Amazon Resource Name (ARN) or name of credentials created using Secrets Manager.
*
* The credential can use the name of the credentials only if they exist in your current Amazon
* Web Services Region.
*
*/
public void setCredential(String credential) {
this.credential = credential;
}
/**
*
* The Amazon Resource Name (ARN) or name of credentials created using Secrets Manager.
*
*
*
* The credential can use the name of the credentials only if they exist in your current Amazon Web
* Services Region.
*
*
*
* @return The Amazon Resource Name (ARN) or name of credentials created using Secrets Manager.
*
* The credential can use the name of the credentials only if they exist in your current Amazon
* Web Services Region.
*
*/
public String getCredential() {
return this.credential;
}
/**
*
* The Amazon Resource Name (ARN) or name of credentials created using Secrets Manager.
*
*
*
* The credential can use the name of the credentials only if they exist in your current Amazon Web
* Services Region.
*
*
*
* @param credential
* The Amazon Resource Name (ARN) or name of credentials created using Secrets Manager.
*
* The credential can use the name of the credentials only if they exist in your current Amazon
* Web Services Region.
*
* @return Returns a reference to this object so that method calls can be chained together.
*/
public RegistryCredential withCredential(String credential) {
setCredential(credential);
return this;
}
/**
*
* The service that created the credentials to access a private Docker registry. The valid value, SECRETS_MANAGER,
* is for Secrets Manager.
*
*
* @param credentialProvider
* The service that created the credentials to access a private Docker registry. The valid value,
* SECRETS_MANAGER, is for Secrets Manager.
* @see CredentialProviderType
*/
public void setCredentialProvider(String credentialProvider) {
this.credentialProvider = credentialProvider;
}
/**
*
* The service that created the credentials to access a private Docker registry. The valid value, SECRETS_MANAGER,
* is for Secrets Manager.
*
*
* @return The service that created the credentials to access a private Docker registry. The valid value,
* SECRETS_MANAGER, is for Secrets Manager.
* @see CredentialProviderType
*/
public String getCredentialProvider() {
return this.credentialProvider;
}
/**
*
* The service that created the credentials to access a private Docker registry. The valid value, SECRETS_MANAGER,
* is for Secrets Manager.
*
*
* @param credentialProvider
* The service that created the credentials to access a private Docker registry. The valid value,
* SECRETS_MANAGER, is for Secrets Manager.
* @return Returns a reference to this object so that method calls can be chained together.
* @see CredentialProviderType
*/
public RegistryCredential withCredentialProvider(String credentialProvider) {
setCredentialProvider(credentialProvider);
return this;
}
/**
*
* The service that created the credentials to access a private Docker registry. The valid value, SECRETS_MANAGER,
* is for Secrets Manager.
*
*
* @param credentialProvider
* The service that created the credentials to access a private Docker registry. The valid value,
* SECRETS_MANAGER, is for Secrets Manager.
* @return Returns a reference to this object so that method calls can be chained together.
* @see CredentialProviderType
*/
public RegistryCredential withCredentialProvider(CredentialProviderType credentialProvider) {
this.credentialProvider = credentialProvider.toString();
return this;
}
/**
* 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.
*
* @return A string representation of this object.
*
* @see java.lang.Object#toString()
*/
@Override
public String toString() {
StringBuilder sb = new StringBuilder();
sb.append("{");
if (getCredential() != null)
sb.append("Credential: ").append(getCredential()).append(",");
if (getCredentialProvider() != null)
sb.append("CredentialProvider: ").append(getCredentialProvider());
sb.append("}");
return sb.toString();
}
@Override
public boolean equals(Object obj) {
if (this == obj)
return true;
if (obj == null)
return false;
if (obj instanceof RegistryCredential == false)
return false;
RegistryCredential other = (RegistryCredential) obj;
if (other.getCredential() == null ^ this.getCredential() == null)
return false;
if (other.getCredential() != null && other.getCredential().equals(this.getCredential()) == false)
return false;
if (other.getCredentialProvider() == null ^ this.getCredentialProvider() == null)
return false;
if (other.getCredentialProvider() != null && other.getCredentialProvider().equals(this.getCredentialProvider()) == false)
return false;
return true;
}
@Override
public int hashCode() {
final int prime = 31;
int hashCode = 1;
hashCode = prime * hashCode + ((getCredential() == null) ? 0 : getCredential().hashCode());
hashCode = prime * hashCode + ((getCredentialProvider() == null) ? 0 : getCredentialProvider().hashCode());
return hashCode;
}
@Override
public RegistryCredential clone() {
try {
return (RegistryCredential) super.clone();
} catch (CloneNotSupportedException e) {
throw new IllegalStateException("Got a CloneNotSupportedException from Object.clone() " + "even though we're Cloneable!", e);
}
}
@com.amazonaws.annotation.SdkInternalApi
@Override
public void marshall(ProtocolMarshaller protocolMarshaller) {
com.amazonaws.services.codebuild.model.transform.RegistryCredentialMarshaller.getInstance().marshall(this, protocolMarshaller);
}
}