public final class SearchCatalogResult extends GeneratedMessageV3 implements SearchCatalogResultOrBuilder
Result in the response to a search request.
Each result captures details of one entry that matches the search.
Protobuf type google.cloud.datacatalog.v1.SearchCatalogResult
Static Fields
DESCRIPTION_FIELD_NUMBER
public static final int DESCRIPTION_FIELD_NUMBER
Field Value
DISPLAY_NAME_FIELD_NUMBER
public static final int DISPLAY_NAME_FIELD_NUMBER
Field Value
FULLY_QUALIFIED_NAME_FIELD_NUMBER
public static final int FULLY_QUALIFIED_NAME_FIELD_NUMBER
Field Value
INTEGRATED_SYSTEM_FIELD_NUMBER
public static final int INTEGRATED_SYSTEM_FIELD_NUMBER
Field Value
LINKED_RESOURCE_FIELD_NUMBER
public static final int LINKED_RESOURCE_FIELD_NUMBER
Field Value
MODIFY_TIME_FIELD_NUMBER
public static final int MODIFY_TIME_FIELD_NUMBER
Field Value
RELATIVE_RESOURCE_NAME_FIELD_NUMBER
public static final int RELATIVE_RESOURCE_NAME_FIELD_NUMBER
Field Value
SEARCH_RESULT_SUBTYPE_FIELD_NUMBER
public static final int SEARCH_RESULT_SUBTYPE_FIELD_NUMBER
Field Value
SEARCH_RESULT_TYPE_FIELD_NUMBER
public static final int SEARCH_RESULT_TYPE_FIELD_NUMBER
Field Value
USER_SPECIFIED_SYSTEM_FIELD_NUMBER
public static final int USER_SPECIFIED_SYSTEM_FIELD_NUMBER
Field Value
Static Methods
getDefaultInstance()
public static SearchCatalogResult getDefaultInstance()
Returns
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()
Returns
newBuilder()
public static SearchCatalogResult.Builder newBuilder()
Returns
newBuilder(SearchCatalogResult prototype)
public static SearchCatalogResult.Builder newBuilder(SearchCatalogResult prototype)
Parameter
Returns
public static SearchCatalogResult parseDelimitedFrom(InputStream input)
Parameter
Returns
Exceptions
public static SearchCatalogResult parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parseFrom(byte[] data)
public static SearchCatalogResult parseFrom(byte[] data)
Parameter
| Name |
Description |
| data |
byte[]
|
Returns
Exceptions
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static SearchCatalogResult parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parseFrom(ByteString data)
public static SearchCatalogResult parseFrom(ByteString data)
Parameter
Returns
Exceptions
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static SearchCatalogResult parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
public static SearchCatalogResult parseFrom(CodedInputStream input)
Parameter
Returns
Exceptions
public static SearchCatalogResult parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
public static SearchCatalogResult parseFrom(InputStream input)
Parameter
Returns
Exceptions
public static SearchCatalogResult parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parseFrom(ByteBuffer data)
public static SearchCatalogResult parseFrom(ByteBuffer data)
Parameter
Returns
Exceptions
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static SearchCatalogResult parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parser()
public static Parser<SearchCatalogResult> parser()
Returns
Methods
equals(Object obj)
public boolean equals(Object obj)
Parameter
Returns
Overrides
getDefaultInstanceForType()
public SearchCatalogResult getDefaultInstanceForType()
Returns
getDescription()
public String getDescription()
Entry description that can consist of several sentences or paragraphs that
describe entry contents.
string description = 13;
| Type |
Description |
| String |
The description.
|
getDescriptionBytes()
public ByteString getDescriptionBytes()
Entry description that can consist of several sentences or paragraphs that
describe entry contents.
string description = 13;
| Type |
Description |
| ByteString |
The bytes for description.
|
getDisplayName()
public String getDisplayName()
The display name of the result.
string display_name = 12;
| Type |
Description |
| String |
The displayName.
|
getDisplayNameBytes()
public ByteString getDisplayNameBytes()
The display name of the result.
string display_name = 12;
| Type |
Description |
| ByteString |
The bytes for displayName.
|
getFullyQualifiedName()
public String getFullyQualifiedName()
Fully qualified name (FQN) of the resource.
FQNs take two forms:
- For non-regionalized resources:
{SYSTEM}:{PROJECT}.{PATH_TO_RESOURCE_SEPARATED_WITH_DOTS}
- For regionalized resources:
{SYSTEM}:{PROJECT}.{LOCATION_ID}.{PATH_TO_RESOURCE_SEPARATED_WITH_DOTS}
Example for a DPMS table:
dataproc_metastore:PROJECT_ID.LOCATION_ID.INSTANCE_ID.DATABASE_ID.TABLE_ID
string fully_qualified_name = 10;
| Type |
Description |
| String |
The fullyQualifiedName.
|
getFullyQualifiedNameBytes()
public ByteString getFullyQualifiedNameBytes()
Fully qualified name (FQN) of the resource.
FQNs take two forms:
- For non-regionalized resources:
{SYSTEM}:{PROJECT}.{PATH_TO_RESOURCE_SEPARATED_WITH_DOTS}
- For regionalized resources:
{SYSTEM}:{PROJECT}.{LOCATION_ID}.{PATH_TO_RESOURCE_SEPARATED_WITH_DOTS}
Example for a DPMS table:
dataproc_metastore:PROJECT_ID.LOCATION_ID.INSTANCE_ID.DATABASE_ID.TABLE_ID
string fully_qualified_name = 10;
| Type |
Description |
| ByteString |
The bytes for fullyQualifiedName.
|
getIntegratedSystem()
public IntegratedSystem getIntegratedSystem()
Output only. The source system that Data Catalog automatically integrates with, such
as BigQuery, Cloud Pub/Sub, or Dataproc Metastore.
.google.cloud.datacatalog.v1.IntegratedSystem integrated_system = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];
getIntegratedSystemValue()
public int getIntegratedSystemValue()
Output only. The source system that Data Catalog automatically integrates with, such
as BigQuery, Cloud Pub/Sub, or Dataproc Metastore.
.google.cloud.datacatalog.v1.IntegratedSystem integrated_system = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Type |
Description |
| int |
The enum numeric value on the wire for integratedSystem.
|
getLinkedResource()
public String getLinkedResource()
The full name of the Google Cloud resource the entry belongs to.
For more information, see Full Resource Name.
Example:
//bigquery.googleapis.com/projects/PROJECT_ID/datasets/DATASET_ID/tables/TABLE_ID
string linked_resource = 4;
| Type |
Description |
| String |
The linkedResource.
|
getLinkedResourceBytes()
public ByteString getLinkedResourceBytes()
The full name of the Google Cloud resource the entry belongs to.
For more information, see Full Resource Name.
Example:
//bigquery.googleapis.com/projects/PROJECT_ID/datasets/DATASET_ID/tables/TABLE_ID
string linked_resource = 4;
| Type |
Description |
| ByteString |
The bytes for linkedResource.
|
getModifyTime()
public Timestamp getModifyTime()
The last modification timestamp of the entry in the source system.
.google.protobuf.Timestamp modify_time = 7;
getModifyTimeOrBuilder()
public TimestampOrBuilder getModifyTimeOrBuilder()
The last modification timestamp of the entry in the source system.
.google.protobuf.Timestamp modify_time = 7;
getParserForType()
public Parser<SearchCatalogResult> getParserForType()
Returns
Overrides
getRelativeResourceName()
public String getRelativeResourceName()
The relative name of the resource in URL format.
Examples:
projects/{PROJECT_ID}/locations/{LOCATION_ID}/entryGroups/{ENTRY_GROUP_ID}/entries/{ENTRY_ID}projects/{PROJECT_ID}/tagTemplates/{TAG_TEMPLATE_ID}
string relative_resource_name = 3;
| Type |
Description |
| String |
The relativeResourceName.
|
getRelativeResourceNameBytes()
public ByteString getRelativeResourceNameBytes()
The relative name of the resource in URL format.
Examples:
projects/{PROJECT_ID}/locations/{LOCATION_ID}/entryGroups/{ENTRY_GROUP_ID}/entries/{ENTRY_ID}projects/{PROJECT_ID}/tagTemplates/{TAG_TEMPLATE_ID}
string relative_resource_name = 3;
| Type |
Description |
| ByteString |
The bytes for relativeResourceName.
|
getSearchResultSubtype()
public String getSearchResultSubtype()
Sub-type of the search result.
A dot-delimited full type of the resource. The same type you
specify in the type search predicate.
Examples: entry.table, entry.dataStream, tagTemplate.
string search_result_subtype = 2;
| Type |
Description |
| String |
The searchResultSubtype.
|
getSearchResultSubtypeBytes()
public ByteString getSearchResultSubtypeBytes()
Sub-type of the search result.
A dot-delimited full type of the resource. The same type you
specify in the type search predicate.
Examples: entry.table, entry.dataStream, tagTemplate.
string search_result_subtype = 2;
| Type |
Description |
| ByteString |
The bytes for searchResultSubtype.
|
getSearchResultType()
public SearchResultType getSearchResultType()
Type of the search result.
You can use this field to determine which get method to call to fetch the
full resource.
.google.cloud.datacatalog.v1.SearchResultType search_result_type = 1;
getSearchResultTypeValue()
public int getSearchResultTypeValue()
Type of the search result.
You can use this field to determine which get method to call to fetch the
full resource.
.google.cloud.datacatalog.v1.SearchResultType search_result_type = 1;
| Type |
Description |
| int |
The enum numeric value on the wire for searchResultType.
|
getSerializedSize()
public int getSerializedSize()
Returns
Overrides
getSystemCase()
public SearchCatalogResult.SystemCase getSystemCase()
Returns
getUnknownFields()
public final UnknownFieldSet getUnknownFields()
Returns
Overrides
getUserSpecifiedSystem()
public String getUserSpecifiedSystem()
Custom source system that you can manually integrate Data Catalog with.
string user_specified_system = 9;
| Type |
Description |
| String |
The userSpecifiedSystem.
|
getUserSpecifiedSystemBytes()
public ByteString getUserSpecifiedSystemBytes()
Custom source system that you can manually integrate Data Catalog with.
string user_specified_system = 9;
| Type |
Description |
| ByteString |
The bytes for userSpecifiedSystem.
|
hasIntegratedSystem()
public boolean hasIntegratedSystem()
Output only. The source system that Data Catalog automatically integrates with, such
as BigQuery, Cloud Pub/Sub, or Dataproc Metastore.
.google.cloud.datacatalog.v1.IntegratedSystem integrated_system = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Type |
Description |
| boolean |
Whether the integratedSystem field is set.
|
hasModifyTime()
public boolean hasModifyTime()
The last modification timestamp of the entry in the source system.
.google.protobuf.Timestamp modify_time = 7;
| Type |
Description |
| boolean |
Whether the modifyTime field is set.
|
hasUserSpecifiedSystem()
public boolean hasUserSpecifiedSystem()
Custom source system that you can manually integrate Data Catalog with.
string user_specified_system = 9;
| Type |
Description |
| boolean |
Whether the userSpecifiedSystem field is set.
|
hashCode()
Returns
Overrides
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Overrides
isInitialized()
public final boolean isInitialized()
Returns
Overrides
newBuilderForType()
public SearchCatalogResult.Builder newBuilderForType()
Returns
newBuilderForType(GeneratedMessageV3.BuilderParent parent)
protected SearchCatalogResult.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Returns
Overrides
newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Returns
Overrides
toBuilder()
public SearchCatalogResult.Builder toBuilder()
Returns
writeTo(CodedOutputStream output)
public void writeTo(CodedOutputStream output)
Parameter
Overrides
Exceptions
