Class: Google::Cloud::Dataplex::V1::SearchEntriesRequest

Inherits:
Object
  • Object
show all
Extended by:
Protobuf::MessageExts::ClassMethods
Includes:
Protobuf::MessageExts
Defined in:
proto_docs/google/cloud/dataplex/v1/catalog.rb

Instance Attribute Summary collapse

Instance Attribute Details

#name ⇒ ::String

Returns Required. The project to which the request should be attributed in the following form: projects/{project}/locations/{location}.

Returns:

  • (::String) —

    Required. The project to which the request should be attributed in the following form: projects/{project}/locations/{location}.



1081
1082
1083
1084
 
# File 'proto_docs/google/cloud/dataplex/v1/catalog.rb', line 1081

class SearchEntriesRequest
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#order_by ⇒ ::String

Returns Optional. Specifies the ordering of results. Supported values are:

  • relevance (default)
  • last_modified_timestamp
  • last_modified_timestamp asc.

Returns:

  • (::String) —

    Optional. Specifies the ordering of results. Supported values are:

    • relevance (default)
    • last_modified_timestamp
    • last_modified_timestamp asc


1081
1082
1083
1084
 
# File 'proto_docs/google/cloud/dataplex/v1/catalog.rb', line 1081

class SearchEntriesRequest
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#page_size ⇒ ::Integer

Returns Optional. Number of results in the search page. If <=0, then defaults to 10. Max limit for page_size is 1000. Throws an invalid argument for page_size > 1000.

Returns:

  • (::Integer) —

    Optional. Number of results in the search page. If <=0, then defaults to 10. Max limit for page_size is 1000. Throws an invalid argument for page_size > 1000.



1081
1082
1083
1084
 
# File 'proto_docs/google/cloud/dataplex/v1/catalog.rb', line 1081

class SearchEntriesRequest
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#page_token ⇒ ::String

Returns Optional. Page token received from a previous SearchEntries call. Provide this to retrieve the subsequent page.

Returns:

  • (::String) —

    Optional. Page token received from a previous SearchEntries call. Provide this to retrieve the subsequent page.



1081
1082
1083
1084
 
# File 'proto_docs/google/cloud/dataplex/v1/catalog.rb', line 1081

class SearchEntriesRequest
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#query ⇒ ::String

Returns Required. The query against which entries in scope should be matched. The query syntax is defined in Search syntax for Dataplex Catalog.

Returns:



1081
1082
1083
1084
 
# File 'proto_docs/google/cloud/dataplex/v1/catalog.rb', line 1081

class SearchEntriesRequest
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#scope ⇒ ::String

Returns Optional. The scope under which the search should be operating. It must either be organizations/<org_id> or projects/<project_ref>. If it is unspecified, it defaults to the organization where the project provided in name is located.

Returns:

  • (::String) —

    Optional. The scope under which the search should be operating. It must either be organizations/<org_id> or projects/<project_ref>. If it is unspecified, it defaults to the organization where the project provided in name is located.



1081
1082
1083
1084
 
# File 'proto_docs/google/cloud/dataplex/v1/catalog.rb', line 1081

class SearchEntriesRequest
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end