Dataplex V1 API - Class Google::Cloud::Dataplex::V1::SearchEntriesRequest (v1.2.0)

Reference documentation and code samples for the Dataplex V1 API class Google::Cloud::Dataplex::V1::SearchEntriesRequest.

Inherits

  • Object

Extended By

  • Google::Protobuf::MessageExts::ClassMethods

Includes

  • Google::Protobuf::MessageExts

Methods

#name

def name() -> ::String
Returns
  • (::String) — Required. The project to which the request should be attributed in the following form: projects/{project}/locations/{location}.

#name=

def name=(value) -> ::String
Parameter
  • value (::String) — 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}.

#order_by

def order_by() -> ::String
Returns
  • (::String) — Optional. Specifies the ordering of results.

#order_by=

def order_by=(value) -> ::String
Parameter
  • value (::String) — Optional. Specifies the ordering of results.
Returns
  • (::String) — Optional. Specifies the ordering of results.

#page_size

def page_size() -> ::Integer
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.

#page_size=

def page_size=(value) -> ::Integer
Parameter
  • value (::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.
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.

#page_token

def page_token() -> ::String
Returns
  • (::String) — Optional. Page token received from a previous SearchEntries call. Provide this to retrieve the subsequent page.

#page_token=

def page_token=(value) -> ::String
Parameter
  • value (::String) — 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.

#query

def query() -> ::String
Returns
  • (::String) — Required. The query against which entries in scope should be matched.

#query=

def query=(value) -> ::String
Parameter
  • value (::String) — Required. The query against which entries in scope should be matched.
Returns
  • (::String) — Required. The query against which entries in scope should be matched.

#scope

def scope() -> ::String
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.

#scope=

def scope=(value) -> ::String
Parameter
  • value (::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.
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.