target.apidocs.com.google.api.services.dataplex.v1.CloudDataplex.Projects.Locations.SearchEntries.html Maven / Gradle / Ivy
CloudDataplex.Projects.Locations.SearchEntries (Cloud Dataplex API v1-rev20241206-2.0.0)
com.google.api.services.dataplex.v1
Class CloudDataplex.Projects.Locations.SearchEntries
- java.lang.Object
-
- java.util.AbstractMap<String,Object>
-
- com.google.api.client.util.GenericData
-
- com.google.api.client.googleapis.services.AbstractGoogleClientRequest<T>
-
- com.google.api.client.googleapis.services.json.AbstractGoogleJsonClientRequest<T>
-
- com.google.api.services.dataplex.v1.CloudDataplexRequest<GoogleCloudDataplexV1SearchEntriesResponse>
-
- com.google.api.services.dataplex.v1.CloudDataplex.Projects.Locations.SearchEntries
-
- Enclosing class:
- CloudDataplex.Projects.Locations
public class CloudDataplex.Projects.Locations.SearchEntries
extends CloudDataplexRequest<GoogleCloudDataplexV1SearchEntriesResponse>
-
-
Nested Class Summary
-
Nested classes/interfaces inherited from class com.google.api.client.util.GenericData
com.google.api.client.util.GenericData.Flags
-
Nested classes/interfaces inherited from class java.util.AbstractMap
AbstractMap.SimpleEntry<K,V>, AbstractMap.SimpleImmutableEntry<K,V>
-
Constructor Summary
Constructors
Modifier
Constructor and Description
protected SearchEntries(String name)
Searches for Entries matching the given query and scope.
-
Method Summary
-
Methods inherited from class com.google.api.services.dataplex.v1.CloudDataplexRequest
get$Xgafv, getAbstractGoogleClient, getAccessToken, getAlt, getCallback, getFields, getKey, getOauthToken, getPrettyPrint, getQuotaUser, getUploadProtocol, getUploadType, setDisableGZipContent, setRequestHeaders
-
Methods inherited from class com.google.api.client.googleapis.services.json.AbstractGoogleJsonClientRequest
getJsonContent, newExceptionOnError, queue
-
Methods inherited from class com.google.api.client.googleapis.services.AbstractGoogleClientRequest
buildHttpRequest, buildHttpRequestUrl, buildHttpRequestUsingHead, checkRequiredParameter, execute, executeAndDownloadTo, executeAsInputStream, executeMedia, executeMediaAndDownloadTo, executeMediaAsInputStream, executeUnparsed, executeUsingHead, getDisableGZipContent, getHttpContent, getLastResponseHeaders, getLastStatusCode, getLastStatusMessage, getMediaHttpDownloader, getMediaHttpUploader, getRequestHeaders, getRequestMethod, getResponseClass, getReturnRawInputSteam, getUriTemplate, initializeMediaDownload, initializeMediaUpload, queue, setReturnRawInputStream
-
Methods inherited from class com.google.api.client.util.GenericData
clone, entrySet, equals, get, getClassInfo, getUnknownKeys, hashCode, put, putAll, remove, setUnknownKeys, toString
-
Methods inherited from class java.util.AbstractMap
clear, containsKey, containsValue, isEmpty, keySet, size, values
-
Methods inherited from class java.lang.Object
finalize, getClass, notify, notifyAll, wait, wait, wait
-
Methods inherited from interface java.util.Map
compute, computeIfAbsent, computeIfPresent, forEach, getOrDefault, merge, putIfAbsent, remove, replace, replace, replaceAll
-
-
Constructor Detail
-
SearchEntries
protected SearchEntries(String name)
Searches for Entries matching the given query and scope.
Create a request for the method "locations.searchEntries".
This request holds the parameters needed by the the dataplex server. After setting any
optional parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote
operation. SearchEntries#initialize(com.google.api.client.googleapis.services.Abstra
ctGoogleClientRequest) must be called to initialize this instance immediately after invoking
the constructor.
- Parameters:
name - Required. The project to which the request should be attributed in the following form:
projects/{project}/locations/{location}.- Since:
- 1.13
-
Method Detail
-
set$Xgafv
public CloudDataplex.Projects.Locations.SearchEntries set$Xgafv(String $Xgafv)
Description copied from class: CloudDataplexRequest
V1 error format.
- Overrides:
set$Xgafv in class CloudDataplexRequest<GoogleCloudDataplexV1SearchEntriesResponse>
-
setAccessToken
public CloudDataplex.Projects.Locations.SearchEntries setAccessToken(String accessToken)
Description copied from class: CloudDataplexRequest
OAuth access token.
- Overrides:
setAccessToken in class CloudDataplexRequest<GoogleCloudDataplexV1SearchEntriesResponse>
-
setAlt
public CloudDataplex.Projects.Locations.SearchEntries setAlt(String alt)
Description copied from class: CloudDataplexRequest
Data format for response.
- Overrides:
setAlt in class CloudDataplexRequest<GoogleCloudDataplexV1SearchEntriesResponse>
-
setCallback
public CloudDataplex.Projects.Locations.SearchEntries setCallback(String callback)
Description copied from class: CloudDataplexRequest
JSONP
- Overrides:
setCallback in class CloudDataplexRequest<GoogleCloudDataplexV1SearchEntriesResponse>
-
setFields
public CloudDataplex.Projects.Locations.SearchEntries setFields(String fields)
Description copied from class: CloudDataplexRequest
Selector specifying which fields to include in a partial response.
- Overrides:
setFields in class CloudDataplexRequest<GoogleCloudDataplexV1SearchEntriesResponse>
-
setKey
public CloudDataplex.Projects.Locations.SearchEntries setKey(String key)
Description copied from class: CloudDataplexRequest
API key. Your API key identifies your project and provides you with API access, quota, and
reports. Required unless you provide an OAuth 2.0 token.
- Overrides:
setKey in class CloudDataplexRequest<GoogleCloudDataplexV1SearchEntriesResponse>
-
setOauthToken
public CloudDataplex.Projects.Locations.SearchEntries setOauthToken(String oauthToken)
Description copied from class: CloudDataplexRequest
OAuth 2.0 token for the current user.
- Overrides:
setOauthToken in class CloudDataplexRequest<GoogleCloudDataplexV1SearchEntriesResponse>
-
setPrettyPrint
public CloudDataplex.Projects.Locations.SearchEntries setPrettyPrint(Boolean prettyPrint)
Description copied from class: CloudDataplexRequest
Returns response with indentations and line breaks.
- Overrides:
setPrettyPrint in class CloudDataplexRequest<GoogleCloudDataplexV1SearchEntriesResponse>
-
setQuotaUser
public CloudDataplex.Projects.Locations.SearchEntries setQuotaUser(String quotaUser)
Description copied from class: CloudDataplexRequest
Available to use for quota purposes for server-side applications. Can be any arbitrary string
assigned to a user, but should not exceed 40 characters.
- Overrides:
setQuotaUser in class CloudDataplexRequest<GoogleCloudDataplexV1SearchEntriesResponse>
-
setUploadType
public CloudDataplex.Projects.Locations.SearchEntries setUploadType(String uploadType)
Description copied from class: CloudDataplexRequest
Legacy upload protocol for media (e.g. "media", "multipart").
- Overrides:
setUploadType in class CloudDataplexRequest<GoogleCloudDataplexV1SearchEntriesResponse>
-
setUploadProtocol
public CloudDataplex.Projects.Locations.SearchEntries setUploadProtocol(String uploadProtocol)
Description copied from class: CloudDataplexRequest
Upload protocol for media (e.g. "raw", "multipart").
- Overrides:
setUploadProtocol in class CloudDataplexRequest<GoogleCloudDataplexV1SearchEntriesResponse>
-
getName
public String getName()
Required. The project to which the request should be attributed in the following form:
projects/{project}/locations/{location}.
-
setName
public CloudDataplex.Projects.Locations.SearchEntries setName(String name)
Required. The project to which the request should be attributed in the following form:
projects/{project}/locations/{location}.
-
getOrderBy
public String getOrderBy()
Optional. Specifies the ordering of results. Supported values are: * relevance (default) *
last_modified_timestamp * last_modified_timestamp asc
-
setOrderBy
public CloudDataplex.Projects.Locations.SearchEntries setOrderBy(String orderBy)
Optional. Specifies the ordering of results. Supported values are: * relevance (default)
* last_modified_timestamp * last_modified_timestamp asc
-
getPageSize
public Integer getPageSize()
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.
-
setPageSize
public CloudDataplex.Projects.Locations.SearchEntries setPageSize(Integer pageSize)
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.
-
getPageToken
public String getPageToken()
Optional. Page token received from a previous SearchEntries call. Provide this to retrieve the
subsequent page.
-
setPageToken
public CloudDataplex.Projects.Locations.SearchEntries setPageToken(String pageToken)
Optional. Page token received from a previous SearchEntries call. Provide this to
retrieve the subsequent page.
-
getQuery
public String getQuery()
Required. The query against which entries in scope should be matched. The query syntax is defined
in Search syntax for Dataplex Catalog (https://cloud.google.com/dataplex/docs/search-syntax).
-
setQuery
public CloudDataplex.Projects.Locations.SearchEntries setQuery(String query)
Required. The query against which entries in scope should be matched. The query syntax is
defined in Search syntax for Dataplex Catalog
(https://cloud.google.com/dataplex/docs/search-syntax).
-
getScope
public String getScope()
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.
-
setScope
public CloudDataplex.Projects.Locations.SearchEntries setScope(String 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.
-
set
public CloudDataplex.Projects.Locations.SearchEntries set(String parameterName,
Object value)
- Overrides:
set in class CloudDataplexRequest<GoogleCloudDataplexV1SearchEntriesResponse>
Copyright © 2011–2024 Google. All rights reserved.
© 2015 - 2025 Weber Informatics LLC | Privacy Policy