Google Cloud Dataplex V1 Client - Class SearchEntriesRequest (1.0.1)

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

Generated from protobuf message google.cloud.dataplex.v1.SearchEntriesRequest

Namespace

Google \ Cloud \ Dataplex \ V1

Methods

__construct

Constructor.

Parameters
Name
Description
data
array

Optional. Data for populating the Message object.

↳ name
string

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

↳ query
string

Required. The query against which entries in scope should be matched.

↳ page_size
int

Optional. Pagination.

↳ page_token
string
↳ order_by
string

Optional. Ordering of the results. Supported options to be added later.

↳ scope
string

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

getName

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

Returns
Type
Description
string

setName

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

Parameter
Name
Description
var
string
Returns
Type
Description
$this

getQuery

Required. The query against which entries in scope should be matched.

Returns
Type
Description
string

setQuery

Required. The query against which entries in scope should be matched.

Parameter
Name
Description
var
string
Returns
Type
Description
$this

getPageSize

Optional. Pagination.

Returns
Type
Description
int

setPageSize

Optional. Pagination.

Parameter
Name
Description
var
int
Returns
Type
Description
$this

getPageToken

Generated from protobuf field string page_token = 4 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type
Description
string

setPageToken

Generated from protobuf field string page_token = 4 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name
Description
var
string
Returns
Type
Description
$this

getOrderBy

Optional. Ordering of the results. Supported options to be added later.

Returns
Type
Description
string

setOrderBy

Optional. Ordering of the results. Supported options to be added later.

Parameter
Name
Description
var
string
Returns
Type
Description
$this

getScope

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

Returns
Type
Description
string

setScope

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

Parameter
Name
Description
var
string
Returns
Type
Description
$this

static::build

Parameters
Name
Description
name
string

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

query
string

Required. The query against which entries in scope should be matched.

Create a Mobile Website
View Site in Mobile | Classic
Share by: