Class Corpus (0.33.0) 

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

Inheritance

Object > AbstractMessageLite<MessageType,BuilderType> > AbstractMessage > GeneratedMessageV3 > Corpus

Implements

CorpusOrBuilder

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

SATISFIES_PZI_FIELD_NUMBER

public static final int SATISFIES_PZI_FIELD_NUMBER
Field Value
Type Description
int

SATISFIES_PZS_FIELD_NUMBER

public static final int SATISFIES_PZS_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()
Returns
Type Description
Descriptor

newBuilder()

public static Corpus.Builder newBuilder()
Returns
Type Description
Corpus.Builder

newBuilder(Corpus prototype)

public static Corpus.Builder newBuilder(Corpus prototype)
Parameter
Name Description
prototype Corpus
Returns
Type Description
Corpus.Builder

parseDelimitedFrom(InputStream input)

public static Corpus parseDelimitedFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
Corpus
Exceptions
Type Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static Corpus parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Corpus
Exceptions
Type Description
IOException

parseFrom(byte[] data)

public static Corpus parseFrom(byte[] data)
Parameter
Name Description
data byte[]
Returns
Type Description
Corpus
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static Corpus parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data byte[]
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Corpus
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static Corpus parseFrom(ByteString data)
Parameter
Name Description
data ByteString
Returns
Type Description
Corpus
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static Corpus parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteString
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Corpus
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static Corpus parseFrom(CodedInputStream input)
Parameter
Name Description
input CodedInputStream
Returns
Type Description
Corpus
Exceptions
Type Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static Corpus parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Corpus
Exceptions
Type Description
IOException

parseFrom(InputStream input)

public static Corpus parseFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
Corpus
Exceptions
Type Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static Corpus parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Corpus
Exceptions
Type Description
IOException

parseFrom(ByteBuffer data)

public static Corpus parseFrom(ByteBuffer data)
Parameter
Name Description
data ByteBuffer
Returns
Type Description
Corpus
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static Corpus parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteBuffer
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Corpus
Exceptions
Type Description
InvalidProtocolBufferException

parser()

public static Parser<Corpus> parser()
Returns
Type Description
Parser<Corpus>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
Name Description
obj Object
Returns
Type Description
boolean
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];

Returns
Type Description
DurationOrBuilder

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()

public String 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()
Returns
Type Description
Parser<Corpus>
Overrides

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];

Returns
Type Description
boolean

The satisfiesPzi.

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];

Returns
Type Description
boolean

The satisfiesPzs.

getSearchCapabilitySetting()

public SearchCapabilitySetting getSearchCapabilitySetting()

Default search capability setting on corpus level.

.google.cloud.visionai.v1.SearchCapabilitySetting search_capability_setting = 8;

Returns
Type Description
SearchCapabilitySetting

The searchCapabilitySetting.

getSearchCapabilitySettingOrBuilder()

public SearchCapabilitySettingOrBuilder getSearchCapabilitySettingOrBuilder()

Default search capability setting on corpus level.

.google.cloud.visionai.v1.SearchCapabilitySetting search_capability_setting = 8;

Returns
Type Description
SearchCapabilitySettingOrBuilder

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];

Returns
Type Description
Corpus.Type

The type.

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.

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];

Returns
Type Description
boolean

Whether the satisfiesPzi field is set.

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];

Returns
Type Description
boolean

Whether the satisfiesPzs 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()

public int hashCode()
Returns
Type Description
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

newBuilderForType()

public Corpus.Builder newBuilderForType()
Returns
Type Description
Corpus.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected Corpus.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
Corpus.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Name Description
unused UnusedPrivateParameter
Returns
Type Description
Object
Overrides

toBuilder()

public Corpus.Builder toBuilder()
Returns
Type Description
Corpus.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
Name Description
output CodedOutputStream
Overrides
Exceptions
Type Description
IOException