- 1.76.0 (latest)
 - 1.74.0
 - 1.73.0
 - 1.72.0
 - 1.71.0
 - 1.70.0
 - 1.68.0
 - 1.66.0
 - 1.65.0
 - 1.62.0
 - 1.61.0
 - 1.60.0
 - 1.58.0
 - 1.57.0
 - 1.56.0
 - 1.55.0
 - 1.54.0
 - 1.53.0
 - 1.52.0
 - 1.51.0
 - 1.50.0
 - 1.49.0
 - 1.47.0
 - 1.46.0
 - 1.45.0
 - 1.44.0
 - 1.43.0
 - 1.42.0
 - 1.41.0
 - 1.40.0
 - 1.39.0
 - 1.38.0
 - 1.37.0
 - 1.35.0
 - 1.34.0
 - 1.33.0
 - 1.32.0
 - 1.31.0
 - 1.30.0
 - 1.29.0
 - 1.28.0
 - 1.27.0
 - 1.26.0
 - 1.25.0
 - 1.22.0
 - 1.21.0
 - 1.20.0
 - 1.19.0
 - 1.18.0
 - 1.17.0
 - 1.16.0
 - 1.15.0
 - 1.14.0
 - 1.13.0
 - 1.12.0
 - 1.11.0
 - 1.10.0
 - 1.9.0
 - 1.7.0
 - 1.6.0
 - 1.5.0
 - 1.4.0
 - 1.3.0
 - 1.2.0
 - 1.1.2
 - 1.0.1
 - 0.2.2
 
public static final class SearchEntriesRequest.Builder extends GeneratedMessageV3.Builder<SearchEntriesRequest.Builder> implements SearchEntriesRequestOrBuilderProtobuf type google.cloud.dataplex.v1.SearchEntriesRequest
Inheritance
Object > AbstractMessageLite.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessageV3.Builder > SearchEntriesRequest.BuilderImplements
SearchEntriesRequestOrBuilderStatic Methods
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()| Returns | |
|---|---|
| Type | Description | 
Descriptor | 
        |
Methods
addRepeatedField(Descriptors.FieldDescriptor field, Object value)
public SearchEntriesRequest.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)| Parameters | |
|---|---|
| Name | Description | 
field | 
        FieldDescriptor | 
      
value | 
        Object | 
      
| Returns | |
|---|---|
| Type | Description | 
SearchEntriesRequest.Builder | 
        |
build()
public SearchEntriesRequest build()| Returns | |
|---|---|
| Type | Description | 
SearchEntriesRequest | 
        |
buildPartial()
public SearchEntriesRequest buildPartial()| Returns | |
|---|---|
| Type | Description | 
SearchEntriesRequest | 
        |
clear()
public SearchEntriesRequest.Builder clear()| Returns | |
|---|---|
| Type | Description | 
SearchEntriesRequest.Builder | 
        |
clearField(Descriptors.FieldDescriptor field)
public SearchEntriesRequest.Builder clearField(Descriptors.FieldDescriptor field)| Parameter | |
|---|---|
| Name | Description | 
field | 
        FieldDescriptor | 
      
| Returns | |
|---|---|
| Type | Description | 
SearchEntriesRequest.Builder | 
        |
clearName()
public SearchEntriesRequest.Builder clearName() Required. The project to which the request should be attributed in the
 following form: projects/{project}/locations/{location}.
 
 string name = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
 
| Returns | |
|---|---|
| Type | Description | 
SearchEntriesRequest.Builder | 
        This builder for chaining.  | 
      
clearOneof(Descriptors.OneofDescriptor oneof)
public SearchEntriesRequest.Builder clearOneof(Descriptors.OneofDescriptor oneof)| Parameter | |
|---|---|
| Name | Description | 
oneof | 
        OneofDescriptor | 
      
| Returns | |
|---|---|
| Type | Description | 
SearchEntriesRequest.Builder | 
        |
clearOrderBy()
public SearchEntriesRequest.Builder clearOrderBy()Optional. Specifies the ordering of results. Supported values are:
relevance(default)last_modified_timestamplast_modified_timestamp asc
 string order_by = 5 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description | 
SearchEntriesRequest.Builder | 
        This builder for chaining.  | 
      
