Class LockDocumentRequest.Builder (0.27.0)

public static final class LockDocumentRequest.Builder extends GeneratedMessageV3.Builder<LockDocumentRequest.Builder> implements LockDocumentRequestOrBuilder

Request message for DocumentService.LockDocument.

Protobuf type google.cloud.contentwarehouse.v1.LockDocumentRequest

Static Methods

getDescriptor()

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

Methods

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public LockDocumentRequest.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
NameDescription
fieldFieldDescriptor
valueObject
Returns
TypeDescription
LockDocumentRequest.Builder
Overrides

build()

public LockDocumentRequest build()
Returns
TypeDescription
LockDocumentRequest

buildPartial()

public LockDocumentRequest buildPartial()
Returns
TypeDescription
LockDocumentRequest

clear()

public LockDocumentRequest.Builder clear()
Returns
TypeDescription
LockDocumentRequest.Builder
Overrides

clearCollectionId()

public LockDocumentRequest.Builder clearCollectionId()

The collection the document connects to.

string collection_id = 2;

Returns
TypeDescription
LockDocumentRequest.Builder

This builder for chaining.

clearField(Descriptors.FieldDescriptor field)

public LockDocumentRequest.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
NameDescription
fieldFieldDescriptor
Returns
TypeDescription
LockDocumentRequest.Builder
Overrides

clearLockingUser()

public LockDocumentRequest.Builder clearLockingUser()

The user information who locks the document.

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

Returns
TypeDescription
LockDocumentRequest.Builder

clearName()

public LockDocumentRequest.Builder clearName()

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
LockDocumentRequest.Builder

This builder for chaining.

clearOneof(Descriptors.OneofDescriptor oneof)

public LockDocumentRequest.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
NameDescription
oneofOneofDescriptor
Returns
TypeDescription
LockDocumentRequest.Builder
Overrides

clone()

public LockDocumentRequest.Builder clone()
Returns
TypeDescription
LockDocumentRequest.Builder
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

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
TypeDescription
Descriptor
Overrides

getLockingUser()

public UserInfo getLockingUser()

The user information who locks the document.

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

Returns
TypeDescription
UserInfo

The lockingUser.

getLockingUserBuilder()

public UserInfo.Builder getLockingUserBuilder()

The user information who locks the document.

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

Returns
TypeDescription
UserInfo.Builder

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.

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.

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
TypeDescription
boolean
Overrides

mergeFrom(LockDocumentRequest other)

public LockDocumentRequest.Builder mergeFrom(LockDocumentRequest other)
Parameter
NameDescription
otherLockDocumentRequest
Returns
TypeDescription
LockDocumentRequest.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public LockDocumentRequest.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputCodedInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
LockDocumentRequest.Builder
Overrides
Exceptions
TypeDescription
IOException

mergeFrom(Message other)

public LockDocumentRequest.Builder mergeFrom(Message other)
Parameter
NameDescription
otherMessage
Returns
TypeDescription
LockDocumentRequest.Builder
Overrides

mergeLockingUser(UserInfo value)

public LockDocumentRequest.Builder mergeLockingUser(UserInfo value)

The user information who locks the document.

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

Parameter
NameDescription
valueUserInfo
Returns
TypeDescription
LockDocumentRequest.Builder

mergeUnknownFields(UnknownFieldSet unknownFields)

public final LockDocumentRequest.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
NameDescription
unknownFieldsUnknownFieldSet
Returns
TypeDescription
LockDocumentRequest.Builder
Overrides

setCollectionId(String value)

public LockDocumentRequest.Builder setCollectionId(String value)

The collection the document connects to.

string collection_id = 2;

Parameter
NameDescription
valueString

The collectionId to set.

Returns
TypeDescription
LockDocumentRequest.Builder

This builder for chaining.

setCollectionIdBytes(ByteString value)

public LockDocumentRequest.Builder setCollectionIdBytes(ByteString value)

The collection the document connects to.

string collection_id = 2;

Parameter
NameDescription
valueByteString

The bytes for collectionId to set.

Returns
TypeDescription
LockDocumentRequest.Builder

This builder for chaining.

setField(Descriptors.FieldDescriptor field, Object value)

public LockDocumentRequest.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
NameDescription
fieldFieldDescriptor
valueObject
Returns
TypeDescription
LockDocumentRequest.Builder
Overrides

setLockingUser(UserInfo value)

public LockDocumentRequest.Builder setLockingUser(UserInfo value)

The user information who locks the document.

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

Parameter
NameDescription
valueUserInfo
Returns
TypeDescription
LockDocumentRequest.Builder

setLockingUser(UserInfo.Builder builderForValue)

public LockDocumentRequest.Builder setLockingUser(UserInfo.Builder builderForValue)

The user information who locks the document.

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

Parameter
NameDescription
builderForValueUserInfo.Builder
Returns
TypeDescription
LockDocumentRequest.Builder

setName(String value)

public LockDocumentRequest.Builder setName(String value)

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) = { ... }

Parameter
NameDescription
valueString

The name to set.

Returns
TypeDescription
LockDocumentRequest.Builder

This builder for chaining.

setNameBytes(ByteString value)

public LockDocumentRequest.Builder setNameBytes(ByteString value)

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) = { ... }

Parameter
NameDescription
valueByteString

The bytes for name to set.

Returns
TypeDescription
LockDocumentRequest.Builder

This builder for chaining.

setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

public LockDocumentRequest.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Parameters
NameDescription
fieldFieldDescriptor
indexint
valueObject
Returns
TypeDescription
LockDocumentRequest.Builder
Overrides

setUnknownFields(UnknownFieldSet unknownFields)

public final LockDocumentRequest.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
NameDescription
unknownFieldsUnknownFieldSet
Returns
TypeDescription
LockDocumentRequest.Builder
Overrides