Class: Aws::WorkDocs::Types::SearchResourcesRequest

Inherits:

Struct

• Object
• Struct
• Aws::WorkDocs::Types::SearchResourcesRequest

Includes:

Structure

Defined in:

lib/aws-sdk-workdocs/types.rb

Overview

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[:authentication_token, :query_text]

Instance Attribute Summary

• #additional_response_fields ⇒ Array<String>

  A list of attributes to include in the response.

• #authentication_token ⇒ String

  Amazon WorkDocs authentication token.

• #filters ⇒ Types::Filters

  Filters results based on entity metadata.

• #limit ⇒ Integer

  Max results count per page.

• #marker ⇒ String

  The marker for the next set of results.

• #order_by ⇒ Array<Types::SearchSortResult>

  Order by results in one or more categories.

• #organization_id ⇒ String

  Filters based on the resource owner OrgId.

• #query_scopes ⇒ Array<String>

  Filter based on the text field type.

• #query_text ⇒ String

  The String to search for.

Instance Attribute Details

#additional_response_fields ⇒ Array<String>

A list of attributes to include in the response. Used to request fields that are not normally returned in a standard response.

Returns:

• (Array<String>)

# File 'lib/aws-sdk-workdocs/types.rb', line 2571

class SearchResourcesRequest < Struct.new(
  :authentication_token,
  :query_text,
  :query_scopes,
  :organization_id,
  :additional_response_fields,
  :filters,
  :order_by,
  :limit,
  :marker)
  SENSITIVE = [:authentication_token, :query_text]
  include Aws::Structure
end

#authentication_token ⇒ String

Amazon WorkDocs authentication token. Not required when using Amazon Web Services administrator credentials to access the API.

Returns:

• (String)

# File 'lib/aws-sdk-workdocs/types.rb', line 2571

class SearchResourcesRequest < Struct.new(
  :authentication_token,
  :query_text,
  :query_scopes,
  :organization_id,
  :additional_response_fields,
  :filters,
  :order_by,
  :limit,
  :marker)
  SENSITIVE = [:authentication_token, :query_text]
  include Aws::Structure
end

#filters ⇒ Types::Filters

Filters results based on entity metadata.

Returns:

• (Types::Filters)

# File 'lib/aws-sdk-workdocs/types.rb', line 2571

class SearchResourcesRequest < Struct.new(
  :authentication_token,
  :query_text,
  :query_scopes,
  :organization_id,
  :additional_response_fields,
  :filters,
  :order_by,
  :limit,
  :marker)
  SENSITIVE = [:authentication_token, :query_text]
  include Aws::Structure
end

#limit ⇒ Integer

Max results count per page.

Returns:

• (Integer)

# File 'lib/aws-sdk-workdocs/types.rb', line 2571

class SearchResourcesRequest < Struct.new(
  :authentication_token,
  :query_text,
  :query_scopes,
  :organization_id,
  :additional_response_fields,
  :filters,
  :order_by,
  :limit,
  :marker)
  SENSITIVE = [:authentication_token, :query_text]
  include Aws::Structure
end

#marker ⇒ String

The marker for the next set of results.

Returns:

• (String)

# File 'lib/aws-sdk-workdocs/types.rb', line 2571

class SearchResourcesRequest < Struct.new(
  :authentication_token,
  :query_text,
  :query_scopes,
  :organization_id,
  :additional_response_fields,
  :filters,
  :order_by,
  :limit,
  :marker)
  SENSITIVE = [:authentication_token, :query_text]
  include Aws::Structure
end

#order_by ⇒ Array<Types::SearchSortResult>

Order by results in one or more categories.

Returns:

• (Array<Types::SearchSortResult>)

# File 'lib/aws-sdk-workdocs/types.rb', line 2571

class SearchResourcesRequest < Struct.new(
  :authentication_token,
  :query_text,
  :query_scopes,
  :organization_id,
  :additional_response_fields,
  :filters,
  :order_by,
  :limit,
  :marker)
  SENSITIVE = [:authentication_token, :query_text]
  include Aws::Structure
end

#organization_id ⇒ String

Filters based on the resource owner OrgId. This is a mandatory parameter when using Admin SigV4 credentials.

Returns:

• (String)

# File 'lib/aws-sdk-workdocs/types.rb', line 2571

class SearchResourcesRequest < Struct.new(
  :authentication_token,
  :query_text,
  :query_scopes,
  :organization_id,
  :additional_response_fields,
  :filters,
  :order_by,
  :limit,
  :marker)
  SENSITIVE = [:authentication_token, :query_text]
  include Aws::Structure
end

#query_scopes ⇒ Array<String>

Filter based on the text field type. A Folder has only a name and no content. A Comment has only content and no name. A Document or Document Version has a name and content

Returns:

• (Array<String>)

# File 'lib/aws-sdk-workdocs/types.rb', line 2571

class SearchResourcesRequest < Struct.new(
  :authentication_token,
  :query_text,
  :query_scopes,
  :organization_id,
  :additional_response_fields,
  :filters,
  :order_by,
  :limit,
  :marker)
  SENSITIVE = [:authentication_token, :query_text]
  include Aws::Structure
end

#query_text ⇒ String

The String to search for. Searches across different text fields based on request parameters. Use double quotes around the query string for exact phrase matches.

Returns:

• (String)

# File 'lib/aws-sdk-workdocs/types.rb', line 2571

class SearchResourcesRequest < Struct.new(
  :authentication_token,
  :query_text,
  :query_scopes,
  :organization_id,
  :additional_response_fields,
  :filters,
  :order_by,
  :limit,
  :marker)
  SENSITIVE = [:authentication_token, :query_text]
  include Aws::Structure
end