Package com.google.cloud.dataplex.v1

Class AspectType

java.lang.Object
com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessage
com.google.protobuf.GeneratedMessage
com.google.cloud.dataplex.v1.AspectType
All Implemented Interfaces:
AspectTypeOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable
@Generated public final class AspectType extends com.google.protobuf.GeneratedMessage implements AspectTypeOrBuilder
 AspectType is a template for creating Aspects, and represents the
 JSON-schema for a given Entry, for example, BigQuery Table Schema.
Protobuf type google.cloud.dataplex.v1.AspectType
See Also:

  • Field Details

    • NAME_FIELD_NUMBER

      public static final int NAME_FIELD_NUMBER
      See Also:

    • UID_FIELD_NUMBER

      public static final int UID_FIELD_NUMBER
      See Also:

    • CREATE_TIME_FIELD_NUMBER

      public static final int CREATE_TIME_FIELD_NUMBER
      See Also:

    • UPDATE_TIME_FIELD_NUMBER

      public static final int UPDATE_TIME_FIELD_NUMBER
      See Also:

    • DESCRIPTION_FIELD_NUMBER

      public static final int DESCRIPTION_FIELD_NUMBER
      See Also:

    • DISPLAY_NAME_FIELD_NUMBER

      public static final int DISPLAY_NAME_FIELD_NUMBER
      See Also:

    • LABELS_FIELD_NUMBER

      public static final int LABELS_FIELD_NUMBER
      See Also:

    • ETAG_FIELD_NUMBER

      public static final int ETAG_FIELD_NUMBER
      See Also:

    • DATA_CLASSIFICATION_FIELD_NUMBER

      public static final int DATA_CLASSIFICATION_FIELD_NUMBER
      See Also:

    • AUTHORIZATION_FIELD_NUMBER

      public static final int AUTHORIZATION_FIELD_NUMBER
      See Also:

    • METADATA_TEMPLATE_FIELD_NUMBER

      public static final int METADATA_TEMPLATE_FIELD_NUMBER
      See Also:

    • TRANSFER_STATUS_FIELD_NUMBER

      public static final int TRANSFER_STATUS_FIELD_NUMBER
      See Also:

  • Method Details

    • getDescriptor

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

    • internalGetMapFieldReflection

      protected com.google.protobuf.MapFieldReflectionAccessor internalGetMapFieldReflection(int number)
      Overrides:
      internalGetMapFieldReflection in class com.google.protobuf.GeneratedMessage

    • internalGetFieldAccessorTable

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

    • getName

      public String getName()
       Output only. The relative resource name of the AspectType, of the form:
 projects/{project_number}/locations/{location_id}/aspectTypes/{aspect_type_id}.
      string name = 1 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.resource_reference) = { ... }
      Specified by:
      getName in interface AspectTypeOrBuilder
      Returns:
      The name.

    • getNameBytes

      public com.google.protobuf.ByteString getNameBytes()
       Output only. The relative resource name of the AspectType, of the form:
 projects/{project_number}/locations/{location_id}/aspectTypes/{aspect_type_id}.
      string name = 1 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.resource_reference) = { ... }
      Specified by:
      getNameBytes in interface AspectTypeOrBuilder
      Returns:
      The bytes for name.

    • getUid

      public String getUid()
       Output only. System generated globally unique ID for the AspectType.
 If you delete and recreate the AspectType with the same name, then this ID
 will be different.
      string uid = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      getUid in interface AspectTypeOrBuilder
      Returns:
      The uid.

    • getUidBytes

      public com.google.protobuf.ByteString getUidBytes()
       Output only. System generated globally unique ID for the AspectType.
 If you delete and recreate the AspectType with the same name, then this ID
 will be different.
      string uid = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      getUidBytes in interface AspectTypeOrBuilder
      Returns:
      The bytes for uid.

    • hasCreateTime

      public boolean hasCreateTime()
       Output only. The time when the AspectType was created.
      .google.protobuf.Timestamp create_time = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      hasCreateTime in interface AspectTypeOrBuilder
      Returns:
      Whether the createTime field is set.

    • getCreateTime

      public com.google.protobuf.Timestamp getCreateTime()
       Output only. The time when the AspectType was created.
      .google.protobuf.Timestamp create_time = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      getCreateTime in interface AspectTypeOrBuilder
      Returns:
      The createTime.

    • getCreateTimeOrBuilder

      public com.google.protobuf.TimestampOrBuilder getCreateTimeOrBuilder()
       Output only. The time when the AspectType was created.
      .google.protobuf.Timestamp create_time = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      getCreateTimeOrBuilder in interface AspectTypeOrBuilder

    • hasUpdateTime

      public boolean hasUpdateTime()
       Output only. The time when the AspectType was last updated.
      .google.protobuf.Timestamp update_time = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      hasUpdateTime in interface AspectTypeOrBuilder
      Returns:
      Whether the updateTime field is set.

    • getUpdateTime

      public com.google.protobuf.Timestamp getUpdateTime()
       Output only. The time when the AspectType was last updated.
      .google.protobuf.Timestamp update_time = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      getUpdateTime in interface AspectTypeOrBuilder
      Returns:
      The updateTime.

    • getUpdateTimeOrBuilder

      public com.google.protobuf.TimestampOrBuilder getUpdateTimeOrBuilder()
       Output only. The time when the AspectType was last updated.
      .google.protobuf.Timestamp update_time = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      getUpdateTimeOrBuilder in interface AspectTypeOrBuilder

    • getDescription

      public String getDescription()
       Optional. Description of the AspectType.
      string description = 5 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getDescription in interface AspectTypeOrBuilder
      Returns:
      The description.

    • getDescriptionBytes

      public com.google.protobuf.ByteString getDescriptionBytes()
       Optional. Description of the AspectType.
      string description = 5 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getDescriptionBytes in interface AspectTypeOrBuilder
      Returns:
      The bytes for description.

    • getDisplayName

      public String getDisplayName()
       Optional. User friendly display name.
      string display_name = 6 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getDisplayName in interface AspectTypeOrBuilder
      Returns:
      The displayName.

    • getDisplayNameBytes

      public com.google.protobuf.ByteString getDisplayNameBytes()
       Optional. User friendly display name.
      string display_name = 6 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getDisplayNameBytes in interface AspectTypeOrBuilder
      Returns:
      The bytes for displayName.

    • getLabelsCount

      public int getLabelsCount()
      Description copied from interface: AspectTypeOrBuilder
       Optional. User-defined labels for the AspectType.
      map<string, string> labels = 7 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getLabelsCount in interface AspectTypeOrBuilder

    • containsLabels

      public boolean containsLabels(String key)
       Optional. User-defined labels for the AspectType.
      map<string, string> labels = 7 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      containsLabels in interface AspectTypeOrBuilder

    • getLabels

      @Deprecated public Map<String,String> getLabels()
      Deprecated.
      Use getLabelsMap() instead.
      Specified by:
      getLabels in interface AspectTypeOrBuilder

    • getLabelsMap

      public Map<String,String> getLabelsMap()
       Optional. User-defined labels for the AspectType.
      map<string, string> labels = 7 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getLabelsMap in interface AspectTypeOrBuilder

    • getLabelsOrDefault

      public String getLabelsOrDefault(String key, String defaultValue)
       Optional. User-defined labels for the AspectType.
      map<string, string> labels = 7 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getLabelsOrDefault in interface AspectTypeOrBuilder

    • getLabelsOrThrow

      public String getLabelsOrThrow(String key)
       Optional. User-defined labels for the AspectType.
      map<string, string> labels = 7 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getLabelsOrThrow in interface AspectTypeOrBuilder

    • getEtag

      public String getEtag()
       The service computes this checksum. The client may send it on update and
 delete requests to ensure it has an up-to-date value before proceeding.
      string etag = 8;
      Specified by:
      getEtag in interface AspectTypeOrBuilder
      Returns:
      The etag.

    • getEtagBytes

      public com.google.protobuf.ByteString getEtagBytes()
       The service computes this checksum. The client may send it on update and
 delete requests to ensure it has an up-to-date value before proceeding.
      string etag = 8;
      Specified by:
      getEtagBytes in interface AspectTypeOrBuilder
      Returns:
      The bytes for etag.

    • getDataClassificationValue

      public int getDataClassificationValue()
       Optional. Immutable. Stores data classification of the aspect.
      .google.cloud.dataplex.v1.AspectType.DataClassification data_classification = 9 [(.google.api.field_behavior) = OPTIONAL, (.google.api.field_behavior) = IMMUTABLE];
      Specified by:
      getDataClassificationValue in interface AspectTypeOrBuilder
      Returns:
      The enum numeric value on the wire for dataClassification.

    • getDataClassification

      public AspectType.DataClassification getDataClassification()
       Optional. Immutable. Stores data classification of the aspect.
      .google.cloud.dataplex.v1.AspectType.DataClassification data_classification = 9 [(.google.api.field_behavior) = OPTIONAL, (.google.api.field_behavior) = IMMUTABLE];
      Specified by:
      getDataClassification in interface AspectTypeOrBuilder
      Returns:
      The dataClassification.

    • hasAuthorization

      public boolean hasAuthorization()
       Immutable. Defines the Authorization for this type.
      .google.cloud.dataplex.v1.AspectType.Authorization authorization = 52 [(.google.api.field_behavior) = IMMUTABLE];
      Specified by:
      hasAuthorization in interface AspectTypeOrBuilder
      Returns:
      Whether the authorization field is set.

    • getAuthorization

      public AspectType.Authorization getAuthorization()
       Immutable. Defines the Authorization for this type.
      .google.cloud.dataplex.v1.AspectType.Authorization authorization = 52 [(.google.api.field_behavior) = IMMUTABLE];
      Specified by:
      getAuthorization in interface AspectTypeOrBuilder
      Returns:
      The authorization.

    • getAuthorizationOrBuilder

      public AspectType.AuthorizationOrBuilder getAuthorizationOrBuilder()
       Immutable. Defines the Authorization for this type.
      .google.cloud.dataplex.v1.AspectType.Authorization authorization = 52 [(.google.api.field_behavior) = IMMUTABLE];
      Specified by:
      getAuthorizationOrBuilder in interface AspectTypeOrBuilder

    • hasMetadataTemplate

      public boolean hasMetadataTemplate()
       Required. MetadataTemplate of the aspect.
      .google.cloud.dataplex.v1.AspectType.MetadataTemplate metadata_template = 53 [(.google.api.field_behavior) = REQUIRED];
      Specified by:
      hasMetadataTemplate in interface AspectTypeOrBuilder
      Returns:
      Whether the metadataTemplate field is set.

    • getMetadataTemplate

      public AspectType.MetadataTemplate getMetadataTemplate()
       Required. MetadataTemplate of the aspect.
      .google.cloud.dataplex.v1.AspectType.MetadataTemplate metadata_template = 53 [(.google.api.field_behavior) = REQUIRED];
      Specified by:
      getMetadataTemplate in interface AspectTypeOrBuilder
      Returns:
      The metadataTemplate.

    • getMetadataTemplateOrBuilder

      public AspectType.MetadataTemplateOrBuilder getMetadataTemplateOrBuilder()
       Required. MetadataTemplate of the aspect.
      .google.cloud.dataplex.v1.AspectType.MetadataTemplate metadata_template = 53 [(.google.api.field_behavior) = REQUIRED];
      Specified by:
      getMetadataTemplateOrBuilder in interface AspectTypeOrBuilder

    • getTransferStatusValue

      public int getTransferStatusValue()
       Output only. Denotes the transfer status of the Aspect Type. It is
 unspecified for Aspect Types created from Dataplex API.
      .google.cloud.dataplex.v1.TransferStatus transfer_status = 202 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      getTransferStatusValue in interface AspectTypeOrBuilder
      Returns:
      The enum numeric value on the wire for transferStatus.

    • getTransferStatus

      public TransferStatus getTransferStatus()
       Output only. Denotes the transfer status of the Aspect Type. It is
 unspecified for Aspect Types created from Dataplex API.
      .google.cloud.dataplex.v1.TransferStatus transfer_status = 202 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      getTransferStatus in interface AspectTypeOrBuilder
      Returns:
      The transferStatus.

    • 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 AspectType parseFrom(ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

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

    • parseFrom

      public static AspectType parseFrom(com.google.protobuf.ByteString data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

      public static AspectType parseFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

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

    • parseDelimitedFrom

      public static AspectType parseDelimitedFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

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

    • parseFrom

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

    • parseFrom

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

    • newBuilderForType

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

    • newBuilder

      public static AspectType.Builder newBuilder()

    • newBuilder

      public static AspectType.Builder newBuilder(AspectType prototype)

    • toBuilder

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

    • newBuilderForType

      protected AspectType.Builder newBuilderForType(com.google.protobuf.AbstractMessage.BuilderParent parent)
      Overrides:
      newBuilderForType in class com.google.protobuf.AbstractMessage

    • getDefaultInstance

      public static AspectType getDefaultInstance()

    • parser

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

    • getParserForType

      public com.google.protobuf.Parser<AspectType> 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 AspectType getDefaultInstanceForType()
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder