Send feedback
Class SearchCatalogRequest.Scope (1.35.0)
Stay organized with collections
Save and categorize content based on your preferences.
Version 1.35.0 keyboard_arrow_down
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
Inherited Members
com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT)
com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT,int)
com.google.protobuf.GeneratedMessageV3.<T>emptyList(java.lang.Class<T>)
Static 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
RESTRICTED_LOCATIONS_FIELD_NUMBER
public static final int RESTRICTED_LOCATIONS_FIELD_NUMBER
Field Value Type Description int
Static Methods
getDefaultInstance()
public static SearchCatalogRequest . Scope getDefaultInstance ()
getDescriptor()
public static final Descriptors . Descriptor getDescriptor ()
newBuilder()
public static SearchCatalogRequest . Scope . Builder newBuilder ()
newBuilder(SearchCatalogRequest.Scope prototype)
public static SearchCatalogRequest . Scope . Builder newBuilder ( SearchCatalogRequest . Scope prototype )
public static SearchCatalogRequest . Scope parseDelimitedFrom ( InputStream input )
public static SearchCatalogRequest . Scope parseDelimitedFrom ( InputStream input , ExtensionRegistryLite extensionRegistry )
parseFrom(byte[] data)
public static SearchCatalogRequest . Scope parseFrom ( byte [] data )
Parameter Name Description databyte []
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static SearchCatalogRequest . Scope parseFrom ( byte [] data , ExtensionRegistryLite extensionRegistry )
parseFrom(ByteString data)
public static SearchCatalogRequest . Scope parseFrom ( ByteString data )
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static SearchCatalogRequest . Scope parseFrom ( ByteString data , ExtensionRegistryLite extensionRegistry )
public static SearchCatalogRequest . Scope parseFrom ( CodedInputStream input )
public static SearchCatalogRequest . Scope parseFrom ( CodedInputStream input , ExtensionRegistryLite extensionRegistry )
public static SearchCatalogRequest . Scope parseFrom ( InputStream input )
public static SearchCatalogRequest . Scope parseFrom ( InputStream input , ExtensionRegistryLite extensionRegistry )
parseFrom(ByteBuffer data)
public static SearchCatalogRequest . Scope parseFrom ( ByteBuffer data )
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static SearchCatalogRequest . Scope parseFrom ( ByteBuffer data , ExtensionRegistryLite extensionRegistry )
parser()
public static Parser<SearchCatalogRequest . Scope > parser ()
Methods
equals(Object obj)
public boolean equals ( Object obj )
Parameter Name Description objObject
Overrides
getDefaultInstanceForType()
public SearchCatalogRequest . Scope getDefaultInstanceForType ()
getIncludeGcpPublicDatasets()
public boolean getIncludeGcpPublicDatasets ()
If true, include Google Cloud public datasets in the
search results. Info on Google Cloud public datasets is available at
https://cloud.google.com/public-datasets/ . By default, Google Cloud
public datasets are excluded.
bool include_gcp_public_datasets = 7;
Returns Type Description boolean The includeGcpPublicDatasets.
getIncludeOrgIds(int index)
public String getIncludeOrgIds ( int index )
Parameter Name Description indexint 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 )
Parameter Name Description indexint The index of the value to return.
Returns Type Description ByteString The bytes of the includeOrgIds at the given index.
getIncludeOrgIdsCount()
public int getIncludeOrgIdsCount ()
Returns Type Description int The count of includeOrgIds.
getIncludeOrgIdsList()
public ProtocolStringList getIncludeOrgIdsList ()
getIncludeProjectIds(int index)
public String getIncludeProjectIds ( int index )
Parameter Name Description indexint 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 )
Parameter Name Description indexint The index of the value to return.
Returns Type Description ByteString The bytes of the includeProjectIds at the given index.
getIncludeProjectIdsCount()
public int getIncludeProjectIdsCount ()
Returns Type Description int The count of includeProjectIds.
getIncludeProjectIdsList()
public ProtocolStringList getIncludeProjectIdsList ()
getParserForType()
public Parser<SearchCatalogRequest . Scope > getParserForType ()
Overrides
getRestrictedLocations(int index)
public String getRestrictedLocations ( int index )
Optional. The list of locations to search within.
If empty, search will be performed in all locations;
If any of the locations are NOT in the valid locations list, error
will be returned;
Otherwise, search only the given locations for matching results.
Typical usage is to leave this field empty. When a location is
unreachable as returned in the SearchCatalogResponse.unreachable field,
users can repeat the search request with this parameter set to get
additional information on the error.
Valid locations:
asia-east1
asia-east2
asia-northeast1
asia-northeast2
asia-northeast3
asia-south1
asia-southeast1
australia-southeast1
eu
europe-north1
europe-west1
europe-west2
europe-west3
europe-west4
europe-west6
global
northamerica-northeast1
southamerica-east1
us
us-central1
us-east1
us-east4
us-west1
us-west2
repeated string restricted_locations = 16 [(.google.api.field_behavior) = OPTIONAL];
Parameter Name Description indexint The index of the element to return.
Returns Type Description String The restrictedLocations at the given index.
getRestrictedLocationsBytes(int index)
public ByteString getRestrictedLocationsBytes ( int index )
Optional. The list of locations to search within.
If empty, search will be performed in all locations;
If any of the locations are NOT in the valid locations list, error
will be returned;
Otherwise, search only the given locations for matching results.
Typical usage is to leave this field empty. When a location is
unreachable as returned in the SearchCatalogResponse.unreachable field,
users can repeat the search request with this parameter set to get
additional information on the error.
Valid locations:
asia-east1
asia-east2
asia-northeast1
asia-northeast2
asia-northeast3
asia-south1
asia-southeast1
australia-southeast1
eu
europe-north1
europe-west1
europe-west2
europe-west3
europe-west4
europe-west6
global
northamerica-northeast1
southamerica-east1
us
us-central1
us-east1
us-east4
us-west1
us-west2
repeated string restricted_locations = 16 [(.google.api.field_behavior) = OPTIONAL];
Parameter Name Description indexint The index of the value to return.
Returns Type Description ByteString The bytes of the restrictedLocations at the given index.
getRestrictedLocationsCount()
public int getRestrictedLocationsCount ()
Optional. The list of locations to search within.
If empty, search will be performed in all locations;
If any of the locations are NOT in the valid locations list, error
will be returned;
Otherwise, search only the given locations for matching results.
Typical usage is to leave this field empty. When a location is
unreachable as returned in the SearchCatalogResponse.unreachable field,
users can repeat the search request with this parameter set to get
additional information on the error.
Valid locations:
asia-east1
asia-east2
asia-northeast1
asia-northeast2
asia-northeast3
asia-south1
asia-southeast1
australia-southeast1
eu
europe-north1
europe-west1
europe-west2
europe-west3
europe-west4
europe-west6
global
northamerica-northeast1
southamerica-east1
us
us-central1
us-east1
us-east4
us-west1
us-west2
repeated string restricted_locations = 16 [(.google.api.field_behavior) = OPTIONAL];
Returns Type Description int The count of restrictedLocations.
getRestrictedLocationsList()
public ProtocolStringList getRestrictedLocationsList ()
Optional. The list of locations to search within.
If empty, search will be performed in all locations;
If any of the locations are NOT in the valid locations list, error
will be returned;
Otherwise, search only the given locations for matching results.
Typical usage is to leave this field empty. When a location is
unreachable as returned in the SearchCatalogResponse.unreachable field,
users can repeat the search request with this parameter set to get
additional information on the error.
Valid locations:
asia-east1
asia-east2
asia-northeast1
asia-northeast2
asia-northeast3
asia-south1
asia-southeast1
australia-southeast1
eu
europe-north1
europe-west1
europe-west2
europe-west3
europe-west4
europe-west6
global
northamerica-northeast1
southamerica-east1
us
us-central1
us-east1
us-east4
us-west1
us-west2
repeated string restricted_locations = 16 [(.google.api.field_behavior) = OPTIONAL];
getSerializedSize()
public int getSerializedSize ()
Returns Type Description int
Overrides
hashCode()
Returns Type Description int
Overrides
internalGetFieldAccessorTable()
protected GeneratedMessageV3 . FieldAccessorTable internalGetFieldAccessorTable ()
Overrides
isInitialized()
public final boolean isInitialized ()
Overrides
newBuilderForType()
public SearchCatalogRequest . Scope . Builder newBuilderForType ()
newBuilderForType(GeneratedMessageV3.BuilderParent parent)
protected SearchCatalogRequest . Scope . Builder newBuilderForType ( GeneratedMessageV3 . BuilderParent parent )
Overrides
newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
protected Object newInstance ( GeneratedMessageV3 . UnusedPrivateParameter unused )
Overrides
toBuilder()
public SearchCatalogRequest . Scope . Builder toBuilder ()
writeTo(CodedOutputStream output)
public void writeTo ( CodedOutputStream output )
Overrides
Send feedback
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License , and code samples are licensed under the Apache 2.0 License . For details, see the Google Developers Site Policies . Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2025-02-14 UTC.
Need to tell us more?
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Hard to understand","hardToUnderstand","thumb-down"],["Incorrect information or sample code","incorrectInformationOrSampleCode","thumb-down"],["Missing the information/samples I need","missingTheInformationSamplesINeed","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-02-14 UTC."],[],[]]
