Package software.amazon.awssdk.services.servicecatalog.model

Class DescribePortfolioSharesRequest

java.lang.Object

software.amazon.awssdk.core.SdkRequest

software.amazon.awssdk.awscore.AwsRequest

software.amazon.awssdk.services.servicecatalog.model.ServiceCatalogRequest

software.amazon.awssdk.services.servicecatalog.model.DescribePortfolioSharesRequest

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<DescribePortfolioSharesRequest.Builder,DescribePortfolioSharesRequest>

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

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	DescribePortfolioSharesRequest.Builder

Method Summary

Modifier and Type	Method	Description
static DescribePortfolioSharesRequest.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
Integer	pageSize()	The maximum number of items to return with this call.
String	pageToken()	The page token for the next set of results.
String	portfolioId()	The unique identifier of the portfolio for which shares will be retrieved.
Map<String,SdkField<?>>	sdkFieldNameToField()
List<SdkField<?>>	sdkFields()
static Class<? extends DescribePortfolioSharesRequest.Builder>	serializableBuilderClass()
DescribePortfolioSharesRequest.Builder	toBuilder()
String	toString()	Returns a string representation of this object.
DescribePortfolioShareType	type()	The type of portfolio share to summarize.
String	typeAsString()	The type of portfolio share to summarize.

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

portfolioId

public final String portfolioId()

The unique identifier of the portfolio for which shares will be retrieved.

Returns:

The unique identifier of the portfolio for which shares will be retrieved.

type

public final DescribePortfolioShareType type()

The type of portfolio share to summarize. This field acts as a filter on the type of portfolio share, which can be one of the following:

1. ACCOUNT - Represents an external account to account share.

2. ORGANIZATION - Represents a share to an organization. This share is available to every account in the organization.

3. ORGANIZATIONAL_UNIT - Represents a share to an organizational unit.

4. ORGANIZATION_MEMBER_ACCOUNT - Represents a share to an account in the organization.

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

Returns:

The type of portfolio share to summarize. This field acts as a filter on the type of portfolio share, which can be one of the following:

1. ACCOUNT - Represents an external account to account share.

2. ORGANIZATION - Represents a share to an organization. This share is available to every account in the organization.

3. ORGANIZATIONAL_UNIT - Represents a share to an organizational unit.

4. ORGANIZATION_MEMBER_ACCOUNT - Represents a share to an account in the organization.

See Also:

DescribePortfolioShareType

typeAsString

public final String typeAsString()

The type of portfolio share to summarize. This field acts as a filter on the type of portfolio share, which can be one of the following:

1. ACCOUNT - Represents an external account to account share.

2. ORGANIZATION - Represents a share to an organization. This share is available to every account in the organization.

3. ORGANIZATIONAL_UNIT - Represents a share to an organizational unit.

4. ORGANIZATION_MEMBER_ACCOUNT - Represents a share to an account in the organization.

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

Returns:

The type of portfolio share to summarize. This field acts as a filter on the type of portfolio share, which can be one of the following:

1. ACCOUNT - Represents an external account to account share.

2. ORGANIZATION - Represents a share to an organization. This share is available to every account in the organization.

3. ORGANIZATIONAL_UNIT - Represents a share to an organizational unit.

4. ORGANIZATION_MEMBER_ACCOUNT - Represents a share to an account in the organization.

See Also:

DescribePortfolioShareType

pageToken

public final String pageToken()

The page token for the next set of results. To retrieve the first set of results, use null.

Returns:

The page token for the next set of results. To retrieve the first set of results, use null.

pageSize

public final Integer pageSize()

The maximum number of items to return with this call.

Returns:

The maximum number of items to return with this call.

toBuilder

public DescribePortfolioSharesRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<DescribePortfolioSharesRequest.Builder,DescribePortfolioSharesRequest>

Specified by:

toBuilder in class ServiceCatalogRequest

builder

public static DescribePortfolioSharesRequest.Builder builder()

serializableBuilderClass

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

sdkFieldNameToField

public final Map<String,SdkField<?>> sdkFieldNameToField()

Specified by:

sdkFieldNameToField in interface SdkPojo