Class TableSpec

  • All Implemented Interfaces:
    TableSpecOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable

    public final class TableSpec
    extends com.google.protobuf.GeneratedMessageV3
    implements TableSpecOrBuilder
     A specification of a relational table.
     The table's schema is represented via its child column specs. It is
     pre-populated as part of ImportData by schema inference algorithm, the
     version of which is a required parameter of ImportData InputConfig.
     Note: While working with a table, at times the schema may be
     inconsistent with the data in the table (e.g. string in a FLOAT64 column).
     The consistency validation is done upon creation of a model.
     Used by:
       *   Tables
     
    Protobuf type google.cloud.automl.v1beta1.TableSpec
    See Also:
    Serialized Form
    • Nested Class Summary

      Nested Classes 
      Modifier and Type Class Description
      static class  TableSpec.Builder
      A specification of a relational table.
      • Nested classes/interfaces inherited from class com.google.protobuf.GeneratedMessageV3

        com.google.protobuf.GeneratedMessageV3.BuilderParent, com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>,​BuilderT extends com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT,​BuilderT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessageOrBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.FieldAccessorTable, com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter
      • Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessageLite

        com.google.protobuf.AbstractMessageLite.InternalOneOfEnum
    • 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
      • getName

        public String getName()
         Output only. The resource name of the table spec.
         Form:
        
         `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/tableSpecs/{table_spec_id}`
         
        string name = 1;
        Specified by:
        getName in interface TableSpecOrBuilder
        Returns:
        The name.
      • getNameBytes

        public com.google.protobuf.ByteString getNameBytes()
         Output only. The resource name of the table spec.
         Form:
        
         `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/tableSpecs/{table_spec_id}`
         
        string name = 1;
        Specified by:
        getNameBytes in interface TableSpecOrBuilder
        Returns:
        The bytes for name.
      • getTimeColumnSpecId

        public String getTimeColumnSpecId()
         column_spec_id of the time column. Only used if the parent dataset's
         ml_use_column_spec_id is not set. Used to split rows into TRAIN, VALIDATE
         and TEST sets such that oldest rows go to TRAIN set, newest to TEST, and
         those in between to VALIDATE.
         Required type: TIMESTAMP.
         If both this column and ml_use_column are not set, then ML use of all rows
         will be assigned by AutoML. NOTE: Updates of this field will instantly
         affect any other users concurrently working with the dataset.
         
        string time_column_spec_id = 2;
        Specified by:
        getTimeColumnSpecId in interface TableSpecOrBuilder
        Returns:
        The timeColumnSpecId.
      • getTimeColumnSpecIdBytes

        public com.google.protobuf.ByteString getTimeColumnSpecIdBytes()
         column_spec_id of the time column. Only used if the parent dataset's
         ml_use_column_spec_id is not set. Used to split rows into TRAIN, VALIDATE
         and TEST sets such that oldest rows go to TRAIN set, newest to TEST, and
         those in between to VALIDATE.
         Required type: TIMESTAMP.
         If both this column and ml_use_column are not set, then ML use of all rows
         will be assigned by AutoML. NOTE: Updates of this field will instantly
         affect any other users concurrently working with the dataset.
         
        string time_column_spec_id = 2;
        Specified by:
        getTimeColumnSpecIdBytes in interface TableSpecOrBuilder
        Returns:
        The bytes for timeColumnSpecId.
      • getRowCount

        public long getRowCount()
         Output only. The number of rows (i.e. examples) in the table.
         
        int64 row_count = 3;
        Specified by:
        getRowCount in interface TableSpecOrBuilder
        Returns:
        The rowCount.
      • getValidRowCount

        public long getValidRowCount()
         Output only. The number of valid rows (i.e. without values that don't match
         DataType-s of their columns).
         
        int64 valid_row_count = 4;
        Specified by:
        getValidRowCount in interface TableSpecOrBuilder
        Returns:
        The validRowCount.
      • getColumnCount

        public long getColumnCount()
         Output only. The number of columns of the table. That is, the number of
         child ColumnSpec-s.
         
        int64 column_count = 7;
        Specified by:
        getColumnCount in interface TableSpecOrBuilder
        Returns:
        The columnCount.
      • getInputConfigsList

        public List<InputConfig> getInputConfigsList()
         Output only. Input configs via which data currently residing in the table
         had been imported.
         
        repeated .google.cloud.automl.v1beta1.InputConfig input_configs = 5;
        Specified by:
        getInputConfigsList in interface TableSpecOrBuilder
      • getInputConfigsCount

        public int getInputConfigsCount()
         Output only. Input configs via which data currently residing in the table
         had been imported.
         
        repeated .google.cloud.automl.v1beta1.InputConfig input_configs = 5;
        Specified by:
        getInputConfigsCount in interface TableSpecOrBuilder
      • getInputConfigs

        public InputConfig getInputConfigs​(int index)
         Output only. Input configs via which data currently residing in the table
         had been imported.
         
        repeated .google.cloud.automl.v1beta1.InputConfig input_configs = 5;
        Specified by:
        getInputConfigs in interface TableSpecOrBuilder
      • getInputConfigsOrBuilder

        public InputConfigOrBuilder getInputConfigsOrBuilder​(int index)
         Output only. Input configs via which data currently residing in the table
         had been imported.
         
        repeated .google.cloud.automl.v1beta1.InputConfig input_configs = 5;
        Specified by:
        getInputConfigsOrBuilder in interface TableSpecOrBuilder
      • getEtag

        public String getEtag()
         Used to perform consistent read-modify-write updates. If not set, a blind
         "overwrite" update happens.
         
        string etag = 6;
        Specified by:
        getEtag in interface TableSpecOrBuilder
        Returns:
        The etag.
      • getEtagBytes

        public com.google.protobuf.ByteString getEtagBytes()
         Used to perform consistent read-modify-write updates. If not set, a blind
         "overwrite" update happens.
         
        string etag = 6;
        Specified by:
        getEtagBytes in interface TableSpecOrBuilder
        Returns:
        The bytes for etag.
      • 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 TableSpec parseFrom​(ByteBuffer data)
                                   throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException
      • parseFrom

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

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

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

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

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

        public static TableSpec parseFrom​(com.google.protobuf.CodedInputStream input,
                                          com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                   throws IOException
        Throws:
        IOException
      • newBuilderForType

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

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

        protected TableSpec.Builder newBuilderForType​(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
        Specified by:
        newBuilderForType in class com.google.protobuf.GeneratedMessageV3
      • getDefaultInstance

        public static TableSpec getDefaultInstance()
      • parser

        public static com.google.protobuf.Parser<TableSpec> parser()
      • getParserForType

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