Class SearchCatalogRequest.Scope 

public static final class SearchCatalogRequest.Scope extends GeneratedMessageV3 implements SearchCatalogRequest.ScopeOrBuilder
 
The criteria that select the subspace used for query matching.

Protobuf type google.cloud.datacatalog.v1beta1.SearchCatalogRequest.Scope

Inheritance

Object > AbstractMessageLite<MessageType,BuilderType> > AbstractMessage > GeneratedMessageV3 > SearchCatalogRequest.Scope

Fields

INCLUDE_GCP_PUBLIC_DATASETS_FIELD_NUMBER

public static final int INCLUDE_GCP_PUBLIC_DATASETS_FIELD_NUMBER
Field Value
Type Description
int

INCLUDE_ORG_IDS_FIELD_NUMBER

public static final int INCLUDE_ORG_IDS_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

Methods

equals(Object obj)

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

getDefaultInstance()

public static SearchCatalogRequest.Scope getDefaultInstance()
Returns
Type Description
SearchCatalogRequest.Scope

getDefaultInstanceForType()

public SearchCatalogRequest.Scope getDefaultInstanceForType()
Returns
Type Description
SearchCatalogRequest.Scope

getDescriptor()

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

getIncludeGcpPublicDatasets()

public boolean getIncludeGcpPublicDatasets()
 
If `true`, include Google Cloud Platform (GCP) public datasets in the
 search results. Info on GCP public datasets is available at
 https://cloud.google.com/public-datasets/. By default, GCP public
 datasets are excluded.

bool include_gcp_public_datasets = 7;

Returns
Type Description
boolean

The includeGcpPublicDatasets.

getIncludeOrgIds(int index)

public String getIncludeOrgIds(int index)
 
The list of organization IDs to search within. To find your organization
 ID, follow instructions in
 https://cloud.google.com/resource-manager/docs/creating-managing-organization.

repeated string include_org_ids = 2;

Parameter
Name Description
index int

The index of the element to return.
Returns
Type Description
String

The includeOrgIds at the given index.

getIncludeOrgIdsBytes(int index)

public ByteString getIncludeOrgIdsBytes(int index)
 
The list of organization IDs to search within. To find your organization
 ID, follow instructions in
 https://cloud.google.com/resource-manager/docs/creating-managing-organization.

repeated string include_org_ids = 2;

Parameter
Name Description
index int

The index of the value to return.
Returns
Type Description
ByteString

The bytes of the includeOrgIds at the given index.

getIncludeOrgIdsCount()

public int getIncludeOrgIdsCount()
 
The list of organization IDs to search within. To find your organization
 ID, follow instructions in
 https://cloud.google.com/resource-manager/docs/creating-managing-organization.

repeated string include_org_ids = 2;

Returns
Type Description
int

The count of includeOrgIds.

getIncludeOrgIdsList()

public ProtocolStringList getIncludeOrgIdsList()
 
The list of organization IDs to search within. To find your organization
 ID, follow instructions in
 https://cloud.google.com/resource-manager/docs/creating-managing-organization.

repeated string include_org_ids = 2;

Returns
Type Description
ProtocolStringList

A list containing the includeOrgIds.

getIncludeProjectIds(int index)

public String getIncludeProjectIds(int index)
 
The list of project IDs to search within. To learn more about the
 distinction between project names/IDs/numbers, go to
 https://cloud.google.com/docs/overview/#projects.

repeated string include_project_ids = 3;

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)
 
The list of project IDs to search within. To learn more about the
 distinction between project names/IDs/numbers, go to
 https://cloud.google.com/docs/overview/#projects.

repeated string include_project_ids = 3;

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()
 
The list of project IDs to search within. To learn more about the
 distinction between project names/IDs/numbers, go to
 https://cloud.google.com/docs/overview/#projects.

repeated string include_project_ids = 3;

Returns
Type Description
int

The count of includeProjectIds.

getIncludeProjectIdsList()

public ProtocolStringList getIncludeProjectIdsList()
 
The list of project IDs to search within. To learn more about the
 distinction between project names/IDs/numbers, go to
 https://cloud.google.com/docs/overview/#projects.

repeated string include_project_ids = 3;

Returns
Type Description
ProtocolStringList

A list containing the includeProjectIds.

getParserForType()

public Parser<SearchCatalogRequest.Scope> getParserForType()
Returns
Type Description
Parser<Scope>
Overrides

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

getUnknownFields()

public final UnknownFieldSet getUnknownFields()
Returns
Type Description
UnknownFieldSet
Overrides

hashCode()

public int hashCode()
Returns
Type Description
int
Overrides

internalGetFieldAccessorTable()

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

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

newBuilder()

public static SearchCatalogRequest.Scope.Builder newBuilder()
Returns
Type Description
SearchCatalogRequest.Scope.Builder

newBuilder(SearchCatalogRequest.Scope prototype)

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

newBuilderForType()

public SearchCatalogRequest.Scope.Builder newBuilderForType()
Returns
Type Description
SearchCatalogRequest.Scope.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected SearchCatalogRequest.Scope.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
SearchCatalogRequest.Scope.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Name Description
unused UnusedPrivateParameter
Returns
Type Description
Object
Overrides

parseDelimitedFrom(InputStream input)

public static SearchCatalogRequest.Scope parseDelimitedFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
SearchCatalogRequest.Scope
Exceptions
Type Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(byte[] data)

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

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteString data)

public static SearchCatalogRequest.Scope parseFrom(ByteString data)
Parameter
Name Description
data ByteString
Returns
Type Description
SearchCatalogRequest.Scope
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(CodedInputStream input)

public static SearchCatalogRequest.Scope parseFrom(CodedInputStream input)
Parameter
Name Description
input CodedInputStream
Returns
Type Description
SearchCatalogRequest.Scope
Exceptions
Type Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(InputStream input)

public static SearchCatalogRequest.Scope parseFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
SearchCatalogRequest.Scope
Exceptions
Type Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteBuffer data)

public static SearchCatalogRequest.Scope parseFrom(ByteBuffer data)
Parameter
Name Description
data ByteBuffer
Returns
Type Description
SearchCatalogRequest.Scope
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

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

parser()

public static Parser<SearchCatalogRequest.Scope> parser()
Returns
Type Description
Parser<Scope>

toBuilder()

public SearchCatalogRequest.Scope.Builder toBuilder()
Returns
Type Description
SearchCatalogRequest.Scope.Builder

writeTo(CodedOutputStream output)

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