software.amazon.awssdk.services.codeartifact.model

Class GetPackageVersionReadmeRequest

java.lang.Object

software.amazon.awssdk.core.SdkRequest

software.amazon.awssdk.awscore.AwsRequest

software.amazon.awssdk.services.codeartifact.model.CodeartifactRequest

software.amazon.awssdk.services.codeartifact.model.GetPackageVersionReadmeRequest

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<GetPackageVersionReadmeRequest.Builder,GetPackageVersionReadmeRequest>

@Generated(value="software.amazon.awssdk:codegen")
public final class GetPackageVersionReadmeRequest
extends CodeartifactRequest
implements ToCopyableBuilder<GetPackageVersionReadmeRequest.Builder,GetPackageVersionReadmeRequest>

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	GetPackageVersionReadmeRequest.Builder

Method Summary

Modifier and Type	Method and Description
static GetPackageVersionReadmeRequest.Builder	builder()
String	domain() The name of the domain that contains the repository that contains the package version with the requested readme file.
String	domainOwner() The 12-digit account number of the AWS account that owns the domain.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
PackageFormat	format() A format that specifies the type of the package version with the requested readme file.
String	formatAsString() A format that specifies the type of the package version with the requested readme file.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
String	namespace() The namespace of the package.
String	packageValue() The name of the package version that contains the requested readme file.
String	packageVersion() A string that contains the package version (for example, 3.5.2).
String	repository() The repository that contains the package with the requested readme file.
List<SdkField<?>>	sdkFields()
static Class<? extends GetPackageVersionReadmeRequest.Builder>	serializableBuilderClass()
GetPackageVersionReadmeRequest.Builder	toBuilder()
String	toString() Returns a string representation of this object.

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest

overrideConfiguration

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

copy

Method Detail

domain

public final String domain()

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.

domainOwner

public final String domainOwner()

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

Returns:

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

repository

public final String repository()

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

Returns:

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

format

public final PackageFormat format()

A format that specifies the type of the package version with the requested readme file. The valid values are:

• npm

• pypi

• maven

If the service returns an enum value that is not available in the current SDK version, format will return PackageFormat.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from formatAsString().

Returns:

A format that specifies the type of the package version with the requested readme file. The valid values are:

• npm

• pypi

• maven

See Also:

PackageFormat

formatAsString

public final String formatAsString()

A format that specifies the type of the package version with the requested readme file. The valid values are:

• npm

• pypi

• maven

If the service returns an enum value that is not available in the current SDK version, format will return PackageFormat.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from formatAsString().

Returns:

A format that specifies the type of the package version with the requested readme file. The valid values are:

• npm

• pypi

• maven

See Also:

PackageFormat

namespace

public final String namespace()

The namespace of the package. The package component that specifies its namespace depends on its type. For example:

• The namespace of a Maven package is its groupId.

• The namespace of an npm package is its scope.

• A Python package does not contain a corresponding component, so Python packages do not have a namespace.

Returns:

The namespace of the package. The package component that specifies its namespace depends on its type. For example:

• The namespace of a Maven package is its groupId.

• The namespace of an npm package is its scope.

• A Python package does not contain a corresponding component, so Python packages do not have a namespace.

packageValue

public final String packageValue()

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.

packageVersion

public final String packageVersion()

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).

toBuilder

public GetPackageVersionReadmeRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<GetPackageVersionReadmeRequest.Builder,GetPackageVersionReadmeRequest>

Specified by:

toBuilder in class CodeartifactRequest

builder

public static GetPackageVersionReadmeRequest.Builder builder()

serializableBuilderClass

public static Class<? extends GetPackageVersionReadmeRequest.Builder> serializableBuilderClass()

hashCode

public final int hashCode()

Overrides:

hashCode in class AwsRequest

equals

public final boolean equals(Object obj)

Overrides:

equals in class AwsRequest

equalsBySdkFields

public final boolean equalsBySdkFields(Object obj)

Specified by:

equalsBySdkFields in interface SdkPojo

toString

public final 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

getValueForField

public final <T> Optional<T> getValueForField(String fieldName,
                                              Class<T> clazz)

Overrides:

getValueForField in class SdkRequest

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo