Send feedback
Class Corpus (0.4.0)
Stay organized with collections
Save and categorize content based on your preferences.
Version 0.4.0 keyboard_arrow_down
public final class Corpus extends GeneratedMessageV3 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
Inherited Members
com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT)
com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT,int)
com.google.protobuf.GeneratedMessageV3.<T>emptyList(java.lang.Class<T>)
com.google.protobuf.GeneratedMessageV3.internalGetMapFieldReflection(int)
Static Fields
DEFAULT_TTL_FIELD_NUMBER
public static final int DEFAULT_TTL_FIELD_NUMBER
Field Value
Type Description
int
DESCRIPTION_FIELD_NUMBER
public static final int DESCRIPTION_FIELD_NUMBER
Field Value
Type Description
int
DISPLAY_NAME_FIELD_NUMBER
public static final int DISPLAY_NAME_FIELD_NUMBER
Field Value
Type Description
int
NAME_FIELD_NUMBER
public static final int NAME_FIELD_NUMBER
Field Value
Type Description
int
SEARCH_CAPABILITY_SETTING_FIELD_NUMBER
public static final int SEARCH_CAPABILITY_SETTING_FIELD_NUMBER
Field Value
Type Description
int
TYPE_FIELD_NUMBER
public static final int TYPE_FIELD_NUMBER
Field Value
Type Description
int
Static Methods
getDefaultInstance()
public static Corpus getDefaultInstance ()
Returns
Type Description
Corpus
getDescriptor()
public static final Descriptors . Descriptor getDescriptor ()
newBuilder()
public static Corpus . Builder newBuilder ()
newBuilder(Corpus prototype)
public static Corpus . Builder newBuilder ( Corpus prototype )
Parameter
Name Description
prototypeCorpus
public static Corpus parseDelimitedFrom ( InputStream input )
Returns
Type Description
Corpus
public static Corpus parseDelimitedFrom ( InputStream input , ExtensionRegistryLite extensionRegistry )
Returns
Type Description
Corpus
parseFrom(byte[] data)
public static Corpus parseFrom ( byte [] data )
Parameter
Name Description
databyte []
Returns
Type Description
Corpus
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static Corpus parseFrom ( byte [] data , ExtensionRegistryLite extensionRegistry )
Returns
Type Description
Corpus
parseFrom(ByteString data)
public static Corpus parseFrom ( ByteString data )
Returns
Type Description
Corpus
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static Corpus parseFrom ( ByteString data , ExtensionRegistryLite extensionRegistry )
Returns
Type Description
Corpus
public static Corpus parseFrom ( CodedInputStream input )
Returns
Type Description
Corpus
public static Corpus parseFrom ( CodedInputStream input , ExtensionRegistryLite extensionRegistry )
Returns
Type Description
Corpus
public static Corpus parseFrom ( InputStream input )
Returns
Type Description
Corpus
public static Corpus parseFrom ( InputStream input , ExtensionRegistryLite extensionRegistry )
Returns
Type Description
Corpus
parseFrom(ByteBuffer data)
public static Corpus parseFrom ( ByteBuffer data )
Returns
Type Description
Corpus
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static Corpus parseFrom ( ByteBuffer data , ExtensionRegistryLite extensionRegistry )
Returns
Type Description
Corpus
parser()
public static Parser<Corpus> parser ()
Methods
equals(Object obj)
public boolean equals ( Object obj )
Parameter
Name Description
objObject
Overrides
getDefaultInstanceForType()
public Corpus getDefaultInstanceForType ()
Returns
Type Description
Corpus
getDefaultTtl()
public 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];
Returns
Type Description
Duration The defaultTtl.
getDefaultTtlOrBuilder()
public 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];
getDescription()
public String getDescription ()
Optional. Description of the corpus. Can be up to 25000 characters long.
string description = 3 [(.google.api.field_behavior) = OPTIONAL];
Returns
Type Description
String The description.
getDescriptionBytes()
public ByteString getDescriptionBytes ()
Optional. Description of the corpus. Can be up to 25000 characters long.
string description = 3 [(.google.api.field_behavior) = OPTIONAL];
Returns
Type Description
ByteString The bytes for description.
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];
Returns
Type Description
String The displayName.
getDisplayNameBytes()
public 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];
Returns
Type Description
ByteString The bytes for displayName.
getName()
Resource name of the corpus.
Format:
projects/{project_number}/locations/{location_id}/corpora/{corpus_id}
string name = 1;
Returns
Type Description
String The name.
getNameBytes()
public ByteString getNameBytes ()
Resource name of the corpus.
Format:
projects/{project_number}/locations/{location_id}/corpora/{corpus_id}
string name = 1;
Returns
Type Description
ByteString The bytes for name.
getParserForType()
public Parser<Corpus> getParserForType ()
Overrides
getSearchCapabilitySetting()
public SearchCapabilitySetting getSearchCapabilitySetting ()
Default search capability setting on corpus level.
.google.cloud.visionai.v1.SearchCapabilitySetting search_capability_setting = 8;
getSearchCapabilitySettingOrBuilder()
public SearchCapabilitySettingOrBuilder getSearchCapabilitySettingOrBuilder ()
Default search capability setting on corpus level.
.google.cloud.visionai.v1.SearchCapabilitySetting search_capability_setting = 8;
getSerializedSize()
public int getSerializedSize ()
Returns
Type Description
int
Overrides
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];
getTypeValue()
public int getTypeValue ()
Optional. Type of the asset inside corpus.
.google.cloud.visionai.v1.Corpus.Type type = 7 [(.google.api.field_behavior) = OPTIONAL];
Returns
Type Description
int The enum numeric value on the wire for type.
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];
Returns
Type Description
boolean Whether the defaultTtl field is set.
hasSearchCapabilitySetting()
public boolean hasSearchCapabilitySetting ()
Default search capability setting on corpus level.
.google.cloud.visionai.v1.SearchCapabilitySetting search_capability_setting = 8;
Returns
Type Description
boolean Whether the searchCapabilitySetting field is set.
hashCode()
Returns
Type Description
int
Overrides
internalGetFieldAccessorTable()
protected GeneratedMessageV3 . FieldAccessorTable internalGetFieldAccessorTable ()
Overrides
isInitialized()
public final boolean isInitialized ()
Overrides
newBuilderForType()
public Corpus . Builder newBuilderForType ()
newBuilderForType(GeneratedMessageV3.BuilderParent parent)
protected Corpus . Builder newBuilderForType ( GeneratedMessageV3 . BuilderParent parent )
Overrides
newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
protected Object newInstance ( GeneratedMessageV3 . UnusedPrivateParameter unused )
Returns
Type Description
Object
Overrides
toBuilder()
public Corpus . Builder toBuilder ()
writeTo(CodedOutputStream output)
public void writeTo ( CodedOutputStream output )
Overrides
Send feedback
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License , and code samples are licensed under the Apache 2.0 License . For details, see the Google Developers Site Policies . Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2025-02-14 UTC.
Need to tell us more?
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Hard to understand","hardToUnderstand","thumb-down"],["Incorrect information or sample code","incorrectInformationOrSampleCode","thumb-down"],["Missing the information/samples I need","missingTheInformationSamplesINeed","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-02-14 UTC."],[],[]]
