public static final class SearchScope.Builder extends GeneratedMessage.Builder<SearchScope.Builder> implements SearchScopeOrBuilderMessage representing filters to apply to search over BigQuery tables.
At least one of include_project_ids or include_dataset_references must be
populated with non-blank identifiers. Tables matching either field are
included, so the two fields are unioned (OR-ed) rather than intersected.
Note: SearchScope is only supported for standalone conversations
(ChatRequest.inline_context or
ClientManagedResourceContext.inline_context) and is not supported in
DataAgent.
Protobuf type google.cloud.geminidataanalytics.v1beta.SearchScope
Inheritance
java.lang.Object > AbstractMessageLite.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessage.Builder > SearchScope.BuilderImplements
SearchScopeOrBuilderStatic Methods
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()| Returns | |
|---|---|
| Type | Description |
Descriptor |
|
Methods
addAllIncludeDatasetReferences(Iterable<? extends BigQueryDatasetReference> values)
public SearchScope.Builder addAllIncludeDatasetReferences(Iterable<? extends BigQueryDatasetReference> values)Optional. The BigQuery dataset references to search over.
repeated .google.cloud.geminidataanalytics.v1beta.BigQueryDatasetReference include_dataset_references = 2 [(.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description |
values |
Iterable<? extends com.google.cloud.geminidataanalytics.v1beta.BigQueryDatasetReference> |
| Returns | |
|---|---|
| Type | Description |
SearchScope.Builder |
|
addAllIncludeProjectIds(Iterable<String> values)
public SearchScope.Builder addAllIncludeProjectIds(Iterable<String> values)Optional. The BigQuery project ids to search over.
repeated string include_project_ids = 1 [(.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description |
values |
Iterable<String>The includeProjectIds to add. |
| Returns | |
|---|---|
| Type | Description |
SearchScope.Builder |
This builder for chaining. |
addIncludeDatasetReferences(BigQueryDatasetReference value)
public SearchScope.Builder addIncludeDatasetReferences(BigQueryDatasetReference value)Optional. The BigQuery dataset references to search over.
repeated .google.cloud.geminidataanalytics.v1beta.BigQueryDatasetReference include_dataset_references = 2 [(.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description |
value |
BigQueryDatasetReference |
| Returns | |
|---|---|
| Type | Description |
SearchScope.Builder |
|
addIncludeDatasetReferences(BigQueryDatasetReference.Builder builderForValue)
public SearchScope.Builder addIncludeDatasetReferences(BigQueryDatasetReference.Builder builderForValue)Optional. The BigQuery dataset references to search over.
repeated .google.cloud.geminidataanalytics.v1beta.BigQueryDatasetReference include_dataset_references = 2 [(.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description |
builderForValue |
BigQueryDatasetReference.Builder |
| Returns | |
|---|---|
| Type | Description |
SearchScope.Builder |
|
addIncludeDatasetReferences(int index, BigQueryDatasetReference value)
public SearchScope.Builder addIncludeDatasetReferences(int index, BigQueryDatasetReference value)Optional. The BigQuery dataset references to search over.
repeated .google.cloud.geminidataanalytics.v1beta.BigQueryDatasetReference include_dataset_references = 2 [(.google.api.field_behavior) = OPTIONAL];
| Parameters | |
|---|---|
| Name | Description |
index |
int |
value |
BigQueryDatasetReference |
| Returns | |
|---|---|
| Type | Description |
SearchScope.Builder |
|
addIncludeDatasetReferences(int index, BigQueryDatasetReference.Builder builderForValue)
public SearchScope.Builder addIncludeDatasetReferences(int index, BigQueryDatasetReference.Builder builderForValue)Optional. The BigQuery dataset references to search over.
repeated .google.cloud.geminidataanalytics.v1beta.BigQueryDatasetReference include_dataset_references = 2 [(.google.api.field_behavior) = OPTIONAL];
| Parameters | |
|---|---|
| Name | Description |
index |
int |
builderForValue |
BigQueryDatasetReference.Builder |
| Returns | |
|---|---|
| Type | Description |
SearchScope.Builder |
|
addIncludeDatasetReferencesBuilder()
public BigQueryDatasetReference.Builder addIncludeDatasetReferencesBuilder()Optional. The BigQuery dataset references to search over.
repeated .google.cloud.geminidataanalytics.v1beta.BigQueryDatasetReference include_dataset_references = 2 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
BigQueryDatasetReference.Builder |
|
addIncludeDatasetReferencesBuilder(int index)
public BigQueryDatasetReference.Builder addIncludeDatasetReferencesBuilder(int index)Optional. The BigQuery dataset references to search over.
repeated .google.cloud.geminidataanalytics.v1beta.BigQueryDatasetReference include_dataset_references = 2 [(.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description |
index |
int |
| Returns | |
|---|---|
| Type | Description |
BigQueryDatasetReference.Builder |
|
addIncludeProjectIds(String value)
public SearchScope.Builder addIncludeProjectIds(String value)Optional. The BigQuery project ids to search over.
repeated string include_project_ids = 1 [(.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description |
value |
StringThe includeProjectIds to add. |
| Returns | |
|---|---|
| Type | Description |
SearchScope.Builder |
This builder for chaining. |
addIncludeProjectIdsBytes(ByteString value)
public SearchScope.Builder addIncludeProjectIdsBytes(ByteString value)Optional. The BigQuery project ids to search over.
repeated string include_project_ids = 1 [(.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description |
value |
ByteStringThe bytes of the includeProjectIds to add. |
| Returns | |
|---|---|
| Type | Description |
SearchScope.Builder |
This builder for chaining. |
build()
public SearchScope build()| Returns | |
|---|---|
| Type | Description |
SearchScope |
|
buildPartial()
public SearchScope buildPartial()| Returns | |
|---|---|
| Type | Description |
SearchScope |
|
clear()
public SearchScope.Builder clear()| Returns | |
|---|---|
| Type | Description |
SearchScope.Builder |
|
clearIncludeDatasetReferences()
public SearchScope.Builder clearIncludeDatasetReferences()Optional. The BigQuery dataset references to search over.
repeated .google.cloud.geminidataanalytics.v1beta.BigQueryDatasetReference include_dataset_references = 2 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
SearchScope.Builder |
|
clearIncludeProjectIds()
public SearchScope.Builder clearIncludeProjectIds()Optional. The BigQuery project ids to search over.
repeated string include_project_ids = 1 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
SearchScope.Builder |
This builder for chaining. |
getDefaultInstanceForType()
public SearchScope getDefaultInstanceForType()| Returns | |
|---|---|
| Type | Description |
SearchScope |
|
getDescriptorForType()
public Descriptors.Descriptor getDescriptorForType()| Returns | |
|---|---|
| Type | Description |
Descriptor |
|
getIncludeDatasetReferences(int index)
public BigQueryDatasetReference getIncludeDatasetReferences(int index)Optional. The BigQuery dataset references to search over.
repeated .google.cloud.geminidataanalytics.v1beta.BigQueryDatasetReference include_dataset_references = 2 [(.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description |
index |
int |
| Returns | |
|---|---|
| Type | Description |
BigQueryDatasetReference |
|
getIncludeDatasetReferencesBuilder(int index)
public BigQueryDatasetReference.Builder getIncludeDatasetReferencesBuilder(int index)Optional. The BigQuery dataset references to search over.
repeated .google.cloud.geminidataanalytics.v1beta.BigQueryDatasetReference include_dataset_references = 2 [(.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description |
index |
int |
| Returns | |
|---|---|
| Type | Description |
BigQueryDatasetReference.Builder |
|
getIncludeDatasetReferencesBuilderList()
public List<BigQueryDatasetReference.Builder> getIncludeDatasetReferencesBuilderList()Optional. The BigQuery dataset references to search over.
repeated .google.cloud.geminidataanalytics.v1beta.BigQueryDatasetReference include_dataset_references = 2 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
List<Builder> |
|
getIncludeDatasetReferencesCount()
public int getIncludeDatasetReferencesCount()Optional. The BigQuery dataset references to search over.
repeated .google.cloud.geminidataanalytics.v1beta.BigQueryDatasetReference include_dataset_references = 2 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
int |
|
getIncludeDatasetReferencesList()
public List<BigQueryDatasetReference> getIncludeDatasetReferencesList()Optional. The BigQuery dataset references to search over.
repeated .google.cloud.geminidataanalytics.v1beta.BigQueryDatasetReference include_dataset_references = 2 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
List<BigQueryDatasetReference> |
|
getIncludeDatasetReferencesOrBuilder(int index)
public BigQueryDatasetReferenceOrBuilder getIncludeDatasetReferencesOrBuilder(int index)Optional. The BigQuery dataset references to search over.
repeated .google.cloud.geminidataanalytics.v1beta.BigQueryDatasetReference include_dataset_references = 2 [(.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description |
index |
int |
| Returns | |
|---|---|
| Type | Description |
BigQueryDatasetReferenceOrBuilder |
|
getIncludeDatasetReferencesOrBuilderList()
public List<? extends BigQueryDatasetReferenceOrBuilder> getIncludeDatasetReferencesOrBuilderList()Optional. The BigQuery dataset references to search over.
repeated .google.cloud.geminidataanalytics.v1beta.BigQueryDatasetReference include_dataset_references = 2 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
List<? extends com.google.cloud.geminidataanalytics.v1beta.BigQueryDatasetReferenceOrBuilder> |
|
getIncludeProjectIds(int index)
public String getIncludeProjectIds(int index)Optional. The BigQuery project ids to search over.
repeated string include_project_ids = 1 [(.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description |
index |
intThe index of the element to return. |
| Returns | |
|---|---|
| Type | Description |
String |
The includeProjectIds at the given index. |
getIncludeProjectIdsBytes(int index)
public ByteString getIncludeProjectIdsBytes(int index)Optional. The BigQuery project ids to search over.
repeated string include_project_ids = 1 [(.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description |
index |
intThe index of the value to return. |
| Returns | |
|---|---|
| Type | Description |
ByteString |
The bytes of the includeProjectIds at the given index. |
getIncludeProjectIdsCount()
public int getIncludeProjectIdsCount()Optional. The BigQuery project ids to search over.
repeated string include_project_ids = 1 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
int |
The count of includeProjectIds. |
getIncludeProjectIdsList()
public ProtocolStringList getIncludeProjectIdsList()Optional. The BigQuery project ids to search over.
repeated string include_project_ids = 1 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
ProtocolStringList |
A list containing the includeProjectIds. |
internalGetFieldAccessorTable()
protected GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()| Returns | |
|---|---|
| Type | Description |
FieldAccessorTable |
|
isInitialized()
public final boolean isInitialized()| Returns | |
|---|---|
| Type | Description |
boolean |
|
mergeFrom(SearchScope other)
public SearchScope.Builder mergeFrom(SearchScope other)| Parameter | |
|---|---|
| Name | Description |
other |
SearchScope |
| Returns | |
|---|---|
| Type | Description |
SearchScope.Builder |
|
mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public SearchScope.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)| Parameters | |
|---|---|
| Name | Description |
input |
CodedInputStream |
extensionRegistry |
ExtensionRegistryLite |
| Returns | |
|---|---|
| Type | Description |
SearchScope.Builder |
|
| Exceptions | |
|---|---|
| Type | Description |
IOException |
|
mergeFrom(Message other)
public SearchScope.Builder mergeFrom(Message other)| Parameter | |
|---|---|
| Name | Description |
other |
Message |
| Returns | |
|---|---|
| Type | Description |
SearchScope.Builder |
|
removeIncludeDatasetReferences(int index)
public SearchScope.Builder removeIncludeDatasetReferences(int index)Optional. The BigQuery dataset references to search over.
repeated .google.cloud.geminidataanalytics.v1beta.BigQueryDatasetReference include_dataset_references = 2 [(.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description |
index |
int |
| Returns | |
|---|---|
| Type | Description |
SearchScope.Builder |
|
setIncludeDatasetReferences(int index, BigQueryDatasetReference value)
public SearchScope.Builder setIncludeDatasetReferences(int index, BigQueryDatasetReference value)Optional. The BigQuery dataset references to search over.
repeated .google.cloud.geminidataanalytics.v1beta.BigQueryDatasetReference include_dataset_references = 2 [(.google.api.field_behavior) = OPTIONAL];
| Parameters | |
|---|---|
| Name | Description |
index |
int |
value |
BigQueryDatasetReference |
| Returns | |
|---|---|
| Type | Description |
SearchScope.Builder |
|
setIncludeDatasetReferences(int index, BigQueryDatasetReference.Builder builderForValue)
public SearchScope.Builder setIncludeDatasetReferences(int index, BigQueryDatasetReference.Builder builderForValue)Optional. The BigQuery dataset references to search over.
repeated .google.cloud.geminidataanalytics.v1beta.BigQueryDatasetReference include_dataset_references = 2 [(.google.api.field_behavior) = OPTIONAL];
| Parameters | |
|---|---|
| Name | Description |
index |
int |
builderForValue |
BigQueryDatasetReference.Builder |
| Returns | |
|---|---|
| Type | Description |
SearchScope.Builder |
|
setIncludeProjectIds(int index, String value)
public SearchScope.Builder setIncludeProjectIds(int index, String value)Optional. The BigQuery project ids to search over.
repeated string include_project_ids = 1 [(.google.api.field_behavior) = OPTIONAL];
| Parameters | |
|---|---|
| Name | Description |
index |
intThe index to set the value at. |
value |
StringThe includeProjectIds to set. |
| Returns | |
|---|---|
| Type | Description |
SearchScope.Builder |
This builder for chaining. |