Class SearchScope (0.31.0)

public final class SearchScope extends GeneratedMessage implements SearchScopeOrBuilder

Message 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

Static Fields

INCLUDE_DATASET_REFERENCES_FIELD_NUMBER

public static final int INCLUDE_DATASET_REFERENCES_FIELD_NUMBER
Field Value
Type Description
int

INCLUDE_PROJECT_IDS_FIELD_NUMBER

public static final int INCLUDE_PROJECT_IDS_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static SearchScope getDefaultInstance()
Returns
Type Description
SearchScope

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
Type Description
Descriptor

newBuilder()

public static SearchScope.Builder newBuilder()
Returns
Type Description
SearchScope.Builder

newBuilder(SearchScope prototype)

public static SearchScope.Builder newBuilder(SearchScope prototype)
Parameter
Name Description
prototype SearchScope
Returns
Type Description
SearchScope.Builder

parseDelimitedFrom(InputStream input)

public static SearchScope parseDelimitedFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
SearchScope
Exceptions
Type Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static SearchScope parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
SearchScope
Exceptions
Type Description
IOException

parseFrom(byte[] data)

public static SearchScope parseFrom(byte[] data)
Parameter
Name Description
data byte[]
Returns
Type Description
SearchScope
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static SearchScope parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data byte[]
extensionRegistry ExtensionRegistryLite
Returns
Type Description
SearchScope
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static SearchScope parseFrom(ByteString data)
Parameter
Name Description
data ByteString
Returns
Type Description
SearchScope
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static SearchScope parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteString
extensionRegistry ExtensionRegistryLite
Returns
Type Description
SearchScope
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static SearchScope parseFrom(CodedInputStream input)
Parameter
Name Description
input CodedInputStream
Returns
Type Description
SearchScope
Exceptions
Type Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static SearchScope parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
SearchScope
Exceptions
Type Description
IOException

parseFrom(InputStream input)

public static SearchScope parseFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
SearchScope
Exceptions
Type Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static SearchScope parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
SearchScope
Exceptions
Type Description
IOException

parseFrom(ByteBuffer data)

public static SearchScope parseFrom(ByteBuffer data)
Parameter
Name Description
data ByteBuffer
Returns
Type Description
SearchScope
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static SearchScope parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteBuffer
extensionRegistry ExtensionRegistryLite
Returns
Type Description
SearchScope
Exceptions
Type Description
InvalidProtocolBufferException

parser()

public static Parser<SearchScope> parser()
Returns
Type Description
Parser<SearchScope>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
Name Description
obj Object
Returns
Type Description
boolean
Overrides

getDefaultInstanceForType()

public SearchScope getDefaultInstanceForType()
Returns
Type Description
SearchScope

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

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 int

The 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 int

The 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.

getParserForType()

public Parser<SearchScope> getParserForType()
Returns
Type Description
Parser<SearchScope>
Overrides

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

hashCode()

public int hashCode()
Returns
Type Description
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

newBuilderForType()

public SearchScope.Builder newBuilderForType()
Returns
Type Description
SearchScope.Builder

newBuilderForType(AbstractMessage.BuilderParent parent)

protected SearchScope.Builder newBuilderForType(AbstractMessage.BuilderParent parent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
SearchScope.Builder
Overrides

toBuilder()

public SearchScope.Builder toBuilder()
Returns
Type Description
SearchScope.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
Name Description
output CodedOutputStream
Overrides
Exceptions
Type Description
IOException