com.amazonaws.services.codeartifact.model

Class GetPackageVersionReadmeRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.codeartifact.model.GetPackageVersionReadmeRequest

All Implemented Interfaces:

HandlerContextAware, ReadLimitInfo, Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class GetPackageVersionReadmeRequest
extends AmazonWebServiceRequest
implements Serializable, Cloneable

See Also:

AWS API Documentation, Serialized Form

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceRequest

NOOP

Constructor Summary

Constructors

Constructor and Description
GetPackageVersionReadmeRequest()

Method Summary

Modifier and Type	Method and Description
GetPackageVersionReadmeRequest	clone() Creates a shallow clone of this object for all fields except the handler context.
boolean	equals(Object obj)
String	getDomain() The name of the domain that contains the repository that contains the package version with the requested readme file.
String	getDomainOwner() The 12-digit account number of the Amazon Web Services account that owns the domain.
String	getFormat() A format that specifies the type of the package version with the requested readme file.
String	getNamespace() The namespace of the package version with the requested readme file.
String	getPackage() The name of the package version that contains the requested readme file.
String	getPackageVersion() A string that contains the package version (for example, 3.5.2).
String	getRepository() The repository that contains the package with the requested readme file.
int	hashCode()
void	setDomain(String domain) The name of the domain that contains the repository that contains the package version with the requested readme file.
void	setDomainOwner(String domainOwner) The 12-digit account number of the Amazon Web Services account that owns the domain.
void	setFormat(String format) A format that specifies the type of the package version with the requested readme file.
void	setNamespace(String namespace) The namespace of the package version with the requested readme file.
void	setPackage(String packageValue) The name of the package version that contains the requested readme file.
void	setPackageVersion(String packageVersion) A string that contains the package version (for example, 3.5.2).
void	setRepository(String repository) The repository that contains the package with the requested readme file.
String	toString() Returns a string representation of this object.
GetPackageVersionReadmeRequest	withDomain(String domain) The name of the domain that contains the repository that contains the package version with the requested readme file.
GetPackageVersionReadmeRequest	withDomainOwner(String domainOwner) The 12-digit account number of the Amazon Web Services account that owns the domain.
GetPackageVersionReadmeRequest	withFormat(PackageFormat format) A format that specifies the type of the package version with the requested readme file.
GetPackageVersionReadmeRequest	withFormat(String format) A format that specifies the type of the package version with the requested readme file.
GetPackageVersionReadmeRequest	withNamespace(String namespace) The namespace of the package version with the requested readme file.
GetPackageVersionReadmeRequest	withPackage(String packageValue) The name of the package version that contains the requested readme file.
GetPackageVersionReadmeRequest	withPackageVersion(String packageVersion) A string that contains the package version (for example, 3.5.2).
GetPackageVersionReadmeRequest	withRepository(String repository) The repository that contains the package with the requested readme file.

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

addHandlerContext, getCloneRoot, getCloneSource, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getHandlerContext, getReadLimit, getRequestClientOptions, getRequestCredentials, getRequestCredentialsProvider, getRequestMetricCollector, getSdkClientExecutionTimeout, getSdkRequestTimeout, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestCredentialsProvider, setRequestMetricCollector, setSdkClientExecutionTimeout, setSdkRequestTimeout, withGeneralProgressListener, withRequestCredentialsProvider, withRequestMetricCollector, withSdkClientExecutionTimeout, withSdkRequestTimeout

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

GetPackageVersionReadmeRequest

public GetPackageVersionReadmeRequest()

Method Detail

setDomain

public void setDomain(String domain)

The name of the domain that contains the repository that contains the package version with the requested readme file.

Parameters:

domain - The name of the domain that contains the repository that contains the package version with the requested readme file.

getDomain

public String getDomain()

The name of the domain that contains the repository that contains the package version with the requested readme file.

Returns:

The name of the domain that contains the repository that contains the package version with the requested readme file.

withDomain

public GetPackageVersionReadmeRequest withDomain(String domain)

The name of the domain that contains the repository that contains the package version with the requested readme file.

Parameters:

domain - The name of the domain that contains the repository that contains the package version with the requested readme file.

Returns:

Returns a reference to this object so that method calls can be chained together.

setDomainOwner

public void setDomainOwner(String domainOwner)

The 12-digit account number of the Amazon Web Services account that owns the domain. It does not include dashes or spaces.

Parameters:

domainOwner - The 12-digit account number of the Amazon Web Services account that owns the domain. It does not include dashes or spaces.

getDomainOwner

public String getDomainOwner()

The 12-digit account number of the Amazon Web Services account that owns the domain. It does not include dashes or spaces.

Returns:

The 12-digit account number of the Amazon Web Services account that owns the domain. It does not include dashes or spaces.

withDomainOwner

public GetPackageVersionReadmeRequest withDomainOwner(String domainOwner)

The 12-digit account number of the Amazon Web Services account that owns the domain. It does not include dashes or spaces.

Parameters:

domainOwner - The 12-digit account number of the Amazon Web Services account that owns the domain. It does not include dashes or spaces.

Returns:

Returns a reference to this object so that method calls can be chained together.

setRepository

public void setRepository(String repository)

The repository that contains the package with the requested readme file.

Parameters:

repository - The repository that contains the package with the requested readme file.

getRepository

public String getRepository()

The repository that contains the package with the requested readme file.

Returns:

The repository that contains the package with the requested readme file.

withRepository

public GetPackageVersionReadmeRequest withRepository(String repository)

The repository that contains the package with the requested readme file.

Parameters:

repository - The repository that contains the package with the requested readme file.

