Class LockDocumentRequest (0.31.0)

public final class LockDocumentRequest extends GeneratedMessageV3 implements LockDocumentRequestOrBuilder

Request message for DocumentService.LockDocument.

Protobuf type google.cloud.contentwarehouse.v1.LockDocumentRequest

Static Fields

COLLECTION_ID_FIELD_NUMBER

public static final int COLLECTION_ID_FIELD_NUMBER
Field Value
TypeDescription
int

LOCKING_USER_FIELD_NUMBER

public static final int LOCKING_USER_FIELD_NUMBER
Field Value
TypeDescription
int

NAME_FIELD_NUMBER

public static final int NAME_FIELD_NUMBER
Field Value
TypeDescription
int

Static Methods

getDefaultInstance()

public static LockDocumentRequest getDefaultInstance()
Returns
TypeDescription
LockDocumentRequest

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
TypeDescription
Descriptor

newBuilder()

public static LockDocumentRequest.Builder newBuilder()
Returns
TypeDescription
LockDocumentRequest.Builder

newBuilder(LockDocumentRequest prototype)

public static LockDocumentRequest.Builder newBuilder(LockDocumentRequest prototype)
Parameter
NameDescription
prototypeLockDocumentRequest
Returns
TypeDescription
LockDocumentRequest.Builder

parseDelimitedFrom(InputStream input)

public static LockDocumentRequest parseDelimitedFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
LockDocumentRequest
Exceptions
TypeDescription
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static LockDocumentRequest parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
LockDocumentRequest
Exceptions
TypeDescription
IOException

parseFrom(byte[] data)

public static LockDocumentRequest parseFrom(byte[] data)
Parameter
NameDescription
databyte[]
Returns
TypeDescription
LockDocumentRequest
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static LockDocumentRequest parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
databyte[]
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
LockDocumentRequest
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data)

public static LockDocumentRequest parseFrom(ByteString data)
Parameter
NameDescription
dataByteString
Returns
TypeDescription
LockDocumentRequest
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static LockDocumentRequest parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteString
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
LockDocumentRequest
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static LockDocumentRequest parseFrom(CodedInputStream input)
Parameter
NameDescription
inputCodedInputStream
Returns
TypeDescription
LockDocumentRequest
Exceptions
TypeDescription
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static LockDocumentRequest parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputCodedInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
LockDocumentRequest
Exceptions
TypeDescription
IOException

parseFrom(InputStream input)

public static LockDocumentRequest parseFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
LockDocumentRequest
Exceptions
TypeDescription
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static LockDocumentRequest parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
LockDocumentRequest
Exceptions
TypeDescription
IOException

parseFrom(ByteBuffer data)

public static LockDocumentRequest parseFrom(ByteBuffer data)
Parameter
NameDescription
dataByteBuffer
Returns
TypeDescription
LockDocumentRequest
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static LockDocumentRequest parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteBuffer
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
LockDocumentRequest
Exceptions
TypeDescription
InvalidProtocolBufferException

parser()

public static Parser<LockDocumentRequest> parser()
Returns
TypeDescription
Parser<LockDocumentRequest>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
NameDescription
objObject
Returns
TypeDescription
boolean
Overrides

getCollectionId()

public String getCollectionId()

The collection the document connects to.

string collection_id = 2;

Returns
TypeDescription
String

The collectionId.

getCollectionIdBytes()

public ByteString getCollectionIdBytes()

The collection the document connects to.

string collection_id = 2;

Returns
TypeDescription
ByteString

The bytes for collectionId.

getDefaultInstanceForType()

public LockDocumentRequest getDefaultInstanceForType()
Returns
TypeDescription
LockDocumentRequest

getLockingUser()

public UserInfo getLockingUser()

The user information who locks the document.

.google.cloud.contentwarehouse.v1.UserInfo locking_user = 3;

Returns
TypeDescription
UserInfo

The lockingUser.

getLockingUserOrBuilder()

public UserInfoOrBuilder getLockingUserOrBuilder()

The user information who locks the document.

.google.cloud.contentwarehouse.v1.UserInfo locking_user = 3;

Returns
TypeDescription
UserInfoOrBuilder

getName()

public String getName()

Required. The name of the document to lock. Format: projects/{project_number}/locations/{location}/documents/{document}.

string name = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }

Returns
TypeDescription
String

The name.

getNameBytes()

public ByteString getNameBytes()

Required. The name of the document to lock. Format: projects/{project_number}/locations/{location}/documents/{document}.

string name = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }

Returns
TypeDescription
ByteString

The bytes for name.

getParserForType()

public Parser<LockDocumentRequest> getParserForType()
Returns
TypeDescription
Parser<LockDocumentRequest>
Overrides

getSerializedSize()

public int getSerializedSize()
Returns
TypeDescription
int
Overrides

hasLockingUser()

public boolean hasLockingUser()

The user information who locks the document.

.google.cloud.contentwarehouse.v1.UserInfo locking_user = 3;

Returns
TypeDescription
boolean

Whether the lockingUser field is set.

hashCode()

public int hashCode()
Returns
TypeDescription
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
TypeDescription
boolean
Overrides

newBuilderForType()

public LockDocumentRequest.Builder newBuilderForType()
Returns
TypeDescription
LockDocumentRequest.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected LockDocumentRequest.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
NameDescription
parentBuilderParent
Returns
TypeDescription
LockDocumentRequest.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
NameDescription
unusedUnusedPrivateParameter
Returns
TypeDescription
Object
Overrides

toBuilder()

public LockDocumentRequest.Builder toBuilder()
Returns
TypeDescription
LockDocumentRequest.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
NameDescription
outputCodedOutputStream
Overrides
Exceptions
TypeDescription
IOException