Package software.amazon.awssdk.services.partnercentralselling.model

Interface ListEngagementInvitationsRequest.Builder

    • Method Detail

      • catalog

        ListEngagementInvitationsRequest.Builder catalog​(String catalog)

        Specifies the catalog from which to list the engagement invitations. Use AWS for production invitations or Sandbox for testing environments.

        Parameters:
        catalog - Specifies the catalog from which to list the engagement invitations. Use AWS for production invitations or Sandbox for testing environments.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • engagementIdentifier

        ListEngagementInvitationsRequest.Builder engagementIdentifier​(Collection<String> engagementIdentifier)

        Retrieves a list of engagement invitation summaries based on specified filters. The ListEngagementInvitations operation allows you to view all invitations that you have sent or received. You must specify the ParticipantType to filter invitations where you are either the SENDER or the RECEIVER. Invitations will automatically expire if not accepted within 15 days.

        Parameters:
        engagementIdentifier - Retrieves a list of engagement invitation summaries based on specified filters. The ListEngagementInvitations operation allows you to view all invitations that you have sent or received. You must specify the ParticipantType to filter invitations where you are either the SENDER or the RECEIVER. Invitations will automatically expire if not accepted within 15 days.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • engagementIdentifier

        ListEngagementInvitationsRequest.Builder engagementIdentifier​(String... engagementIdentifier)

        Retrieves a list of engagement invitation summaries based on specified filters. The ListEngagementInvitations operation allows you to view all invitations that you have sent or received. You must specify the ParticipantType to filter invitations where you are either the SENDER or the RECEIVER. Invitations will automatically expire if not accepted within 15 days.

        Parameters:
        engagementIdentifier - Retrieves a list of engagement invitation summaries based on specified filters. The ListEngagementInvitations operation allows you to view all invitations that you have sent or received. You must specify the ParticipantType to filter invitations where you are either the SENDER or the RECEIVER. Invitations will automatically expire if not accepted within 15 days.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • maxResults

        ListEngagementInvitationsRequest.Builder maxResults​(Integer maxResults)

        Specifies the maximum number of engagement invitations to return in the response. If more results are available, a pagination token will be provided.

        Parameters:
        maxResults - Specifies the maximum number of engagement invitations to return in the response. If more results are available, a pagination token will be provided.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • nextToken

        ListEngagementInvitationsRequest.Builder nextToken​(String nextToken)

        A pagination token used to retrieve additional pages of results when the response to a previous request was truncated. Pass this token to continue listing invitations from where the previous call left off.

        Parameters:
        nextToken - A pagination token used to retrieve additional pages of results when the response to a previous request was truncated. Pass this token to continue listing invitations from where the previous call left off.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • participantType

        ListEngagementInvitationsRequest.Builder participantType​(String participantType)

        Specifies the type of participant for which to list engagement invitations. Identifies the role of the participant.

        Parameters:
        participantType - Specifies the type of participant for which to list engagement invitations. Identifies the role of the participant.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        ParticipantType, ParticipantType

      • participantType

        ListEngagementInvitationsRequest.Builder participantType​(ParticipantType participantType)

        Specifies the type of participant for which to list engagement invitations. Identifies the role of the participant.

        Parameters:
        participantType - Specifies the type of participant for which to list engagement invitations. Identifies the role of the participant.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        ParticipantType, ParticipantType

      • payloadTypeWithStrings

        ListEngagementInvitationsRequest.Builder payloadTypeWithStrings​(Collection<String> payloadType)

        Defines the type of payload associated with the engagement invitations to be listed. The attributes in this payload help decide on acceptance or rejection of the invitation.

        Parameters:
        payloadType - Defines the type of payload associated with the engagement invitations to be listed. The attributes in this payload help decide on acceptance or rejection of the invitation.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • payloadTypeWithStrings

        ListEngagementInvitationsRequest.Builder payloadTypeWithStrings​(String... payloadType)

        Defines the type of payload associated with the engagement invitations to be listed. The attributes in this payload help decide on acceptance or rejection of the invitation.

        Parameters:
        payloadType - Defines the type of payload associated with the engagement invitations to be listed. The attributes in this payload help decide on acceptance or rejection of the invitation.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • payloadType

        ListEngagementInvitationsRequest.Builder payloadType​(Collection<EngagementInvitationPayloadType> payloadType)

        Defines the type of payload associated with the engagement invitations to be listed. The attributes in this payload help decide on acceptance or rejection of the invitation.

        Parameters:
        payloadType - Defines the type of payload associated with the engagement invitations to be listed. The attributes in this payload help decide on acceptance or rejection of the invitation.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • payloadType

        ListEngagementInvitationsRequest.Builder payloadType​(EngagementInvitationPayloadType... payloadType)

        Defines the type of payload associated with the engagement invitations to be listed. The attributes in this payload help decide on acceptance or rejection of the invitation.

        Parameters:
        payloadType - Defines the type of payload associated with the engagement invitations to be listed. The attributes in this payload help decide on acceptance or rejection of the invitation.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • senderAwsAccountId

        ListEngagementInvitationsRequest.Builder senderAwsAccountId​(Collection<String> senderAwsAccountId)

        List of sender AWS account IDs to filter the invitations.

        Parameters:
        senderAwsAccountId - List of sender AWS account IDs to filter the invitations.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • senderAwsAccountId

        ListEngagementInvitationsRequest.Builder senderAwsAccountId​(String... senderAwsAccountId)

        List of sender AWS account IDs to filter the invitations.

        Parameters:
        senderAwsAccountId - List of sender AWS account IDs to filter the invitations.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • sort

        ListEngagementInvitationsRequest.Builder sort​(OpportunityEngagementInvitationSort sort)

        Specifies the sorting options for listing engagement invitations. Invitations can be sorted by fields such as InvitationDate or Status to help partners view results in their preferred order.

        Parameters:
        sort - Specifies the sorting options for listing engagement invitations. Invitations can be sorted by fields such as InvitationDate or Status to help partners view results in their preferred order.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • statusWithStrings

        ListEngagementInvitationsRequest.Builder statusWithStrings​(Collection<String> status)

        Status values to filter the invitations.

        Parameters:
        status - Status values to filter the invitations.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • statusWithStrings

        ListEngagementInvitationsRequest.Builder statusWithStrings​(String... status)

        Status values to filter the invitations.

        Parameters:
        status - Status values to filter the invitations.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • status

        ListEngagementInvitationsRequest.Builder status​(InvitationStatus... status)

        Status values to filter the invitations.

        Parameters:
        status - Status values to filter the invitations.
        Returns:
        Returns a reference to this object so that method calls can be chained together.