Returns:

Returns a reference to this object so that method calls can be chained together.

setFormat

public void setFormat(String format)

A format that specifies the type of the package version with the requested readme file.

Parameters:

format - A format that specifies the type of the package version with the requested readme file.

See Also:

PackageFormat

getFormat

public String getFormat()

A format that specifies the type of the package version with the requested readme file.

Returns:

A format that specifies the type of the package version with the requested readme file.

See Also:

PackageFormat

withFormat

public GetPackageVersionReadmeRequest withFormat(String format)

A format that specifies the type of the package version with the requested readme file.

Parameters:

format - A format that specifies the type of the package version with the requested readme file.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

PackageFormat

withFormat

public GetPackageVersionReadmeRequest withFormat(PackageFormat format)

A format that specifies the type of the package version with the requested readme file.

Parameters:

format - A format that specifies the type of the package version with the requested readme file.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

PackageFormat

setNamespace

public void setNamespace(String namespace)

The namespace of the package version with the requested readme file. The package component that specifies its namespace depends on its type. For example:

The namespace is required when requesting the readme from package versions of the following formats:

• Maven

• Swift

• generic

• The namespace of a Maven package version is its groupId.

• The namespace of an npm or Swift package version is its scope.

• The namespace of a generic package is its namespace.

• Python, NuGet, Ruby, and Cargo package versions do not contain a corresponding component, package versions of those formats do not have a namespace.

Parameters:

namespace - The namespace of the package version with the requested readme file. The package component that specifies its namespace depends on its type. For example:

The namespace is required when requesting the readme from package versions of the following formats:

• Maven

• Swift

• generic

• The namespace of a Maven package version is its groupId.

• The namespace of an npm or Swift package version is its scope.

• The namespace of a generic package is its namespace.

• Python, NuGet, Ruby, and Cargo package versions do not contain a corresponding component, package versions of those formats do not have a namespace.

getNamespace

public String getNamespace()

The namespace of the package version with the requested readme file. The package component that specifies its namespace depends on its type. For example:

The namespace is required when requesting the readme from package versions of the following formats:

• Maven

• Swift

• generic

• The namespace of a Maven package version is its groupId.

• The namespace of an npm or Swift package version is its scope.

• The namespace of a generic package is its namespace.

• Python, NuGet, Ruby, and Cargo package versions do not contain a corresponding component, package versions of those formats do not have a namespace.

Returns:

The namespace of the package version with the requested readme file. The package component that specifies its namespace depends on its type. For example:

The namespace is required when requesting the readme from package versions of the following formats:

• Maven

• Swift

• generic

• The namespace of a Maven package version is its groupId.

• The namespace of an npm or Swift package version is its scope.

• The namespace of a generic package is its namespace.

• Python, NuGet, Ruby, and Cargo package versions do not contain a corresponding component, package versions of those formats do not have a namespace.

withNamespace

public GetPackageVersionReadmeRequest withNamespace(String namespace)

The namespace of the package version with the requested readme file. The package component that specifies its namespace depends on its type. For example:

The namespace is required when requesting the readme from package versions of the following formats:

• Maven

• Swift

• generic

• The namespace of a Maven package version is its groupId.

• The namespace of an npm or Swift package version is its scope.

• The namespace of a generic package is its namespace.

• Python, NuGet, Ruby, and Cargo package versions do not contain a corresponding component, package versions of those formats do not have a namespace.

Parameters:

namespace - The namespace of the package version with the requested readme file. The package component that specifies its namespace depends on its type. For example:

The namespace is required when requesting the readme from package versions of the following formats:

• Maven

• Swift

• generic

• The namespace of a Maven package version is its groupId.

• The namespace of an npm or Swift package version is its scope.

• The namespace of a generic package is its namespace.

• Python, NuGet, Ruby, and Cargo package versions do not contain a corresponding component, package versions of those formats do not have a namespace.

Returns:

Returns a reference to this object so that method calls can be chained together.

setPackage

public void setPackage(String packageValue)

The name of the package version that contains the requested readme file.

Parameters:

packageValue - The name of the package version that contains the requested readme file.

getPackage

public String getPackage()

The name of the package version that contains the requested readme file.

Returns:

The name of the package version that contains the requested readme file.

withPackage

public GetPackageVersionReadmeRequest withPackage(String packageValue)

The name of the package version that contains the requested readme file.

Parameters:

packageValue - The name of the package version that contains the requested readme file.

Returns:

Returns a reference to this object so that method calls can be chained together.

setPackageVersion

public void setPackageVersion(String packageVersion)

A string that contains the package version (for example, 3.5.2).

Parameters:

packageVersion - A string that contains the package version (for example, 3.5.2).

getPackageVersion

public String getPackageVersion()

A string that contains the package version (for example, 3.5.2).

Returns:

A string that contains the package version (for example, 3.5.2).

withPackageVersion

public GetPackageVersionReadmeRequest withPackageVersion(String packageVersion)

A string that contains the package version (for example, 3.5.2).

Parameters:

packageVersion - A string that contains the package version (for example, 3.5.2).

Returns:

Returns a reference to this object so that method calls can be chained together.

toString

public String toString()

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.

Overrides:

toString in class Object

Returns:

A string representation of this object.

See Also:

Object.toString()

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

clone

public GetPackageVersionReadmeRequest clone()

Description copied from class: AmazonWebServiceRequest

Creates a shallow clone of this object for all fields except the handler context. Explicitly does not clone the deep structure of the other fields in the message.

Overrides:

clone in class AmazonWebServiceRequest

See Also:

Object.clone()