Package com.google.cloud.datacatalog.v1beta1

Class SearchCatalogRequest.Scope

    • Field Detail

      • INCLUDE_ORG_IDS_FIELD_NUMBER

        public static final int INCLUDE_ORG_IDS_FIELD_NUMBER
        See Also:
        Constant Field Values

      • INCLUDE_PROJECT_IDS_FIELD_NUMBER

        public static final int INCLUDE_PROJECT_IDS_FIELD_NUMBER
        See Also:
        Constant Field Values

      • INCLUDE_GCP_PUBLIC_DATASETS_FIELD_NUMBER

        public static final int INCLUDE_GCP_PUBLIC_DATASETS_FIELD_NUMBER
        See Also:
        Constant Field Values

      • RESTRICTED_LOCATIONS_FIELD_NUMBER

        public static final int RESTRICTED_LOCATIONS_FIELD_NUMBER
        See Also:
        Constant Field Values

    • Method Detail

      • newInstance

        protected Object newInstance​(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
        Overrides:
        newInstance in class com.google.protobuf.GeneratedMessageV3

      • getDescriptor

        public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()

      • internalGetFieldAccessorTable

        protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
        Specified by:
        internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3

      • getIncludeOrgIdsList

        public com.google.protobuf.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;
        Specified by:
        getIncludeOrgIdsList in interface SearchCatalogRequest.ScopeOrBuilder
        Returns:
        A list containing the includeOrgIds.

      • 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;
        Specified by:
        getIncludeOrgIdsCount in interface SearchCatalogRequest.ScopeOrBuilder
        Returns:
        The count of includeOrgIds.

      • getIncludeOrgIds

        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;
        Specified by:
        getIncludeOrgIds in interface SearchCatalogRequest.ScopeOrBuilder
        Parameters:
        index - The index of the element to return.
        Returns:
        The includeOrgIds at the given index.

      • getIncludeOrgIdsBytes

        public com.google.protobuf.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;
        Specified by:
        getIncludeOrgIdsBytes in interface SearchCatalogRequest.ScopeOrBuilder
        Parameters:
        index - The index of the value to return.
        Returns:
        The bytes of the includeOrgIds at the given index.

      • getIncludeProjectIdsList

        public com.google.protobuf.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;
        Specified by:
        getIncludeProjectIdsList in interface SearchCatalogRequest.ScopeOrBuilder
        Returns:
        A list containing the includeProjectIds.

      • 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;
        Specified by:
        getIncludeProjectIdsCount in interface SearchCatalogRequest.ScopeOrBuilder
        Returns:
        The count of includeProjectIds.

      • getIncludeProjectIds

        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;
        Specified by:
        getIncludeProjectIds in interface SearchCatalogRequest.ScopeOrBuilder
        Parameters:
        index - The index of the element to return.
        Returns:
        The includeProjectIds at the given index.

      • getIncludeProjectIdsBytes

        public com.google.protobuf.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;
        Specified by:
        getIncludeProjectIdsBytes in interface SearchCatalogRequest.ScopeOrBuilder
        Parameters:
        index - The index of the value to return.
        Returns:
        The bytes of the includeProjectIds at the given index.

      • 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;
        Specified by:
        getIncludeGcpPublicDatasets in interface SearchCatalogRequest.ScopeOrBuilder
        Returns:
        The includeGcpPublicDatasets.

      • getRestrictedLocationsList

        public com.google.protobuf.ProtocolStringList getRestrictedLocationsList()
         Optional. The list of locations to search within.
 1. If empty, search will be performed in all locations;
 2. If any of the locations are NOT in the valid locations list, error
 will be returned;
 3. 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];
        Specified by:
        getRestrictedLocationsList in interface SearchCatalogRequest.ScopeOrBuilder
        Returns:
        A list containing the restrictedLocations.

      • getRestrictedLocationsCount

        public int getRestrictedLocationsCount()
         Optional. The list of locations to search within.
 1. If empty, search will be performed in all locations;
 2. If any of the locations are NOT in the valid locations list, error
 will be returned;
 3. 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];
        Specified by:
        getRestrictedLocationsCount in interface SearchCatalogRequest.ScopeOrBuilder
        Returns:
        The count of restrictedLocations.

      • getRestrictedLocations

        public String getRestrictedLocations​(int index)
         Optional. The list of locations to search within.
 1. If empty, search will be performed in all locations;
 2. If any of the locations are NOT in the valid locations list, error
 will be returned;
 3. 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];
        Specified by:
        getRestrictedLocations in interface SearchCatalogRequest.ScopeOrBuilder
        Parameters:
        index - The index of the element to return.
        Returns:
        The restrictedLocations at the given index.

      • getRestrictedLocationsBytes

        public com.google.protobuf.ByteString getRestrictedLocationsBytes​(int index)
         Optional. The list of locations to search within.
 1. If empty, search will be performed in all locations;
 2. If any of the locations are NOT in the valid locations list, error
 will be returned;
 3. 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];
        Specified by:
        getRestrictedLocationsBytes in interface SearchCatalogRequest.ScopeOrBuilder
        Parameters:
        index - The index of the value to return.
        Returns:
        The bytes of the restrictedLocations at the given index.

      • isInitialized

        public final boolean isInitialized()
        Specified by:
        isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
        Overrides:
        isInitialized in class com.google.protobuf.GeneratedMessageV3

      • writeTo

        public void writeTo​(com.google.protobuf.CodedOutputStream output)
             throws IOException
        Specified by:
        writeTo in interface com.google.protobuf.MessageLite
        Overrides:
        writeTo in class com.google.protobuf.GeneratedMessageV3
        Throws:
        IOException

      • getSerializedSize

        public int getSerializedSize()
        Specified by:
        getSerializedSize in interface com.google.protobuf.MessageLite
        Overrides:
        getSerializedSize in class com.google.protobuf.GeneratedMessageV3

      • equals

        public boolean equals​(Object obj)
        Specified by:
        equals in interface com.google.protobuf.Message
        Overrides:
        equals in class com.google.protobuf.AbstractMessage

      • hashCode

        public int hashCode()
        Specified by:
        hashCode in interface com.google.protobuf.Message
        Overrides:
        hashCode in class com.google.protobuf.AbstractMessage

      • parseFrom

        public static SearchCatalogRequest.Scope parseFrom​(ByteBuffer data)
                                            throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static SearchCatalogRequest.Scope parseFrom​(ByteBuffer data,
                                                   com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                            throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static SearchCatalogRequest.Scope parseFrom​(com.google.protobuf.ByteString data)
                                            throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static SearchCatalogRequest.Scope parseFrom​(com.google.protobuf.ByteString data,
                                                   com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                            throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static SearchCatalogRequest.Scope parseFrom​(byte[] data)
                                            throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static SearchCatalogRequest.Scope parseFrom​(byte[] data,
                                                   com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                            throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • newBuilderForType

        public SearchCatalogRequest.Scope.Builder newBuilderForType()
        Specified by:
        newBuilderForType in interface com.google.protobuf.Message
        Specified by:
        newBuilderForType in interface com.google.protobuf.MessageLite

      • toBuilder

        public SearchCatalogRequest.Scope.Builder toBuilder()
        Specified by:
        toBuilder in interface com.google.protobuf.Message
        Specified by:
        toBuilder in interface com.google.protobuf.MessageLite

      • newBuilderForType

        protected SearchCatalogRequest.Scope.Builder newBuilderForType​(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
        Specified by:
        newBuilderForType in class com.google.protobuf.GeneratedMessageV3

      • getParserForType

        public com.google.protobuf.Parser<SearchCatalogRequest.Scope> getParserForType()
        Specified by:
        getParserForType in interface com.google.protobuf.Message
        Specified by:
        getParserForType in interface com.google.protobuf.MessageLite
        Overrides:
        getParserForType in class com.google.protobuf.GeneratedMessageV3

      • getDefaultInstanceForType

        public SearchCatalogRequest.Scope getDefaultInstanceForType()
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder