Class DocumentLink (0.38.0)

public final class DocumentLink extends GeneratedMessageV3 implements DocumentLinkOrBuilder

A document-link between source and target document.

Protobuf type google.cloud.contentwarehouse.v1.DocumentLink

Static Fields

public static final int CREATE_TIME_FIELD_NUMBER
Field Value
Type Description
int
public static final int DESCRIPTION_FIELD_NUMBER
Field Value
Type Description
int
public static final int NAME_FIELD_NUMBER
Field Value
Type Description
int
public static final int SOURCE_DOCUMENT_REFERENCE_FIELD_NUMBER
Field Value
Type Description
int
public static final int STATE_FIELD_NUMBER
Field Value
Type Description
int
public static final int TARGET_DOCUMENT_REFERENCE_FIELD_NUMBER
Field Value
Type Description
int
public static final int UPDATE_TIME_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

public static DocumentLink getDefaultInstance()
Returns
Type Description
DocumentLink
public static final Descriptors.Descriptor getDescriptor()
Returns
Type Description
Descriptor
public static DocumentLink.Builder newBuilder()
Returns
Type Description
DocumentLink.Builder
public static DocumentLink.Builder newBuilder(DocumentLink prototype)
Parameter
Name Description
prototype DocumentLink
Returns
Type Description
DocumentLink.Builder
public static DocumentLink parseDelimitedFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
DocumentLink
Exceptions
Type Description
IOException
public static DocumentLink parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
DocumentLink
Exceptions
Type Description
IOException
public static DocumentLink parseFrom(byte[] data)
Parameter
Name Description
data byte[]
Returns
Type Description
DocumentLink
Exceptions
Type Description
InvalidProtocolBufferException
public static DocumentLink parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data byte[]
extensionRegistry ExtensionRegistryLite
Returns
Type Description
DocumentLink
Exceptions
Type Description
InvalidProtocolBufferException
public static DocumentLink parseFrom(ByteString data)
Parameter
Name Description
data ByteString
Returns
Type Description
DocumentLink
Exceptions
Type Description
InvalidProtocolBufferException
public static DocumentLink parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteString
extensionRegistry ExtensionRegistryLite
Returns
Type Description
DocumentLink
Exceptions
Type Description
InvalidProtocolBufferException
public static DocumentLink parseFrom(CodedInputStream input)
Parameter
Name Description
input CodedInputStream
Returns
Type Description
DocumentLink
Exceptions
Type Description
IOException
public static DocumentLink parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
DocumentLink
Exceptions
Type Description
IOException
public static DocumentLink parseFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
DocumentLink
Exceptions
Type Description
IOException
public static DocumentLink parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
DocumentLink
Exceptions
Type Description
IOException
public static DocumentLink parseFrom(ByteBuffer data)
Parameter
Name Description
data ByteBuffer
Returns
Type Description
DocumentLink
Exceptions
Type Description
InvalidProtocolBufferException
public static DocumentLink parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteBuffer
extensionRegistry ExtensionRegistryLite
Returns
Type Description
DocumentLink
Exceptions
Type Description
InvalidProtocolBufferException
public static Parser<DocumentLink> parser()
Returns
Type Description
Parser<DocumentLink>

Methods

public boolean equals(Object obj)
Parameter
Name Description
obj Object
Returns
Type Description
boolean
Overrides
public Timestamp getCreateTime()

Output only. The time when the documentLink is created.

.google.protobuf.Timestamp create_time = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
Timestamp

The createTime.

public TimestampOrBuilder getCreateTimeOrBuilder()

Output only. The time when the documentLink is created.

.google.protobuf.Timestamp create_time = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
TimestampOrBuilder
public DocumentLink getDefaultInstanceForType()
Returns
Type Description
DocumentLink
public String getDescription()

Description of this document-link.

string description = 4;

Returns
Type Description
String

The description.

public ByteString getDescriptionBytes()

Description of this document-link.

string description = 4;

Returns
Type Description
ByteString

The bytes for description.

public String getName()

