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

Class SearchProvisionedProductsRequest

    • Method Detail

      • acceptLanguage

        public final String acceptLanguage()

        The language code.

        • jp - Japanese

        • zh - Chinese

        Returns:
        The language code.

        • jp - Japanese

        • zh - Chinese

      • accessLevelFilter

        public final AccessLevelFilter accessLevelFilter()

        The access level to use to obtain results. The default is User.

        Returns:
        The access level to use to obtain results. The default is User.

      • filters

        public final Map<ProvisionedProductViewFilterBy,​List<String>> filters()

        The search filters.

        When the key is SearchQuery, the searchable fields are arn, createdTime, id, lastRecordId, idempotencyToken, name, physicalId, productId, provisioningArtifactId, type, status, tags, userArn, userArnSession, lastProvisioningRecordId, lastSuccessfulProvisioningRecordId, productName, and provisioningArtifactName.

        Example: "SearchQuery":["status:AVAILABLE"]

        Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

        This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasFilters() method.

        Returns:
        The search filters.

        When the key is SearchQuery, the searchable fields are arn, createdTime, id, lastRecordId, idempotencyToken, name, physicalId, productId, provisioningArtifactId, type, status, tags, userArn, userArnSession, lastProvisioningRecordId, lastSuccessfulProvisioningRecordId, productName, and provisioningArtifactName.

        Example: "SearchQuery":["status:AVAILABLE"]

      • hasFilters

        public final boolean hasFilters()
        For responses, this returns true if the service returned a value for the Filters property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

      • filtersAsStrings

        public final Map<String,​List<String>> filtersAsStrings()

        The search filters.

        When the key is SearchQuery, the searchable fields are arn, createdTime, id, lastRecordId, idempotencyToken, name, physicalId, productId, provisioningArtifactId, type, status, tags, userArn, userArnSession, lastProvisioningRecordId, lastSuccessfulProvisioningRecordId, productName, and provisioningArtifactName.

        Example: "SearchQuery":["status:AVAILABLE"]

        Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

        This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasFilters() method.

        Returns:
        The search filters.

        When the key is SearchQuery, the searchable fields are arn, createdTime, id, lastRecordId, idempotencyToken, name, physicalId, productId, provisioningArtifactId, type, status, tags, userArn, userArnSession, lastProvisioningRecordId, lastSuccessfulProvisioningRecordId, productName, and provisioningArtifactName.

        Example: "SearchQuery":["status:AVAILABLE"]

      • sortBy

        public final String sortBy()

        The sort field. If no value is specified, the results are not sorted. The valid values are arn, id, name, and lastRecordId.

        Returns:
        The sort field. If no value is specified, the results are not sorted. The valid values are arn, id, name, and lastRecordId.

      • sortOrder

        public final SortOrder sortOrder()

        The sort order. If no value is specified, the results are not sorted.

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

        Returns:
        The sort order. If no value is specified, the results are not sorted.
        See Also:
        SortOrder

      • sortOrderAsString

        public final String sortOrderAsString()

        The sort order. If no value is specified, the results are not sorted.

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

        Returns:
        The sort order. If no value is specified, the results are not sorted.
        See Also:
        SortOrder

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

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

      • 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