Package com.google.cloud.datacatalog.v1

Class SearchCatalogRequest.Scope

java.lang.Object
com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessage
com.google.protobuf.GeneratedMessage
com.google.cloud.datacatalog.v1.SearchCatalogRequest.Scope
All Implemented Interfaces:
SearchCatalogRequest.ScopeOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable
Enclosing class:
SearchCatalogRequest
public static final class SearchCatalogRequest.Scope extends com.google.protobuf.GeneratedMessage implements SearchCatalogRequest.ScopeOrBuilder
 The criteria that select the subspace used for query matching.
Protobuf type google.cloud.datacatalog.v1.SearchCatalogRequest.Scope
See Also:

  • Field Details

    • INCLUDE_ORG_IDS_FIELD_NUMBER

      public static final int INCLUDE_ORG_IDS_FIELD_NUMBER
      See Also:

    • INCLUDE_PROJECT_IDS_FIELD_NUMBER

      public static final int INCLUDE_PROJECT_IDS_FIELD_NUMBER
      See Also:

    • INCLUDE_GCP_PUBLIC_DATASETS_FIELD_NUMBER

      public static final int INCLUDE_GCP_PUBLIC_DATASETS_FIELD_NUMBER
      See Also:

    • RESTRICTED_LOCATIONS_FIELD_NUMBER

      public static final int RESTRICTED_LOCATIONS_FIELD_NUMBER
      See Also:

    • STARRED_ONLY_FIELD_NUMBER

      public static final int STARRED_ONLY_FIELD_NUMBER
      See Also:

    • INCLUDE_PUBLIC_TAG_TEMPLATES_FIELD_NUMBER

      public static final int INCLUDE_PUBLIC_TAG_TEMPLATES_FIELD_NUMBER
      See Also:

  • Method Details

    • getDescriptor

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

    • internalGetFieldAccessorTable

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

    • getIncludeOrgIdsList

      public com.google.protobuf.ProtocolStringList getIncludeOrgIdsList()
       The list of organization IDs to search within.

 To find your organization ID, follow the steps from
 [Creating and managing organizations]
 (/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 the steps from
 [Creating and managing organizations]
 (/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 the steps from
 [Creating and managing organizations]
 (/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 the steps from
 [Creating and managing organizations]
 (/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.

 For more information on the distinction between project names, IDs, and
 numbers, see [Projects](/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.

 For more information on the distinction between project names, IDs, and
 numbers, see [Projects](/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.

 For more information on the distinction between project names, IDs, and
 numbers, see [Projects](/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.

 For more information on the distinction between project names, IDs, and
 numbers, see [Projects](/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
 search results. By default, they are excluded.

 See [Google Cloud Public Datasets](/public-datasets) for more
 information.
      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. If empty, all locations
 are searched.

 Returns an error if any location in the list isn't one of the [Supported
 regions](https://cloud.google.com/data-catalog/docs/concepts/regions#supported_regions).

 If a location is unreachable, its name is returned in the
 `SearchCatalogResponse.unreachable` field. To get additional information
 on the error, repeat the search request and set the location name as the
 value of this parameter.
      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. If empty, all locations
 are searched.

 Returns an error if any location in the list isn't one of the [Supported
 regions](https://cloud.google.com/data-catalog/docs/concepts/regions#supported_regions).

 If a location is unreachable, its name is returned in the
 `SearchCatalogResponse.unreachable` field. To get additional information
 on the error, repeat the search request and set the location name as the
 value of this parameter.
      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. If empty, all locations
 are searched.

 Returns an error if any location in the list isn't one of the [Supported
 regions](https://cloud.google.com/data-catalog/docs/concepts/regions#supported_regions).

 If a location is unreachable, its name is returned in the
 `SearchCatalogResponse.unreachable` field. To get additional information
 on the error, repeat the search request and set the location name as the
 value of this parameter.
      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. If empty, all locations
 are searched.

 Returns an error if any location in the list isn't one of the [Supported
 regions](https://cloud.google.com/data-catalog/docs/concepts/regions#supported_regions).

 If a location is unreachable, its name is returned in the
 `SearchCatalogResponse.unreachable` field. To get additional information
 on the error, repeat the search request and set the location name as the
 value of this parameter.
      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.

    • getStarredOnly

      public boolean getStarredOnly()
       Optional. If `true`, search only among starred entries.

 By default, all results are returned, starred or not.
      bool starred_only = 18 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getStarredOnly in interface SearchCatalogRequest.ScopeOrBuilder
      Returns:
      The starredOnly.

    • getIncludePublicTagTemplates

      @Deprecated public boolean getIncludePublicTagTemplates()
      Deprecated.
      google.cloud.datacatalog.v1.SearchCatalogRequest.Scope.include_public_tag_templates is deprecated. See google/cloud/datacatalog/v1/datacatalog.proto;l=754
       Optional. This field is deprecated. The search mechanism for public and
 private tag templates is the same.
      bool include_public_tag_templates = 19 [deprecated = true, (.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getIncludePublicTagTemplates in interface SearchCatalogRequest.ScopeOrBuilder
      Returns:
      The includePublicTagTemplates.

    • isInitialized

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

    • 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.GeneratedMessage
      Throws:
      IOException

    • getSerializedSize

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

    • 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

    • parseFrom

      public static SearchCatalogRequest.Scope parseFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

      public static SearchCatalogRequest.Scope parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

      public static SearchCatalogRequest.Scope parseDelimitedFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

      public static SearchCatalogRequest.Scope parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • parseFrom

      public static SearchCatalogRequest.Scope parseFrom(com.google.protobuf.CodedInputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

      public static SearchCatalogRequest.Scope parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • newBuilderForType

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

    • newBuilder

      public static SearchCatalogRequest.Scope.Builder newBuilder()

    • newBuilder

      public static SearchCatalogRequest.Scope.Builder newBuilder(SearchCatalogRequest.Scope prototype)

    • 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.AbstractMessage.BuilderParent parent)
      Overrides:
      newBuilderForType in class com.google.protobuf.AbstractMessage

    • getDefaultInstance

      public static SearchCatalogRequest.Scope getDefaultInstance()

    • parser

      public static com.google.protobuf.Parser<SearchCatalogRequest.Scope> parser()

    • 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.GeneratedMessage

    • getDefaultInstanceForType

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