Package com.google.cloud.visionai.v1

Class Corpus

java.lang.Object
com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessage
com.google.protobuf.GeneratedMessage
com.google.cloud.visionai.v1.Corpus
All Implemented Interfaces:
CorpusOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable
@Generated public final class Corpus extends com.google.protobuf.GeneratedMessage implements CorpusOrBuilder
 Corpus is a set of media contents for management.
 Within a corpus, media shares the same data schema. Search is also restricted
 within a single corpus.
Protobuf type google.cloud.visionai.v1.Corpus
See Also:

  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Class
    Description
    static final class 
    Corpus.Builder
    Corpus is a set of media contents for management.
    static enum 
    Corpus.Type
    Type of the asset inside the corpus.

    Nested classes/interfaces inherited from class com.google.protobuf.GeneratedMessage

    com.google.protobuf.GeneratedMessage.ExtendableBuilder<MessageT extends com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT>,BuilderT extends com.google.protobuf.GeneratedMessage.ExtendableBuilder<MessageT,BuilderT>>, com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT extends com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessage.ExtendableMessageOrBuilder<MessageT extends com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessage.FieldAccessorTable, com.google.protobuf.GeneratedMessage.GeneratedExtension<ContainingT extends com.google.protobuf.Message,T extends Object>, com.google.protobuf.GeneratedMessage.UnusedPrivateParameter

    Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessage

    com.google.protobuf.AbstractMessage.BuilderParent

    Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessageLite

    com.google.protobuf.AbstractMessageLite.InternalOneOfEnum

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final int
    DEFAULT_TTL_FIELD_NUMBER
     
    static final int
    DESCRIPTION_FIELD_NUMBER
     
    static final int
    DISPLAY_NAME_FIELD_NUMBER
     
    static final int
    NAME_FIELD_NUMBER
     
    static final int
    SATISFIES_PZI_FIELD_NUMBER
     
    static final int
    SATISFIES_PZS_FIELD_NUMBER
     
    static final int
    SEARCH_CAPABILITY_SETTING_FIELD_NUMBER
     
    static final int
    TYPE_FIELD_NUMBER
     

    Fields inherited from class com.google.protobuf.GeneratedMessage

    alwaysUseFieldBuilders, loggedPre22TypeNames, unknownFields

    Fields inherited from class com.google.protobuf.AbstractMessage

    memoizedSize

    Fields inherited from class com.google.protobuf.AbstractMessageLite

    memoizedHashCode

  • Method Summary

    Modifier and Type
    Method
    Description
    boolean
    equals(Object obj)
     
    static Corpus
    getDefaultInstance()
     
    Corpus
    getDefaultInstanceForType()
     
    com.google.protobuf.Duration
    getDefaultTtl()
    Optional.
    com.google.protobuf.DurationOrBuilder
    getDefaultTtlOrBuilder()
    Optional.
    String
    getDescription()
    Optional.
    com.google.protobuf.ByteString
    getDescriptionBytes()
    Optional.
    static final com.google.protobuf.Descriptors.Descriptor
    getDescriptor()
     
    String
    getDisplayName()
    Required.
    com.google.protobuf.ByteString
    getDisplayNameBytes()
    Required.
    String
    getName()
    Resource name of the corpus.
    com.google.protobuf.ByteString
    getNameBytes()
    Resource name of the corpus.
    com.google.protobuf.Parser<Corpus>
    getParserForType()
     
    boolean
    getSatisfiesPzi()
    Output only.
    boolean
    getSatisfiesPzs()
    Output only.
    SearchCapabilitySetting
    getSearchCapabilitySetting()
    Default search capability setting on corpus level.
    SearchCapabilitySettingOrBuilder
    getSearchCapabilitySettingOrBuilder()
    Default search capability setting on corpus level.
    int
    getSerializedSize()
     
    Corpus.Type
    getType()
    Optional.
    int
    getTypeValue()
    Optional.
    boolean
    hasDefaultTtl()
    Optional.
    int
    hashCode()
     
    boolean
    hasSatisfiesPzi()
    Output only.
    boolean
    hasSatisfiesPzs()
    Output only.
    boolean
    hasSearchCapabilitySetting()
    Default search capability setting on corpus level.
    protected com.google.protobuf.GeneratedMessage.FieldAccessorTable
    internalGetFieldAccessorTable()
     
    final boolean
    isInitialized()
     
    static Corpus.Builder
    newBuilder()
     
    static Corpus.Builder
    newBuilder(Corpus prototype)
     
    Corpus.Builder
    newBuilderForType()
     
    protected Corpus.Builder
    newBuilderForType(com.google.protobuf.AbstractMessage.BuilderParent parent)
     
    static Corpus
    parseDelimitedFrom(InputStream input)
     
    static Corpus
    parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static Corpus
    parseFrom(byte[] data)
     
    static Corpus
    parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static Corpus
    parseFrom(com.google.protobuf.ByteString data)
     
    static Corpus
    parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static Corpus
    parseFrom(com.google.protobuf.CodedInputStream input)
     
    static Corpus
    parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static Corpus
    parseFrom(InputStream input)
     
    static Corpus
    parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static Corpus
    parseFrom(ByteBuffer data)
     
    static Corpus
    parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static com.google.protobuf.Parser<Corpus>
    parser()
     
    Corpus.Builder
    toBuilder()
     
    void
    writeTo(com.google.protobuf.CodedOutputStream output)
     

    Methods inherited from class com.google.protobuf.GeneratedMessage

    canUseUnsafe, computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyList, emptyLongList, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof, internalGetMapField, internalGetMapFieldReflection, isStringEmpty, makeExtensionsImmutable, makeMutableCopy, makeMutableCopy, mergeFromAndMakeImmutableInternal, newFileScopedGeneratedExtension, newInstance, newMessageScopedGeneratedExtension, parseDelimitedWithIOException, parseDelimitedWithIOException, parseUnknownField, parseUnknownFieldProto3, parseWithIOException, parseWithIOException, parseWithIOException, parseWithIOException, serializeBooleanMapTo, serializeIntegerMapTo, serializeLongMapTo, serializeStringMapTo, writeReplace, writeString, writeStringNoTag

    Methods inherited from class com.google.protobuf.AbstractMessage

    findInitializationErrors, getInitializationErrorString, hashFields, toString

    Methods inherited from class com.google.protobuf.AbstractMessageLite

    addAll, checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeTo

    Methods inherited from class java.lang.Object

    clone, finalize, getClass, notify, notifyAll, wait, wait, wait

    Methods inherited from interface com.google.protobuf.MessageLite

    toByteArray, toByteString, writeDelimitedTo, writeTo

    Methods inherited from interface com.google.protobuf.MessageOrBuilder

    findInitializationErrors, getAllFields, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

  • Field Details

    • NAME_FIELD_NUMBER

      public static final int NAME_FIELD_NUMBER
      See Also:

    • DISPLAY_NAME_FIELD_NUMBER

      public static final int DISPLAY_NAME_FIELD_NUMBER
      See Also:

    • DESCRIPTION_FIELD_NUMBER

      public static final int DESCRIPTION_FIELD_NUMBER
      See Also:

    • DEFAULT_TTL_FIELD_NUMBER

      public static final int DEFAULT_TTL_FIELD_NUMBER
      See Also:

    • TYPE_FIELD_NUMBER

      public static final int TYPE_FIELD_NUMBER
      See Also:

    • SEARCH_CAPABILITY_SETTING_FIELD_NUMBER

      public static final int SEARCH_CAPABILITY_SETTING_FIELD_NUMBER
      See Also:

    • SATISFIES_PZS_FIELD_NUMBER

      public static final int SATISFIES_PZS_FIELD_NUMBER
      See Also:

    • SATISFIES_PZI_FIELD_NUMBER

      public static final int SATISFIES_PZI_FIELD_NUMBER
      See Also:

  • Method Details

    • getDescriptor

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

    • internalGetFieldAccessorTable

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

    • getName

      public String getName()
       Resource name of the corpus.
 Format:
 `projects/{project_number}/locations/{location_id}/corpora/{corpus_id}`
      string name = 1;
      Specified by:
      getName in interface CorpusOrBuilder
      Returns:
      The name.

    • getNameBytes

      public com.google.protobuf.ByteString getNameBytes()
       Resource name of the corpus.
 Format:
 `projects/{project_number}/locations/{location_id}/corpora/{corpus_id}`
      string name = 1;
      Specified by:
      getNameBytes in interface CorpusOrBuilder
      Returns:
      The bytes for name.

    • getDisplayName

      public String getDisplayName()
       Required. The corpus name to shown in the UI. The name can be up to 32
 characters long.
      string display_name = 2 [(.google.api.field_behavior) = REQUIRED];
      Specified by:
      getDisplayName in interface CorpusOrBuilder
      Returns:
      The displayName.

    • getDisplayNameBytes

      public com.google.protobuf.ByteString getDisplayNameBytes()
       Required. The corpus name to shown in the UI. The name can be up to 32
 characters long.
      string display_name = 2 [(.google.api.field_behavior) = REQUIRED];
      Specified by:
      getDisplayNameBytes in interface CorpusOrBuilder
      Returns:
      The bytes for displayName.

    • getDescription

      public String getDescription()
       Optional. Description of the corpus. Can be up to 25000 characters long.
      string description = 3 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getDescription in interface CorpusOrBuilder
      Returns:
      The description.

    • getDescriptionBytes

      public com.google.protobuf.ByteString getDescriptionBytes()
       Optional. Description of the corpus. Can be up to 25000 characters long.
      string description = 3 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getDescriptionBytes in interface CorpusOrBuilder
      Returns:
      The bytes for description.

    • hasDefaultTtl

      public boolean hasDefaultTtl()
       Optional. The default TTL value for all assets under the corpus without a
 asset level user-defined TTL. For STREAM_VIDEO type corpora, this is
 required and the maximum allowed
 default_ttl is 10 years.
      .google.protobuf.Duration default_ttl = 5 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      hasDefaultTtl in interface CorpusOrBuilder
      Returns:
      Whether the defaultTtl field is set.

    • getDefaultTtl

      public com.google.protobuf.Duration getDefaultTtl()
       Optional. The default TTL value for all assets under the corpus without a
 asset level user-defined TTL. For STREAM_VIDEO type corpora, this is
 required and the maximum allowed
 default_ttl is 10 years.
      .google.protobuf.Duration default_ttl = 5 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getDefaultTtl in interface CorpusOrBuilder
      Returns:
      The defaultTtl.

    • getDefaultTtlOrBuilder

      public com.google.protobuf.DurationOrBuilder getDefaultTtlOrBuilder()
       Optional. The default TTL value for all assets under the corpus without a
 asset level user-defined TTL. For STREAM_VIDEO type corpora, this is
 required and the maximum allowed
 default_ttl is 10 years.
      .google.protobuf.Duration default_ttl = 5 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getDefaultTtlOrBuilder in interface CorpusOrBuilder

    • getTypeValue

      public int getTypeValue()
       Optional. Type of the asset inside corpus.
      .google.cloud.visionai.v1.Corpus.Type type = 7 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getTypeValue in interface CorpusOrBuilder
      Returns:
      The enum numeric value on the wire for type.

    • getType

      public Corpus.Type getType()
       Optional. Type of the asset inside corpus.
      .google.cloud.visionai.v1.Corpus.Type type = 7 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getType in interface CorpusOrBuilder
      Returns:
      The type.

    • hasSearchCapabilitySetting

      public boolean hasSearchCapabilitySetting()
       Default search capability setting on corpus level.
      .google.cloud.visionai.v1.SearchCapabilitySetting search_capability_setting = 8;
      Specified by:
      hasSearchCapabilitySetting in interface CorpusOrBuilder
      Returns:
      Whether the searchCapabilitySetting field is set.

    • getSearchCapabilitySetting

      public SearchCapabilitySetting getSearchCapabilitySetting()
       Default search capability setting on corpus level.
      .google.cloud.visionai.v1.SearchCapabilitySetting search_capability_setting = 8;
      Specified by:
      getSearchCapabilitySetting in interface CorpusOrBuilder
      Returns:
      The searchCapabilitySetting.

    • getSearchCapabilitySettingOrBuilder

      public SearchCapabilitySettingOrBuilder getSearchCapabilitySettingOrBuilder()
       Default search capability setting on corpus level.
      .google.cloud.visionai.v1.SearchCapabilitySetting search_capability_setting = 8;
      Specified by:
      getSearchCapabilitySettingOrBuilder in interface CorpusOrBuilder

    • hasSatisfiesPzs

      public boolean hasSatisfiesPzs()
       Output only. This boolean field is only set for projects that have Physical
 Zone Separation enabled via an Org Policy constraint. It is set to true
 when the corpus is a valid zone separated corpus and false if it isn't.
      optional bool satisfies_pzs = 11 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      hasSatisfiesPzs in interface CorpusOrBuilder
      Returns:
      Whether the satisfiesPzs field is set.

    • getSatisfiesPzs

      public boolean getSatisfiesPzs()
       Output only. This boolean field is only set for projects that have Physical
 Zone Separation enabled via an Org Policy constraint. It is set to true
 when the corpus is a valid zone separated corpus and false if it isn't.
      optional bool satisfies_pzs = 11 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      getSatisfiesPzs in interface CorpusOrBuilder
      Returns:
      The satisfiesPzs.

    • hasSatisfiesPzi

      public boolean hasSatisfiesPzi()
       Output only. This boolean field is only set for projects that have Physical
 Zone Isolation enabled via an Org Policy constraint. It is set to true when
 the corpus is a valid zone isolated corpus and false if it isn't.
      optional bool satisfies_pzi = 12 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      hasSatisfiesPzi in interface CorpusOrBuilder
      Returns:
      Whether the satisfiesPzi field is set.

    • getSatisfiesPzi

      public boolean getSatisfiesPzi()
       Output only. This boolean field is only set for projects that have Physical
 Zone Isolation enabled via an Org Policy constraint. It is set to true when
 the corpus is a valid zone isolated corpus and false if it isn't.
      optional bool satisfies_pzi = 12 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      getSatisfiesPzi in interface CorpusOrBuilder
      Returns:
      The satisfiesPzi.

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseDelimitedFrom

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

    • parseDelimitedFrom

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

    • parseFrom

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

    • parseFrom

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

    • newBuilderForType

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

    • newBuilder

      public static Corpus.Builder newBuilder()

    • newBuilder

      public static Corpus.Builder newBuilder(Corpus prototype)

    • toBuilder

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

    • newBuilderForType

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

    • getDefaultInstance

      public static Corpus getDefaultInstance()

    • parser

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

    • getParserForType

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