Package com.google.cloud.datalabeling.v1beta1

Class AnnotationSpecSet

  • All Implemented Interfaces:
    AnnotationSpecSetOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable
    public final class AnnotationSpecSet
extends com.google.protobuf.GeneratedMessageV3
implements AnnotationSpecSetOrBuilder
     An AnnotationSpecSet is a collection of label definitions. For example, in
 image classification tasks, you define a set of possible labels for images as
 an AnnotationSpecSet. An AnnotationSpecSet is immutable upon creation.
    Protobuf type google.cloud.datalabeling.v1beta1.AnnotationSpecSet
    See Also:
    Serialized Form

    • Field Detail

      • DISPLAY_NAME_FIELD_NUMBER

        public static final int DISPLAY_NAME_FIELD_NUMBER
        See Also:
        Constant Field Values

      • DESCRIPTION_FIELD_NUMBER

        public static final int DESCRIPTION_FIELD_NUMBER
        See Also:
        Constant Field Values

      • ANNOTATION_SPECS_FIELD_NUMBER

        public static final int ANNOTATION_SPECS_FIELD_NUMBER
        See Also:
        Constant Field Values

      • BLOCKING_RESOURCES_FIELD_NUMBER

        public static final int BLOCKING_RESOURCES_FIELD_NUMBER
        See Also:
        Constant Field Values

    • 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 AnnotationSpecSet resource name in the following format:

 "projects/<var>{project_id}</var>/annotationSpecSets/<var>{annotation_spec_set_id}</var>"
        string name = 1;
        Specified by:
        getName in interface AnnotationSpecSetOrBuilder
        Returns:
        The name.

      • getNameBytes

        public com.google.protobuf.ByteString getNameBytes()
         Output only. The AnnotationSpecSet resource name in the following format:

 "projects/<var>{project_id}</var>/annotationSpecSets/<var>{annotation_spec_set_id}</var>"
        string name = 1;
        Specified by:
        getNameBytes in interface AnnotationSpecSetOrBuilder
        Returns:
        The bytes for name.

      • getDisplayName

        public String getDisplayName()
         Required. The display name for AnnotationSpecSet that you define when you
 create it. Maximum of 64 characters.
        string display_name = 2;
        Specified by:
        getDisplayName in interface AnnotationSpecSetOrBuilder
        Returns:
        The displayName.

      • getDisplayNameBytes

        public com.google.protobuf.ByteString getDisplayNameBytes()
         Required. The display name for AnnotationSpecSet that you define when you
 create it. Maximum of 64 characters.
        string display_name = 2;
        Specified by:
        getDisplayNameBytes in interface AnnotationSpecSetOrBuilder
        Returns:
        The bytes for displayName.

      • getDescription

        public String getDescription()
         Optional. User-provided description of the annotation specification set.
 The description can be up to 10,000 characters long.
        string description = 3;
        Specified by:
        getDescription in interface AnnotationSpecSetOrBuilder
        Returns:
        The description.

      • getDescriptionBytes

        public com.google.protobuf.ByteString getDescriptionBytes()
         Optional. User-provided description of the annotation specification set.
 The description can be up to 10,000 characters long.
        string description = 3;
        Specified by:
        getDescriptionBytes in interface AnnotationSpecSetOrBuilder
        Returns:
        The bytes for description.

      • getAnnotationSpecsList

        public List<AnnotationSpec> getAnnotationSpecsList()
         Required. The array of AnnotationSpecs that you define when you create the
 AnnotationSpecSet. These are the possible labels for the labeling task.
        repeated .google.cloud.datalabeling.v1beta1.AnnotationSpec annotation_specs = 4;
        Specified by:
        getAnnotationSpecsList in interface AnnotationSpecSetOrBuilder

      • getAnnotationSpecsOrBuilderList

        public List<? extends AnnotationSpecOrBuilder> getAnnotationSpecsOrBuilderList()
         Required. The array of AnnotationSpecs that you define when you create the
 AnnotationSpecSet. These are the possible labels for the labeling task.
        repeated .google.cloud.datalabeling.v1beta1.AnnotationSpec annotation_specs = 4;
        Specified by:
        getAnnotationSpecsOrBuilderList in interface AnnotationSpecSetOrBuilder

      • getAnnotationSpecsCount

        public int getAnnotationSpecsCount()
         Required. The array of AnnotationSpecs that you define when you create the
 AnnotationSpecSet. These are the possible labels for the labeling task.
        repeated .google.cloud.datalabeling.v1beta1.AnnotationSpec annotation_specs = 4;
        Specified by:
        getAnnotationSpecsCount in interface AnnotationSpecSetOrBuilder

      • getAnnotationSpecs

        public AnnotationSpec getAnnotationSpecs​(int index)
         Required. The array of AnnotationSpecs that you define when you create the
 AnnotationSpecSet. These are the possible labels for the labeling task.
        repeated .google.cloud.datalabeling.v1beta1.AnnotationSpec annotation_specs = 4;
        Specified by:
        getAnnotationSpecs in interface AnnotationSpecSetOrBuilder

      • getAnnotationSpecsOrBuilder

        public AnnotationSpecOrBuilder getAnnotationSpecsOrBuilder​(int index)
         Required. The array of AnnotationSpecs that you define when you create the
 AnnotationSpecSet. These are the possible labels for the labeling task.
        repeated .google.cloud.datalabeling.v1beta1.AnnotationSpec annotation_specs = 4;
        Specified by:
        getAnnotationSpecsOrBuilder in interface AnnotationSpecSetOrBuilder

      • getBlockingResourcesList

        public com.google.protobuf.ProtocolStringList getBlockingResourcesList()
         Output only. The names of any related resources that are blocking changes
 to the annotation spec set.
        repeated string blocking_resources = 5;
        Specified by:
        getBlockingResourcesList in interface AnnotationSpecSetOrBuilder
        Returns:
        A list containing the blockingResources.

      • getBlockingResourcesCount

        public int getBlockingResourcesCount()
         Output only. The names of any related resources that are blocking changes
 to the annotation spec set.
        repeated string blocking_resources = 5;
        Specified by:
        getBlockingResourcesCount in interface AnnotationSpecSetOrBuilder
        Returns:
        The count of blockingResources.

      • getBlockingResources

        public String getBlockingResources​(int index)
         Output only. The names of any related resources that are blocking changes
 to the annotation spec set.
        repeated string blocking_resources = 5;
        Specified by:
        getBlockingResources in interface AnnotationSpecSetOrBuilder
        Parameters:
        index - The index of the element to return.
        Returns:
        The blockingResources at the given index.

      • getBlockingResourcesBytes

        public com.google.protobuf.ByteString getBlockingResourcesBytes​(int index)
         Output only. The names of any related resources that are blocking changes
 to the annotation spec set.
        repeated string blocking_resources = 5;
        Specified by:
        getBlockingResourcesBytes in interface AnnotationSpecSetOrBuilder
        Parameters:
        index - The index of the value to return.
        Returns:
        The bytes of the blockingResources at the given index.

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

      • parseFrom

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

      • parseFrom

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

      • parseFrom

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

      • parseFrom

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

      • parseFrom

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

      • parseFrom

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

      • newBuilderForType

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

      • toBuilder

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

      • newBuilderForType

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

      • getParserForType

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