clearPageSize()
public SearchEntriesRequest.Builder clearPageSize()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.
 int32 page_size = 3 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description | 
SearchEntriesRequest.Builder | 
        This builder for chaining.  | 
      
clearPageToken()
public SearchEntriesRequest.Builder clearPageToken() Optional. Page token received from a previous SearchEntries call. Provide
 this to retrieve the subsequent page.
 string page_token = 4 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description | 
SearchEntriesRequest.Builder | 
        This builder for chaining.  | 
      
clearQuery()
public SearchEntriesRequest.Builder clearQuery()Required. The query against which entries in scope should be matched. The query syntax is defined in Search syntax for Dataplex Catalog.
 string query = 2 [(.google.api.field_behavior) = REQUIRED];
| Returns | |
|---|---|
| Type | Description | 
SearchEntriesRequest.Builder | 
        This builder for chaining.  | 
      
clearScope()
public SearchEntriesRequest.Builder clearScope() 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.
 string scope = 7 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description | 
SearchEntriesRequest.Builder | 
        This builder for chaining.  | 
      
clearSemanticSearch()
public SearchEntriesRequest.Builder clearSemanticSearch()Optional. Specifies whether the search should understand the meaning and intent behind the query, rather than just matching keywords.
 bool semantic_search = 11 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description | 
SearchEntriesRequest.Builder | 
        This builder for chaining.  | 
      
clone()
public SearchEntriesRequest.Builder clone()| Returns | |
|---|---|
| Type | Description | 
SearchEntriesRequest.Builder | 
        |
getDefaultInstanceForType()
public SearchEntriesRequest getDefaultInstanceForType()| Returns | |
|---|---|
| Type | Description | 
SearchEntriesRequest | 
        |
getDescriptorForType()
public Descriptors.Descriptor getDescriptorForType()| Returns | |
|---|---|
| Type | Description | 
Descriptor | 
        |
getName()
public String getName() Required. The project to which the request should be attributed in the
 following form: projects/{project}/locations/{location}.
 
 string name = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
 
| Returns | |
|---|---|
| Type | Description | 
String | 
        The name.  | 
      
getNameBytes()
public ByteString getNameBytes() Required. The project to which the request should be attributed in the
 following form: projects/{project}/locations/{location}.
 
 string name = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
 
| Returns | |
|---|---|
| Type | Description | 
ByteString | 
        The bytes for name.  | 
      
getOrderBy()
public String getOrderBy()Optional. Specifies the ordering of results. Supported values are:
relevance(default)last_modified_timestamplast_modified_timestamp asc
 string order_by = 5 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description | 
String | 
        The orderBy.  | 
      
getOrderByBytes()
public ByteString getOrderByBytes()Optional. Specifies the ordering of results. Supported values are:
relevance(default)last_modified_timestamplast_modified_timestamp asc
 string order_by = 5 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description | 
ByteString | 
        The bytes for orderBy.  | 
      
getPageSize()
public int 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.
 int32 page_size = 3 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description | 
int | 
        The pageSize.  | 
      
getPageToken()
public String getPageToken() Optional. Page token received from a previous SearchEntries call. Provide
 this to retrieve the subsequent page.
 string page_token = 4 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description | 
String | 
        The pageToken.  | 
      
getPageTokenBytes()
public ByteString getPageTokenBytes() Optional. Page token received from a previous SearchEntries call. Provide
 this to retrieve the subsequent page.
 string page_token = 4 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description | 
ByteString | 
        The bytes for pageToken.  | 
      
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.
 string query = 2 [(.google.api.field_behavior) = REQUIRED];
| Returns | |
|---|---|
| Type | Description | 
String | 
        The query.  | 
      
getQueryBytes()
public ByteString getQueryBytes()Required. The query against which entries in scope should be matched. The query syntax is defined in Search syntax for Dataplex Catalog.
 string query = 2 [(.google.api.field_behavior) = REQUIRED];
| Returns | |
|---|---|
| Type | Description | 
ByteString | 
        The bytes for query.  | 
      
getScope()
public String getScope() 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.
 string scope = 7 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description | 
String | 
        The scope.  | 
      
