- 1.51.0 (latest)
- 1.50.0
- 1.49.0
- 1.48.0
- 1.47.0
- 1.46.0
- 1.45.0
- 1.43.0
- 1.42.0
- 1.41.0
- 1.40.0
- 1.39.0
- 1.38.0
- 1.37.0
- 1.36.0
- 1.35.0
- 1.34.0
- 1.33.0
- 1.30.0
- 1.29.0
- 1.28.0
- 1.27.0
- 1.26.0
- 1.25.0
- 1.24.0
- 1.23.0
- 1.22.0
- 1.21.0
- 1.20.0
- 1.19.0
- 1.18.0
- 1.17.0
- 1.15.0
- 1.14.0
- 1.13.0
- 1.12.0
- 1.11.0
- 1.10.0
- 1.9.5
- 1.8.4
- 1.7.2
- 1.6.2
- 1.5.4
public static final class SearchCatalogRequest.Scope.Builder extends GeneratedMessageV3.Builder<SearchCatalogRequest.Scope.Builder> implements SearchCatalogRequest.ScopeOrBuilderThe criteria that select the subspace used for query matching.
Protobuf type google.cloud.datacatalog.v1.SearchCatalogRequest.Scope
Inheritance
Object > AbstractMessageLite.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessageV3.Builder > SearchCatalogRequest.Scope.BuilderImplements
SearchCatalogRequest.ScopeOrBuilderMethods
addAllIncludeOrgIds(Iterable<String> values)
public SearchCatalogRequest.Scope.Builder addAllIncludeOrgIds(Iterable<String> values)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;
| Name | Description |
| values | Iterable<String>The includeOrgIds to add. |
| Type | Description |
| SearchCatalogRequest.Scope.Builder | This builder for chaining. |
addAllIncludeProjectIds(Iterable<String> values)
public SearchCatalogRequest.Scope.Builder addAllIncludeProjectIds(Iterable<String> values)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;
| Name | Description |
| values | Iterable<String>The includeProjectIds to add. |
| Type | Description |
| SearchCatalogRequest.Scope.Builder | This builder for chaining. |
addAllRestrictedLocations(Iterable<String> values)
public SearchCatalogRequest.Scope.Builder addAllRestrictedLocations(Iterable<String> values)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];
| Name | Description |
| values | Iterable<String>The restrictedLocations to add. |
| Type | Description |
| SearchCatalogRequest.Scope.Builder | This builder for chaining. |
addIncludeOrgIds(String value)
public SearchCatalogRequest.Scope.Builder addIncludeOrgIds(String value)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;
| Name | Description |
| value | StringThe includeOrgIds to add. |
| Type | Description |
| SearchCatalogRequest.Scope.Builder | This builder for chaining. |
addIncludeOrgIdsBytes(ByteString value)
public SearchCatalogRequest.Scope.Builder addIncludeOrgIdsBytes(ByteString value)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;
| Name | Description |
| value | ByteStringThe bytes of the includeOrgIds to add. |
| Type | Description |
| SearchCatalogRequest.Scope.Builder | This builder for chaining. |
addIncludeProjectIds(String value)
public SearchCatalogRequest.Scope.Builder addIncludeProjectIds(String value)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;
| Name | Description |
| value | StringThe includeProjectIds to add. |
| Type | Description |
| SearchCatalogRequest.Scope.Builder | This builder for chaining. |
addIncludeProjectIdsBytes(ByteString value)
public SearchCatalogRequest.Scope.Builder addIncludeProjectIdsBytes(ByteString value)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;
| Name | Description |
| value | ByteStringThe bytes of the includeProjectIds to add. |
| Type | Description |
| SearchCatalogRequest.Scope.Builder | This builder for chaining. |
addRepeatedField(Descriptors.FieldDescriptor field, Object value)
public SearchCatalogRequest.Scope.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)| Name | Description |
| field | FieldDescriptor |
| value | Object |
| Type | Description |
| SearchCatalogRequest.Scope.Builder |
addRestrictedLocations(String value)
public SearchCatalogRequest.Scope.Builder addRestrictedLocations(String value)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];
| Name | Description |
| value | StringThe restrictedLocations to add. |
| Type | Description |
| SearchCatalogRequest.Scope.Builder | This builder for chaining. |
addRestrictedLocationsBytes(ByteString value)
public SearchCatalogRequest.Scope.Builder addRestrictedLocationsBytes(ByteString value)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];
| Name | Description |
| value | ByteStringThe bytes of the restrictedLocations to add. |
| Type | Description |
| SearchCatalogRequest.Scope.Builder | This builder for chaining. |
build()
public SearchCatalogRequest.Scope build()| Type | Description |
| SearchCatalogRequest.Scope |
buildPartial()
public SearchCatalogRequest.Scope buildPartial()| Type | Description |
| SearchCatalogRequest.Scope |
clear()
public SearchCatalogRequest.Scope.Builder clear()| Type | Description |
| SearchCatalogRequest.Scope.Builder |
clearField(Descriptors.FieldDescriptor field)
public SearchCatalogRequest.Scope.Builder clearField(Descriptors.FieldDescriptor field)| Name | Description |
| field | FieldDescriptor |
| Type | Description |
| SearchCatalogRequest.Scope.Builder |
clearIncludeGcpPublicDatasets()
public SearchCatalogRequest.Scope.Builder clearIncludeGcpPublicDatasets()If `true`, include Google Cloud Platform (GCP) 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;
| Type | Description |
| SearchCatalogRequest.Scope.Builder | This builder for chaining. |
clearIncludeOrgIds()
public SearchCatalogRequest.Scope.Builder clearIncludeOrgIds()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;
| Type | Description |
| SearchCatalogRequest.Scope.Builder | This builder for chaining. |
clearIncludeProjectIds()
public SearchCatalogRequest.Scope.Builder clearIncludeProjectIds()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;
| Type | Description |
| SearchCatalogRequest.Scope.Builder | This builder for chaining. |
clearIncludePublicTagTemplates()
public SearchCatalogRequest.Scope.Builder clearIncludePublicTagTemplates()Optional. If `true`, include [public tag
templates][google.cloud.datacatalog.v1.TagTemplate.is_publicly_readable]
in the search results. By default, they are included only if you have
explicit permissions on them to view them. For example, if you are the
owner.
Other scope fields, for example, ``include_org_ids``,
still restrict the returned public tag templates and at least one of
them is required.
bool include_public_tag_templates = 19 [(.google.api.field_behavior) = OPTIONAL];
| Type | Description |
| SearchCatalogRequest.Scope.Builder | This builder for chaining. |
clearOneof(Descriptors.OneofDescriptor oneof)
public SearchCatalogRequest.Scope.Builder clearOneof(Descriptors.OneofDescriptor oneof)| Name | Description |
| oneof | OneofDescriptor |
| Type | Description |
| SearchCatalogRequest.Scope.Builder |
clearRestrictedLocations()
public SearchCatalogRequest.Scope.Builder clearRestrictedLocations()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];
| Type | Description |
| SearchCatalogRequest.Scope.Builder | This builder for chaining. |
clone()
public SearchCatalogRequest.Scope.Builder clone()| Type | Description |
| SearchCatalogRequest.Scope.Builder |
getDefaultInstanceForType()
public SearchCatalogRequest.Scope getDefaultInstanceForType()| Type | Description |
| SearchCatalogRequest.Scope |
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()| Type | Description |
| Descriptor |
getDescriptorForType()
public Descriptors.Descriptor getDescriptorForType()| Type | Description |
| Descriptor |
getIncludeGcpPublicDatasets()
public boolean getIncludeGcpPublicDatasets()If `true`, include Google Cloud Platform (GCP) 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;
| 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 the steps from
[Creating and managing organizations]
(/resource-manager/docs/creating-managing-organization).
repeated string include_org_ids = 2;
| Name | Description |
| index | intThe index of the element to return. |
| 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 the steps from
[Creating and managing organizations]
(/resource-manager/docs/creating-managing-organization).
repeated string include_org_ids = 2;
| Name | Description |
| index | intThe index of the value to return. |
| 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 the steps from
[Creating and managing organizations]
(/resource-manager/docs/creating-managing-organization).
repeated string include_org_ids = 2;
| 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 the steps from
[Creating and managing organizations]
(/resource-manager/docs/creating-managing-organization).
repeated string include_org_ids = 2;
| Type | Description |
| ProtocolStringList | A list containing the includeOrgIds. |
getIncludeProjectIds(int index)
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;
| Name | Description |
| index | intThe index of the element to return. |
| 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.
For more information on the distinction between project names, IDs, and
numbers, see [Projects](/docs/overview/#projects).
repeated string include_project_ids = 3;
| Name | Description |
| index | intThe index of the value to return. |
| Type | Description |
| ByteString | The bytes of the includeProjectIds at the given index. |
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;
| Type | Description |
| int | The count of includeProjectIds. |
getIncludeProjectIdsList()
public 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;
| Type | Description |
| ProtocolStringList | A list containing the includeProjectIds. |
getIncludePublicTagTemplates()
public boolean getIncludePublicTagTemplates()Optional. If `true`, include [public tag
templates][google.cloud.datacatalog.v1.TagTemplate.is_publicly_readable]
in the search results. By default, they are included only if you have
explicit permissions on them to view them. For example, if you are the
owner.
Other scope fields, for example, ``include_org_ids``,
still restrict the returned public tag templates and at least one of
them is required.
bool include_public_tag_templates = 19 [(.google.api.field_behavior) = OPTIONAL];
| Type | Description |
| boolean | The includePublicTagTemplates. |
getRestrictedLocations(int index)
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];
| Name | Description |
| index | intThe index of the element to return. |
| 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, 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];
| Name | Description |
| index | intThe index of the value to return. |
| 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, 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];
| Type | Description |
| int | The count of restrictedLocations. |
getRestrictedLocationsList()
public 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];
| Type | Description |
| ProtocolStringList | A list containing the restrictedLocations. |
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()| Type | Description |
| FieldAccessorTable |
isInitialized()
public final boolean isInitialized()| Type | Description |
| boolean |
mergeFrom(SearchCatalogRequest.Scope other)
public SearchCatalogRequest.Scope.Builder mergeFrom(SearchCatalogRequest.Scope other)| Name | Description |
| other | SearchCatalogRequest.Scope |
| Type | Description |
| SearchCatalogRequest.Scope.Builder |
mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public SearchCatalogRequest.Scope.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)| Name | Description |
| input | CodedInputStream |
| extensionRegistry | ExtensionRegistryLite |
| Type | Description |
| SearchCatalogRequest.Scope.Builder |
| Type | Description |
| IOException |
mergeFrom(Message other)
public SearchCatalogRequest.Scope.Builder mergeFrom(Message other)| Name | Description |
| other | Message |
| Type | Description |
| SearchCatalogRequest.Scope.Builder |
mergeUnknownFields(UnknownFieldSet unknownFields)
public final SearchCatalogRequest.Scope.Builder mergeUnknownFields(UnknownFieldSet unknownFields)| Name | Description |
| unknownFields | UnknownFieldSet |
| Type | Description |
| SearchCatalogRequest.Scope.Builder |
setField(Descriptors.FieldDescriptor field, Object value)
public SearchCatalogRequest.Scope.Builder setField(Descriptors.FieldDescriptor field, Object value)| Name | Description |
| field | FieldDescriptor |
| value | Object |
| Type | Description |
| SearchCatalogRequest.Scope.Builder |
setIncludeGcpPublicDatasets(boolean value)
public SearchCatalogRequest.Scope.Builder setIncludeGcpPublicDatasets(boolean value)If `true`, include Google Cloud Platform (GCP) 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;
| Name | Description |
| value | booleanThe includeGcpPublicDatasets to set. |
| Type | Description |
| SearchCatalogRequest.Scope.Builder | This builder for chaining. |
setIncludeOrgIds(int index, String value)
public SearchCatalogRequest.Scope.Builder setIncludeOrgIds(int index, String value)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;
| Name | Description |
| index | intThe index to set the value at. |
| value | StringThe includeOrgIds to set. |
| Type | Description |
| SearchCatalogRequest.Scope.Builder | This builder for chaining. |
setIncludeProjectIds(int index, String value)
public SearchCatalogRequest.Scope.Builder setIncludeProjectIds(int index, String value)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;
| Name | Description |
| index | intThe index to set the value at. |
| value | StringThe includeProjectIds to set. |
| Type | Description |
| SearchCatalogRequest.Scope.Builder | This builder for chaining. |
setIncludePublicTagTemplates(boolean value)
public SearchCatalogRequest.Scope.Builder setIncludePublicTagTemplates(boolean value)Optional. If `true`, include [public tag
templates][google.cloud.datacatalog.v1.TagTemplate.is_publicly_readable]
in the search results. By default, they are included only if you have
explicit permissions on them to view them. For example, if you are the
owner.
Other scope fields, for example, ``include_org_ids``,
still restrict the returned public tag templates and at least one of
them is required.
bool include_public_tag_templates = 19 [(.google.api.field_behavior) = OPTIONAL];
| Name | Description |
| value | booleanThe includePublicTagTemplates to set. |
| Type | Description |
| SearchCatalogRequest.Scope.Builder | This builder for chaining. |
setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
public SearchCatalogRequest.Scope.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)| Name | Description |
| field | FieldDescriptor |
| index | int |
| value | Object |
| Type | Description |
| SearchCatalogRequest.Scope.Builder |
setRestrictedLocations(int index, String value)
public SearchCatalogRequest.Scope.Builder setRestrictedLocations(int index, String value)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];
| Name | Description |
| index | intThe index to set the value at. |
| value | StringThe restrictedLocations to set. |
| Type | Description |
| SearchCatalogRequest.Scope.Builder | This builder for chaining. |
setUnknownFields(UnknownFieldSet unknownFields)
public final SearchCatalogRequest.Scope.Builder setUnknownFields(UnknownFieldSet unknownFields)| Name | Description |
| unknownFields | UnknownFieldSet |
| Type | Description |
| SearchCatalogRequest.Scope.Builder |