software.amazon.awssdk.services.codeartifact.model

Class GetPackageVersionReadmeResponse

java.lang.Object

software.amazon.awssdk.core.SdkResponse

software.amazon.awssdk.awscore.AwsResponse

software.amazon.awssdk.services.codeartifact.model.CodeartifactResponse

software.amazon.awssdk.services.codeartifact.model.GetPackageVersionReadmeResponse

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<GetPackageVersionReadmeResponse.Builder,GetPackageVersionReadmeResponse>

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

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	GetPackageVersionReadmeResponse.Builder

Method Summary

Modifier and Type	Method and Description
static GetPackageVersionReadmeResponse.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
PackageFormat	format() The format of the package with the requested readme file.
String	formatAsString() The format of the package 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 that contains the returned readme file.
String	readme() The text of the returned readme file.
List<SdkField<?>>	sdkFields()
static Class<? extends GetPackageVersionReadmeResponse.Builder>	serializableBuilderClass()
GetPackageVersionReadmeResponse.Builder	toBuilder()
String	toString() Returns a string representation of this object.
String	version() The version of the package with the requested readme file.
String	versionRevision() The current revision associated with the package version.

Methods inherited from class software.amazon.awssdk.services.codeartifact.model.CodeartifactResponse

responseMetadata

Methods inherited from class software.amazon.awssdk.core.SdkResponse

sdkHttpResponse

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

format

public final PackageFormat format()

The format of the package with the requested readme file. Valid format types 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:

The format of the package with the requested readme file. Valid format types are:

• npm

• pypi

• maven

See Also:

PackageFormat

formatAsString

public final String formatAsString()

The format of the package with the requested readme file. Valid format types 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:

The format of the package with the requested readme file. Valid format types 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 that contains the returned readme file.

Returns:

The name of the package that contains the returned readme file.

version

public final String version()

The version of the package with the requested readme file.

Returns:

The version of the package with the requested readme file.

versionRevision

public final String versionRevision()

The current revision associated with the package version.

Returns:

The current revision associated with the package version.

readme

public final String readme()

The text of the returned readme file.

Returns:

The text of the returned readme file.

toBuilder

public GetPackageVersionReadmeResponse.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<GetPackageVersionReadmeResponse.Builder,GetPackageVersionReadmeResponse>

Overrides:

toBuilder in class AwsResponse

builder

public static GetPackageVersionReadmeResponse.Builder builder()

serializableBuilderClass

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

hashCode

public final int hashCode()

Overrides:

hashCode in class AwsResponse

equals

public final boolean equals(Object obj)

Overrides:

equals in class AwsResponse

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 SdkResponse

sdkFields

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

Specified by:

sdkFields in interface SdkPojo