Name of this document-link. It is required that the parent derived form the name to be consistent with the source document reference. Otherwise an exception will be thrown. Format: projects/{project_number}/locations/{location}/documents/{source_document_id}/documentLinks/{document_link_id}.

string name = 1;

Returns
Type Description
String

The name.

public ByteString getNameBytes()

Name of this document-link. It is required that the parent derived form the name to be consistent with the source document reference. Otherwise an exception will be thrown. Format: projects/{project_number}/locations/{location}/documents/{source_document_id}/documentLinks/{document_link_id}.

string name = 1;

Returns
Type Description
ByteString

The bytes for name.

public Parser<DocumentLink> getParserForType()
Returns
Type Description
Parser<DocumentLink>
Overrides
public int getSerializedSize()
Returns
Type Description
int
Overrides
public DocumentReference getSourceDocumentReference()

Document references of the source document.

.google.cloud.contentwarehouse.v1.DocumentReference source_document_reference = 2;

Returns
Type Description
DocumentReference

The sourceDocumentReference.

public DocumentReferenceOrBuilder getSourceDocumentReferenceOrBuilder()

Document references of the source document.

.google.cloud.contentwarehouse.v1.DocumentReference source_document_reference = 2;

Returns
Type Description
DocumentReferenceOrBuilder
public DocumentLink.State getState()

The state of the documentlink. If target node has been deleted, the link is marked as invalid. Removing a source node will result in removal of all associated links.

.google.cloud.contentwarehouse.v1.DocumentLink.State state = 7;

Returns
Type Description
DocumentLink.State

The state.

public int getStateValue()

The state of the documentlink. If target node has been deleted, the link is marked as invalid. Removing a source node will result in removal of all associated links.

.google.cloud.contentwarehouse.v1.DocumentLink.State state = 7;

Returns
Type Description
int

The enum numeric value on the wire for state.

public DocumentReference getTargetDocumentReference()

Document references of the target document.

.google.cloud.contentwarehouse.v1.DocumentReference target_document_reference = 3;

Returns
Type Description
DocumentReference

The targetDocumentReference.

public DocumentReferenceOrBuilder getTargetDocumentReferenceOrBuilder()

Document references of the target document.

.google.cloud.contentwarehouse.v1.DocumentReference target_document_reference = 3;

Returns
Type Description
DocumentReferenceOrBuilder
public Timestamp getUpdateTime()

Output only. The time when the documentLink is last updated.

.google.protobuf.Timestamp update_time = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
Timestamp

The updateTime.

public TimestampOrBuilder getUpdateTimeOrBuilder()

Output only. The time when the documentLink is last updated.

.google.protobuf.Timestamp update_time = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
TimestampOrBuilder
public boolean hasCreateTime()

Output only. The time when the documentLink is created.

.google.protobuf.Timestamp create_time = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
boolean

Whether the createTime field is set.

public boolean hasSourceDocumentReference()

Document references of the source document.

.google.cloud.contentwarehouse.v1.DocumentReference source_document_reference = 2;

Returns
Type Description
boolean

Whether the sourceDocumentReference field is set.

public boolean hasTargetDocumentReference()

Document references of the target document.

.google.cloud.contentwarehouse.v1.DocumentReference target_document_reference = 3;

Returns
Type Description
boolean

Whether the targetDocumentReference field is set.

public boolean hasUpdateTime()

Output only. The time when the documentLink is last updated.

.google.protobuf.Timestamp update_time = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
boolean

Whether the updateTime field is set.

public int hashCode()
Returns
Type Description
int
Overrides
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides
public final boolean isInitialized()
Returns
Type Description
boolean
Overrides
public DocumentLink.Builder newBuilderForType()
Returns
Type Description
DocumentLink.Builder
protected DocumentLink.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
DocumentLink.Builder
Overrides
protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Name Description
unused UnusedPrivateParameter
Returns
Type Description
Object
Overrides
public DocumentLink.Builder toBuilder()
Returns
Type Description
DocumentLink.Builder
public void writeTo(CodedOutputStream output)
Parameter
Name Description
output CodedOutputStream
Overrides
Exceptions
Type Description
IOException