Class SetAclRequest (0.41.0)

public final class SetAclRequest extends GeneratedMessageV3 implements SetAclRequestOrBuilder

Request message for DocumentService.SetAcl.

Protobuf type google.cloud.contentwarehouse.v1.SetAclRequest

Static Fields

POLICY_FIELD_NUMBER

public static final int POLICY_FIELD_NUMBER
Field Value
Type Description
int

PROJECT_OWNER_FIELD_NUMBER

public static final int PROJECT_OWNER_FIELD_NUMBER
Field Value
Type Description
int

REQUEST_METADATA_FIELD_NUMBER

public static final int REQUEST_METADATA_FIELD_NUMBER
Field Value
Type Description
int

RESOURCE_FIELD_NUMBER

public static final int RESOURCE_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static SetAclRequest getDefaultInstance()
Returns
Type Description
SetAclRequest

getDescriptor()

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

newBuilder()

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

newBuilder(SetAclRequest prototype)

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

parseDelimitedFrom(InputStream input)

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

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(byte[] data)

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

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteString data)

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

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(CodedInputStream input)

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

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(InputStream input)

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

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteBuffer data)

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

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

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

parser()

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

Methods

equals(Object obj)

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

getDefaultInstanceForType()

public SetAclRequest getDefaultInstanceForType()
Returns
Type Description
SetAclRequest

getParserForType()

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

getPolicy()

public Policy getPolicy()

Required. REQUIRED: The complete policy to be applied to the resource. The size of the policy is limited to a few 10s of KB. This refers to an Identity and Access (IAM) policy, which specifies access controls for the Document.

You can set ACL with condition for projects only.

Supported operators are: =, !=, <, <=, >, and >= where the left of the operator is DocumentSchemaId or property name and the right of the operator is a number or a quoted string. You must escape backslash (\\) and quote (\") characters.

Boolean expressions (AND/OR) are supported up to 3 levels of nesting (for example, "((A AND B AND C) OR D) AND E"), a maximum of 10 comparisons are allowed in the expression. The expression must be < 6000 bytes in length.

Sample condition: "DocumentSchemaId = \"some schema id\" OR SchemaId.floatPropertyName >= 10"

.google.iam.v1.Policy policy = 2 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
com.google.iam.v1.Policy

The policy.

getPolicyOrBuilder()

public PolicyOrBuilder getPolicyOrBuilder()

Required. REQUIRED: The complete policy to be applied to the resource. The size of the policy is limited to a few 10s of KB. This refers to an Identity and Access (IAM) policy, which specifies access controls for the Document.

You can set ACL with condition for projects only.

Supported operators are: =, !=, <, <=, >, and >= where the left of the operator is DocumentSchemaId or property name and the right of the operator is a number or a quoted string. You must escape backslash (\\) and quote (\") characters.

Boolean expressions (AND/OR) are supported up to 3 levels of nesting (for example, "((A AND B AND C) OR D) AND E"), a maximum of 10 comparisons are allowed in the expression. The expression must be < 6000 bytes in length.

Sample condition: "DocumentSchemaId = \"some schema id\" OR SchemaId.floatPropertyName >= 10"

.google.iam.v1.Policy policy = 2 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
com.google.iam.v1.PolicyOrBuilder

getProjectOwner()

public boolean getProjectOwner()

For Set Project ACL only. Authorization check for end user will be ignored when project_owner=true.

bool project_owner = 4;

Returns
Type Description
boolean

The projectOwner.

getRequestMetadata()

public RequestMetadata getRequestMetadata()

The meta information collected about the end user, used to enforce access control for the service.

.google.cloud.contentwarehouse.v1.RequestMetadata request_metadata = 3;

Returns
Type Description
RequestMetadata

The requestMetadata.

getRequestMetadataOrBuilder()

public RequestMetadataOrBuilder getRequestMetadataOrBuilder()

The meta information collected about the end user, used to enforce access control for the service.

.google.cloud.contentwarehouse.v1.RequestMetadata request_metadata = 3;

Returns
Type Description
RequestMetadataOrBuilder

getResource()

public String getResource()

Required. REQUIRED: The resource for which the policy is being requested. Format for document: projects/{project_number}/locations/{location}/documents/{document_id}. Format for collection: projects/{project_number}/locations/{location}/collections/{collection_id}. Format for project: projects/{project_number}.

string resource = 1 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
String

The resource.

getResourceBytes()

public ByteString getResourceBytes()

Required. REQUIRED: The resource for which the policy is being requested. Format for document: projects/{project_number}/locations/{location}/documents/{document_id}. Format for collection: projects/{project_number}/locations/{location}/collections/{collection_id}. Format for project: projects/{project_number}.

string resource = 1 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
ByteString

The bytes for resource.

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

hasPolicy()

public boolean hasPolicy()

Required. REQUIRED: The complete policy to be applied to the resource. The size of the policy is limited to a few 10s of KB. This refers to an Identity and Access (IAM) policy, which specifies access controls for the Document.

You can set ACL with condition for projects only.

Supported operators are: =, !=, <, <=, >, and >= where the left of the operator is DocumentSchemaId or property name and the right of the operator is a number or a quoted string. You must escape backslash (\\) and quote (\") characters.

Boolean expressions (AND/OR) are supported up to 3 levels of nesting (for example, "((A AND B AND C) OR D) AND E"), a maximum of 10 comparisons are allowed in the expression. The expression must be < 6000 bytes in length.

Sample condition: "DocumentSchemaId = \"some schema id\" OR SchemaId.floatPropertyName >= 10"

.google.iam.v1.Policy policy = 2 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
boolean

Whether the policy field is set.

hasRequestMetadata()

public boolean hasRequestMetadata()

The meta information collected about the end user, used to enforce access control for the service.

.google.cloud.contentwarehouse.v1.RequestMetadata request_metadata = 3;

Returns
Type Description
boolean

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

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

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

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

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

toBuilder()

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

writeTo(CodedOutputStream output)

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