Package software.amazon.awssdk.services.codeartifact.model

Class DescribePackageRequest

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

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<DescribePackageRequest.Builder,DescribePackageRequest>

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

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	DescribePackageRequest.Builder

Method Summary

Modifier and Type	Method	Description
static DescribePackageRequest.Builder	builder()
String	domain()	The name of the domain that contains the repository that contains the package.
String	domainOwner()	The 12-digit account number of the Amazon Web Services account that owns the domain.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
PackageFormat	format()	A format that specifies the type of the requested package.
String	formatAsString()	A format that specifies the type of the requested package.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
String	namespace()	The namespace of the requested package.
String	packageValue()	The name of the requested package.
String	repository()	The name of the repository that contains the requested package.
List<SdkField<?>>	sdkFields()
static Class<? extends DescribePackageRequest.Builder>	serializableBuilderClass()
DescribePackageRequest.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.

Returns:

The name of the domain that contains the repository that contains the package.

domainOwner

public final String domainOwner()

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.

repository

public final String repository()

The name of the repository that contains the requested package.

Returns:

The name of the repository that contains the requested package.

format

public final PackageFormat format()

A format that specifies the type of the requested package.

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 requested package.

See Also:

PackageFormat

formatAsString

public final String formatAsString()

A format that specifies the type of the requested package.

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 requested package.

See Also:

PackageFormat

namespace

public final String namespace()

The namespace of the requested 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 is required when requesting Maven packages.

• The namespace of an npm package is its scope.

• Python and NuGet packages do not contain a corresponding component, packages of those formats do not have a namespace.

• The namespace of a generic package is its namespace.

Returns:

The namespace of the requested 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 is required when requesting Maven packages.

• The namespace of an npm package is its scope.

• Python and NuGet packages do not contain a corresponding component, packages of those formats do not have a namespace.

• The namespace of a generic package is its namespace.

packageValue

public final String packageValue()

The name of the requested package.

Returns:

The name of the requested package.

toBuilder

public DescribePackageRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<DescribePackageRequest.Builder,DescribePackageRequest>

Specified by:

toBuilder in class CodeartifactRequest

builder

public static DescribePackageRequest.Builder builder()

serializableBuilderClass

public static Class<? extends DescribePackageRequest.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