Interface GetSoftwareV2Request.Builder

All Superinterfaces:
AwsRequest.Builder, Buildable, CopyableBuilder<GetSoftwareV2Request.Builder,GetSoftwareV2Request>, SdkBuilder<GetSoftwareV2Request.Builder,GetSoftwareV2Request>, SdkPojo, SdkRequest.Builder, SecurityHubRequest.Builder
Enclosing class:
GetSoftwareV2Request
@Mutable @NotThreadSafe public static interface GetSoftwareV2Request.Builder extends SecurityHubRequest.Builder, SdkPojo, CopyableBuilder<GetSoftwareV2Request.Builder,GetSoftwareV2Request>

  • Method Details

    • filters

      GetSoftwareV2Request.Builder filters(SoftwareFilters filters)

      Filters software packages based on a set of criteria. You can nest composite filters up to three levels deep.

      Parameters:
      filters - Filters software packages based on a set of criteria. You can nest composite filters up to three levels deep.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • filters

      default GetSoftwareV2Request.Builder filters(Consumer<SoftwareFilters.Builder> filters)

      Filters software packages based on a set of criteria. You can nest composite filters up to three levels deep.

      This is a convenience method that creates an instance of the SoftwareFilters.Builder avoiding the need to create one manually via SoftwareFilters.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to filters(SoftwareFilters).

      Parameters:
      filters - a consumer that will call methods on SoftwareFilters.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • scopes

      GetSoftwareV2Request.Builder scopes(SoftwareScopes scopes)

      Limits the results to software on resources from specific organizational units or from the delegated administrator's organization. Only the delegated administrator account can use this parameter. Other accounts receive an AccessDeniedException.

      This parameter is optional. If you omit it, the delegated administrator sees software from all accounts across the entire organization. Other accounts see only software on their own resources.

      You can specify up to 10 entries in Scopes.AwsOrganizations. If multiple entries are specified, the entries are combined using OR logic.

      Parameters:
      scopes - Limits the results to software on resources from specific organizational units or from the delegated administrator's organization. Only the delegated administrator account can use this parameter. Other accounts receive an AccessDeniedException.

      This parameter is optional. If you omit it, the delegated administrator sees software from all accounts across the entire organization. Other accounts see only software on their own resources.

      You can specify up to 10 entries in Scopes.AwsOrganizations. If multiple entries are specified, the entries are combined using OR logic.

      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • scopes

      default GetSoftwareV2Request.Builder scopes(Consumer<SoftwareScopes.Builder> scopes)

      Limits the results to software on resources from specific organizational units or from the delegated administrator's organization. Only the delegated administrator account can use this parameter. Other accounts receive an AccessDeniedException.

      This parameter is optional. If you omit it, the delegated administrator sees software from all accounts across the entire organization. Other accounts see only software on their own resources.

      You can specify up to 10 entries in Scopes.AwsOrganizations. If multiple entries are specified, the entries are combined using OR logic.

      This is a convenience method that creates an instance of the SoftwareScopes.Builder avoiding the need to create one manually via SoftwareScopes.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to scopes(SoftwareScopes).

      Parameters:
      scopes - a consumer that will call methods on SoftwareScopes.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • sortCriteria

      GetSoftwareV2Request.Builder sortCriteria(Collection<SortCriterion> sortCriteria)

      The software attributes used to sort the list of returned software packages. You can't sort by ResourceCount.

      Parameters:
      sortCriteria - The software attributes used to sort the list of returned software packages. You can't sort by ResourceCount.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • sortCriteria

      GetSoftwareV2Request.Builder sortCriteria(SortCriterion... sortCriteria)

      The software attributes used to sort the list of returned software packages. You can't sort by ResourceCount.

      Parameters:
      sortCriteria - The software attributes used to sort the list of returned software packages. You can't sort by ResourceCount.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • sortCriteria

      GetSoftwareV2Request.Builder sortCriteria(Consumer<SortCriterion.Builder>... sortCriteria)

      The software attributes used to sort the list of returned software packages. You can't sort by ResourceCount.

      This is a convenience method that creates an instance of the SortCriterion.Builder avoiding the need to create one manually via SortCriterion.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to sortCriteria(List<SortCriterion>).

      Parameters:
      sortCriteria - a consumer that will call methods on SortCriterion.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • nextToken

      GetSoftwareV2Request.Builder nextToken(String nextToken)

      The token required for pagination. On your first call, set the value of this parameter to NULL. For subsequent calls, to continue listing data, set the value of this parameter to the value returned in the previous response.

      A token expires one hour after it's issued. If you change Filters or SortCriteria between calls, the token is no longer valid and the request fails with a ValidationException.

      Parameters:
      nextToken - The token required for pagination. On your first call, set the value of this parameter to NULL. For subsequent calls, to continue listing data, set the value of this parameter to the value returned in the previous response.

      A token expires one hour after it's issued. If you change Filters or SortCriteria between calls, the token is no longer valid and the request fails with a ValidationException.

      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • maxResults

      GetSoftwareV2Request.Builder maxResults(Integer maxResults)

      The maximum number of results to return. Valid values are 1–100. The default is 100.

      Parameters:
      maxResults - The maximum number of results to return. Valid values are 1–100. The default is 100.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • overrideConfiguration

      GetSoftwareV2Request.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
      Description copied from interface: AwsRequest.Builder
      Add an optional request override configuration.
      Specified by:
      overrideConfiguration in interface AwsRequest.Builder
      Parameters:
      overrideConfiguration - The override configuration.
      Returns:
      This object for method chaining.

    • overrideConfiguration

      GetSoftwareV2Request.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
      Description copied from interface: AwsRequest.Builder
      Add an optional request override configuration.
      Specified by:
      overrideConfiguration in interface AwsRequest.Builder
      Parameters:
      builderConsumer - A Consumer to which an empty AwsRequestOverrideConfiguration.Builder will be given.
      Returns:
      This object for method chaining.