Class LockDocumentRequest (0.43.0) 

public final class LockDocumentRequest extends GeneratedMessageV3 implements LockDocumentRequestOrBuilder

Request message for DocumentService.LockDocument.

Protobuf type google.cloud.contentwarehouse.v1.LockDocumentRequest

Inheritance

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

Static Fields

COLLECTION_ID_FIELD_NUMBER

public static final int COLLECTION_ID_FIELD_NUMBER
Field Value
Type Description
int

LOCKING_USER_FIELD_NUMBER

public static final int LOCKING_USER_FIELD_NUMBER
Field Value
Type Description
int

NAME_FIELD_NUMBER

public static final int NAME_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static LockDocumentRequest getDefaultInstance()
Returns
Type Description
LockDocumentRequest

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
Type Description
Descriptor

newBuilder()

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

newBuilder(LockDocumentRequest prototype)

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

parseDelimitedFrom(InputStream input)

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

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(byte[] data)

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

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteString data)

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

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(CodedInputStream input)

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

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(InputStream input)

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

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteBuffer data)

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

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

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

parser()

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

Methods

equals(Object obj)

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

getCollectionId()

public String getCollectionId()

The collection the document connects to.

string collection_id = 2;

Returns
Type Description
String

The collectionId.

getCollectionIdBytes()

public ByteString getCollectionIdBytes()

The collection the document connects to.

string collection_id = 2;

Returns
Type Description
ByteString

The bytes for collectionId.

getDefaultInstanceForType()

public LockDocumentRequest getDefaultInstanceForType()
Returns
Type Description
LockDocumentRequest

getLockingUser()

public UserInfo getLockingUser()

The user information who locks the document.

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

Returns
Type Description
UserInfo

The lockingUser.

getLockingUserOrBuilder()

public UserInfoOrBuilder getLockingUserOrBuilder()

The user information who locks the document.

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

Returns
Type Description
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
Type Description
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
Type Description
ByteString

The bytes for name.

getParserForType()

public Parser<LockDocumentRequest> getParserForType()
Returns
Type Description
Parser<LockDocumentRequest>
Overrides

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

hasLockingUser()

public boolean hasLockingUser()

The user information who locks the document.

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

Returns
Type Description
boolean

Whether the lockingUser 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 LockDocumentRequest.Builder newBuilderForType()
Returns
Type Description
LockDocumentRequest.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

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

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

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

toBuilder()

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

writeTo(CodedOutputStream output)

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