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>

  • Method Details

    • 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:

    • 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:

    • 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()
      Description copied from interface: ToCopyableBuilder
      Take this object and create a builder that contains all of the current property values of this object.
      Specified by:
      toBuilder in interface ToCopyableBuilder<DescribePortfolioSharesRequest.Builder,DescribePortfolioSharesRequest>
      Specified by:
      toBuilder in class ServiceCatalogRequest
      Returns:
      a builder for type T

    • 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)
      Description copied from interface: SdkPojo
      Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in an SdkPojo class, and is generated based on a service model.

      If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.

    • 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)
      Description copied from class: SdkRequest
      Used to retrieve the value of a field from any class that extends SdkRequest. The field name specified should match the member name from the corresponding service-2.json model specified in the codegen-resources folder for a given service. The class specifies what class to cast the returned value to. If the returned value is also a modeled class, the SdkRequest.getValueForField(String, Class) method will again be available.
      Overrides:
      getValueForField in class SdkRequest
      Parameters:
      fieldName - The name of the member to be retrieved.
      clazz - The class to cast the returned object to.
      Returns:
      Optional containing the casted return value

    • sdkFields

      public final List<SdkField<?>> sdkFields()
      Specified by:
      sdkFields in interface SdkPojo
      Returns:
      List of SdkField in this POJO. May be empty list but should never be null.

    • sdkFieldNameToField

      public final Map<String,SdkField<?>> sdkFieldNameToField()
      Specified by:
      sdkFieldNameToField in interface SdkPojo
      Returns:
      The mapping between the field name and its corresponding field.