Some or all of the information on this page might not apply to Trusted Cloud by S3NS.
Class LockDocumentRequest (0.14.0)
Note: Some or all of the information on this page might not apply
to Trusted Cloud. For a list of services that are available in
Trusted Cloud, see Services available for
Trusted Cloud .
Version 0.14.0keyboard_arrow_down
public final class LockDocumentRequest extends GeneratedMessageV3 implements LockDocumentRequestOrBuilder
Request message for DocumentService.LockDocument.
Protobuf type google.cloud.contentwarehouse.v1.LockDocumentRequest
Inherited Members
com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT)
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 ()
getDescriptor()
public static final Descriptors . Descriptor getDescriptor ()
newBuilder()
public static LockDocumentRequest . Builder newBuilder ()
newBuilder(LockDocumentRequest prototype)
public static LockDocumentRequest . Builder newBuilder ( LockDocumentRequest prototype )
parseDelimitedFrom(InputStream input)
public static LockDocumentRequest parseDelimitedFrom ( InputStream input )
parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
public static LockDocumentRequest parseDelimitedFrom ( InputStream input , ExtensionRegistryLite extensionRegistry )
parseFrom(byte[] data)
public static LockDocumentRequest parseFrom ( byte [] data )
Parameter
Name
Description
data
byte []
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static LockDocumentRequest parseFrom ( byte [] data , ExtensionRegistryLite extensionRegistry )
parseFrom(ByteString data)
public static LockDocumentRequest parseFrom ( ByteString data )
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static LockDocumentRequest parseFrom ( ByteString data , ExtensionRegistryLite extensionRegistry )
parseFrom(CodedInputStream input)
public static LockDocumentRequest parseFrom ( CodedInputStream input )
parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public static LockDocumentRequest parseFrom ( CodedInputStream input , ExtensionRegistryLite extensionRegistry )
parseFrom(InputStream input)
public static LockDocumentRequest parseFrom ( InputStream input )
parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
public static LockDocumentRequest parseFrom ( InputStream input , ExtensionRegistryLite extensionRegistry )
parseFrom(ByteBuffer data)
public static LockDocumentRequest parseFrom ( ByteBuffer data )
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static LockDocumentRequest parseFrom ( ByteBuffer data , ExtensionRegistryLite extensionRegistry )
parser()
public static Parser<LockDocumentRequest> parser ()
Methods
equals(Object obj)
public boolean equals ( Object obj )
Parameter
Name
Description
obj
Object
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 ()
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;
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 ()
Overrides
getSerializedSize()
public int getSerializedSize ()
Returns
Type
Description
int
Overrides
getUnknownFields()
public final UnknownFieldSet getUnknownFields ()
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()
Returns
Type
Description
int
Overrides
internalGetFieldAccessorTable()
protected GeneratedMessageV3 . FieldAccessorTable internalGetFieldAccessorTable ()
Overrides
isInitialized()
public final boolean isInitialized ()
Overrides
newBuilderForType()
public LockDocumentRequest . Builder newBuilderForType ()
newBuilderForType(GeneratedMessageV3.BuilderParent parent)
protected LockDocumentRequest . Builder newBuilderForType ( GeneratedMessageV3 . BuilderParent parent )
Overrides
newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
protected Object newInstance ( GeneratedMessageV3 . UnusedPrivateParameter unused )
Returns
Type
Description
Object
Overrides
toBuilder()
public LockDocumentRequest . Builder toBuilder ()
writeTo(CodedOutputStream output)
public void writeTo ( CodedOutputStream output )
Overrides
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-08-04 UTC.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Missing the information I need","missingTheInformationINeed","thumb-down"],["Too complicated / too many steps","tooComplicatedTooManySteps","thumb-down"],["Out of date","outOfDate","thumb-down"],["Samples / code issue","samplesCodeIssue","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-08-04 UTC."],[],[]]