Class ProjectsResource.LocationsResource.SearchEntriesRequest

Searches for Entries matching the given query and scope.

Inheritance
object
ClientServiceRequest
ClientServiceRequest<GoogleCloudDataplexV1SearchEntriesResponse>
CloudDataplexBaseServiceRequest<GoogleCloudDataplexV1SearchEntriesResponse>
ProjectsResource.LocationsResource.SearchEntriesRequest
Implements
Inherited Members
Namespace: Google.Apis.CloudDataplex.v1
Assembly: Google.Apis.CloudDataplex.v1.dll
Syntax
public class ProjectsResource.LocationsResource.SearchEntriesRequest : CloudDataplexBaseServiceRequest<GoogleCloudDataplexV1SearchEntriesResponse>, IClientServiceRequest<GoogleCloudDataplexV1SearchEntriesResponse>, IClientServiceRequest

Constructors

SearchEntriesRequest(IClientService, string)

Constructs a new SearchEntries request.

Declaration
public SearchEntriesRequest(IClientService service, string name)
Parameters
Type Name Description
IClientService service
string name

Properties

Contexts

Optional. Specifies the scope of the context in which the search will be performed. This scope will also be used to perform IAM checks, which if passing, will return all resources in the scope.

Declaration
[RequestParameter("contexts", RequestParameterType.Query)]
public virtual Repeatable<string> Contexts { get; set; }
Property Value
Type Description
Repeatable<string>

HttpMethod

Gets the HTTP method.

Declaration
public override string HttpMethod { get; }
Property Value
Type Description
string
Overrides

MethodName

Gets the method name.

Declaration
public override string MethodName { get; }
Property Value
Type Description
string
Overrides

Name

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

Declaration
[RequestParameter("name", RequestParameterType.Path)]
public virtual string Name { get; }
Property Value
Type Description
string

OrderBy

Optional. Specifies the ordering of results. Supported values are: relevance last_modified_timestamp last_modified_timestamp asc

Declaration
[RequestParameter("orderBy", RequestParameterType.Query)]
public virtual string OrderBy { get; set; }
Property Value
Type Description
string

PageSize

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

Declaration
[RequestParameter("pageSize", RequestParameterType.Query)]
public virtual int? PageSize { get; set; }
Property Value
Type Description
int?

PageToken

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

Declaration
[RequestParameter("pageToken", RequestParameterType.Query)]
public virtual string PageToken { get; set; }
Property Value
Type Description
string

Query

Required. The query against which entries in scope should be matched. The query syntax is defined in Search syntax for Dataplex Universal Catalog (https://cloud.google.com/dataplex/docs/search-syntax).

Declaration
[RequestParameter("query", RequestParameterType.Query)]
public virtual string Query { get; set; }
Property Value
Type Description
string

RestPath

Gets the REST path.

Declaration
public override string RestPath { get; }
Property Value
Type Description
string
Overrides

Scope

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

Declaration
[RequestParameter("scope", RequestParameterType.Query)]
public virtual string Scope { get; set; }
Property Value
Type Description
string

SemanticSearch

Optional. Specifies whether the search should understand the meaning and intent behind the query, rather than just matching keywords.

Declaration
[RequestParameter("semanticSearch", RequestParameterType.Query)]
public virtual bool? SemanticSearch { get; set; }
Property Value
Type Description
bool?

Methods

InitParameters()

Initializes SearchEntries parameter list.

Declaration
protected override void InitParameters()
Overrides

Implements