Interface DescribePortfolioSharesRequest.Builder

    • Method Detail

      • portfolioId

        DescribePortfolioSharesRequest.Builder portfolioId​(String portfolioId)

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

        Parameters:
        portfolioId - The unique identifier of the portfolio for which shares will be retrieved.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
      • type

        DescribePortfolioSharesRequest.Builder type​(String 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.

        Parameters:
        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.

        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        DescribePortfolioShareType, DescribePortfolioShareType
      • type

        DescribePortfolioSharesRequest.Builder type​(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.

        Parameters:
        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.

        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        DescribePortfolioShareType, DescribePortfolioShareType
      • pageToken

        DescribePortfolioSharesRequest.Builder pageToken​(String pageToken)

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

        Parameters:
        pageToken - The page token for the next set of results. To retrieve the first set of results, use null.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
      • pageSize

        DescribePortfolioSharesRequest.Builder pageSize​(Integer pageSize)

        The maximum number of items to return with this call.

        Parameters:
        pageSize - The maximum number of items to return with this call.
        Returns:
        Returns a reference to this object so that method calls can be chained together.