getScopeBytes()
public ByteString getScopeBytes() 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.
 string scope = 7 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description | 
ByteString | 
        The bytes for scope.  | 
      
getSemanticSearch()
public boolean getSemanticSearch()Optional. Specifies whether the search should understand the meaning and intent behind the query, rather than just matching keywords.
 bool semantic_search = 11 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description | 
boolean | 
        The semanticSearch.  | 
      
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()| Returns | |
|---|---|
| Type | Description | 
FieldAccessorTable | 
        |
isInitialized()
public final boolean isInitialized()| Returns | |
|---|---|
| Type | Description | 
boolean | 
        |
mergeFrom(SearchEntriesRequest other)
public SearchEntriesRequest.Builder mergeFrom(SearchEntriesRequest other)| Parameter | |
|---|---|
| Name | Description | 
other | 
        SearchEntriesRequest | 
      
| Returns | |
|---|---|
| Type | Description | 
SearchEntriesRequest.Builder | 
        |
mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public SearchEntriesRequest.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)| Parameters | |
|---|---|
| Name | Description | 
input | 
        CodedInputStream | 
      
extensionRegistry | 
        ExtensionRegistryLite | 
      
| Returns | |
|---|---|
| Type | Description | 
SearchEntriesRequest.Builder | 
        |
| Exceptions | |
|---|---|
| Type | Description | 
IOException | 
        |
mergeFrom(Message other)
public SearchEntriesRequest.Builder mergeFrom(Message other)| Parameter | |
|---|---|
| Name | Description | 
other | 
        Message | 
      
| Returns | |
|---|---|
| Type | Description | 
SearchEntriesRequest.Builder | 
        |
mergeUnknownFields(UnknownFieldSet unknownFields)
public final SearchEntriesRequest.Builder mergeUnknownFields(UnknownFieldSet unknownFields)| Parameter | |
|---|---|
| Name | Description | 
unknownFields | 
        UnknownFieldSet | 
      
| Returns | |
|---|---|
| Type | Description | 
SearchEntriesRequest.Builder | 
        |
setField(Descriptors.FieldDescriptor field, Object value)
public SearchEntriesRequest.Builder setField(Descriptors.FieldDescriptor field, Object value)| Parameters | |
|---|---|
| Name | Description | 
field | 
        FieldDescriptor | 
      
value | 
        Object | 
      
| Returns | |
|---|---|
| Type | Description | 
SearchEntriesRequest.Builder | 
        |
setName(String value)
public SearchEntriesRequest.Builder setName(String value) Required. The project to which the request should be attributed in the
 following form: projects/{project}/locations/{location}.
 
 string name = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
 
| Parameter | |
|---|---|
| Name | Description | 
value | 
        StringThe name to set.  | 
      
| Returns | |
|---|---|
| Type | Description | 
SearchEntriesRequest.Builder | 
        This builder for chaining.  | 
      
setNameBytes(ByteString value)
public SearchEntriesRequest.Builder setNameBytes(ByteString value) Required. The project to which the request should be attributed in the
 following form: projects/{project}/locations/{location}.
 
 string name = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
 
| Parameter | |
|---|---|
| Name | Description | 
value | 
        ByteStringThe bytes for name to set.  | 
      
| Returns | |
|---|---|
| Type | Description | 
SearchEntriesRequest.Builder | 
        This builder for chaining.  | 
      
setOrderBy(String value)
public SearchEntriesRequest.Builder setOrderBy(String value)Optional. Specifies the ordering of results. Supported values are:
relevance(default)last_modified_timestamplast_modified_timestamp asc
 string order_by = 5 [(.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description | 
value | 
        StringThe orderBy to set.  | 
      
| Returns | |
|---|---|
| Type | Description | 
SearchEntriesRequest.Builder | 
        This builder for chaining.  | 
      
setOrderByBytes(ByteString value)
public SearchEntriesRequest.Builder setOrderByBytes(ByteString value)Optional. Specifies the ordering of results. Supported values are:
relevance(default)last_modified_timestamplast_modified_timestamp asc
 string order_by = 5 [(.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description | 
value | 
        ByteStringThe bytes for orderBy to set.  | 
      
| Returns | |
|---|---|
| Type | Description | 
SearchEntriesRequest.Builder | 
        This builder for chaining.  | 
      
setPageSize(int value)
public SearchEntriesRequest.Builder setPageSize(int value)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.
 int32 page_size = 3 [(.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description | 
value | 
        intThe pageSize to set.  | 
      
| Returns | |
|---|---|
| Type | Description | 
SearchEntriesRequest.Builder | 
        This builder for chaining.  | 
      
setPageToken(String value)
public SearchEntriesRequest.Builder setPageToken(String value) Optional. Page token received from a previous SearchEntries call. Provide
 this to retrieve the subsequent page.
 string page_token = 4 [(.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description | 
value | 
        StringThe pageToken to set.  | 
      
| Returns | |
|---|---|
| Type | Description | 
SearchEntriesRequest.Builder | 
        This builder for chaining.  | 
      
setPageTokenBytes(ByteString value)
public SearchEntriesRequest.Builder setPageTokenBytes(ByteString value) Optional. Page token received from a previous SearchEntries call. Provide
 this to retrieve the subsequent page.
 string page_token = 4 [(.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description | 
value | 
        ByteStringThe bytes for pageToken to set.  | 
      
| Returns | |
|---|---|
| Type | Description | 
SearchEntriesRequest.Builder | 
        This builder for chaining.  | 
      
setQuery(String value)
public SearchEntriesRequest.Builder setQuery(String value)Required. The query against which entries in scope should be matched. The query syntax is defined in Search syntax for Dataplex Catalog.
 string query = 2 [(.google.api.field_behavior) = REQUIRED];
| Parameter | |
|---|---|
| Name | Description | 
value | 
        StringThe query to set.  | 
      
| Returns | |
|---|---|
| Type | Description | 
SearchEntriesRequest.Builder | 
        This builder for chaining.  | 
      
setQueryBytes(ByteString value)
public SearchEntriesRequest.Builder setQueryBytes(ByteString value)Required. The query against which entries in scope should be matched. The query syntax is defined in Search syntax for Dataplex Catalog.
 string query = 2 [(.google.api.field_behavior) = REQUIRED];
| Parameter | |
|---|---|
| Name | Description | 
value | 
        ByteStringThe bytes for query to set.  | 
      
| Returns | |
|---|---|
| Type | Description | 
SearchEntriesRequest.Builder | 
        This builder for chaining.  | 
      
setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
public SearchEntriesRequest.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)| Parameters | |
|---|---|
| Name | Description | 
field | 
        FieldDescriptor | 
      
index | 
        int | 
      
value | 
        Object | 
      
| Returns | |
|---|---|
| Type | Description | 
SearchEntriesRequest.Builder | 
        |
setScope(String value)
public SearchEntriesRequest.Builder setScope(String value) 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.
 string scope = 7 [(.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description | 
value | 
        StringThe scope to set.  | 
      
| Returns | |
|---|---|
| Type | Description | 
SearchEntriesRequest.Builder | 
        This builder for chaining.  | 
      
setScopeBytes(ByteString value)
public SearchEntriesRequest.Builder setScopeBytes(ByteString value) 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.
 string scope = 7 [(.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description | 
value | 
        ByteStringThe bytes for scope to set.  | 
      
| Returns | |
|---|---|
| Type | Description | 
SearchEntriesRequest.Builder | 
        This builder for chaining.  | 
      
setSemanticSearch(boolean value)
public SearchEntriesRequest.Builder setSemanticSearch(boolean value)Optional. Specifies whether the search should understand the meaning and intent behind the query, rather than just matching keywords.
 bool semantic_search = 11 [(.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description | 
value | 
        booleanThe semanticSearch to set.  | 
      
| Returns | |
|---|---|
| Type | Description | 
SearchEntriesRequest.Builder | 
        This builder for chaining.  | 
      
setUnknownFields(UnknownFieldSet unknownFields)
public final SearchEntriesRequest.Builder setUnknownFields(UnknownFieldSet unknownFields)| Parameter | |
|---|---|
| Name | Description | 
unknownFields | 
        UnknownFieldSet | 
      
| Returns | |
|---|---|
| Type | Description | 
SearchEntriesRequest.Builder | 
        |