public static final class SetAclRequest.Builder extends GeneratedMessageV3.Builder<SetAclRequest.Builder> implements SetAclRequestOrBuilderRequest message for DocumentService.SetAcl.
Protobuf type google.cloud.contentwarehouse.v1.SetAclRequest
Inheritance
Object > AbstractMessageLite.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessageV3.Builder > SetAclRequest.BuilderImplements
SetAclRequestOrBuilderStatic Methods
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()| Returns | |
|---|---|
| Type | Description |
Descriptor |
|
Methods
addRepeatedField(Descriptors.FieldDescriptor field, Object value)
public SetAclRequest.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)| Parameters | |
|---|---|
| Name | Description |
field |
FieldDescriptor |
value |
Object |
| Returns | |
|---|---|
| Type | Description |
SetAclRequest.Builder |
|
build()
public SetAclRequest build()| Returns | |
|---|---|
| Type | Description |
SetAclRequest |
|
buildPartial()
public SetAclRequest buildPartial()| Returns | |
|---|---|
| Type | Description |
SetAclRequest |
|
clear()
public SetAclRequest.Builder clear()| Returns | |
|---|---|
| Type | Description |
SetAclRequest.Builder |
|
clearField(Descriptors.FieldDescriptor field)
public SetAclRequest.Builder clearField(Descriptors.FieldDescriptor field)| Parameter | |
|---|---|
| Name | Description |
field |
FieldDescriptor |
| Returns | |
|---|---|
| Type | Description |
SetAclRequest.Builder |
|
clearOneof(Descriptors.OneofDescriptor oneof)
public SetAclRequest.Builder clearOneof(Descriptors.OneofDescriptor oneof)| Parameter | |
|---|---|
| Name | Description |
oneof |
OneofDescriptor |
| Returns | |
|---|---|
| Type | Description |
SetAclRequest.Builder |
|
clearPolicy()
public SetAclRequest.Builder clearPolicy() 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 |
SetAclRequest.Builder |
|
clearProjectOwner()
public SetAclRequest.Builder clearProjectOwner()For Set Project ACL only. Authorization check for end user will be ignored when project_owner=true.
bool project_owner = 4;
| Returns | |
|---|---|
| Type | Description |
SetAclRequest.Builder |
This builder for chaining. |
clearRequestMetadata()
public SetAclRequest.Builder clearRequestMetadata()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 |
SetAclRequest.Builder |
|
clearResource()
public SetAclRequest.Builder clearResource()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 |
SetAclRequest.Builder |
This builder for chaining. |
clone()
public SetAclRequest.Builder clone()| Returns | |
|---|---|
| Type | Description |
SetAclRequest.Builder |
|
getDefaultInstanceForType()
public SetAclRequest getDefaultInstanceForType()| Returns | |
|---|---|
| Type | Description |
SetAclRequest |
|
getDescriptorForType()
public Descriptors.Descriptor getDescriptorForType()| Returns | |
|---|---|
| Type | Description |
Descriptor |
|
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. |
getPolicyBuilder()
public Policy.Builder getPolicyBuilder() 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.Builder |
|
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. |
getRequestMetadataBuilder()
public RequestMetadata.Builder getRequestMetadataBuilder()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.Builder |
|
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. |
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. |
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()| Returns | |
|---|---|
| Type | Description |
FieldAccessorTable |
|
isInitialized()
public final boolean isInitialized()| Returns | |
|---|---|
| Type | Description |
boolean |
|
mergeFrom(SetAclRequest other)
public SetAclRequest.Builder mergeFrom(SetAclRequest other)| Parameter | |
|---|---|
| Name | Description |
other |
SetAclRequest |
| Returns | |
|---|---|
| Type | Description |
SetAclRequest.Builder |
|
mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public SetAclRequest.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)| Parameters | |
|---|---|
| Name | Description |
input |
CodedInputStream |
extensionRegistry |
ExtensionRegistryLite |
| Returns | |
|---|---|
| Type | Description |
SetAclRequest.Builder |
|
| Exceptions | |
|---|---|
| Type | Description |
IOException |
|
mergeFrom(Message other)
public SetAclRequest.Builder mergeFrom(Message other)| Parameter | |
|---|---|
| Name | Description |
other |
Message |
| Returns | |
|---|---|
| Type | Description |
SetAclRequest.Builder |
|
mergePolicy(Policy value)
public SetAclRequest.Builder mergePolicy(Policy value) 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];
| Parameter | |
|---|---|
| Name | Description |
value |
com.google.iam.v1.Policy |
| Returns | |
|---|---|
| Type | Description |
SetAclRequest.Builder |
|
mergeRequestMetadata(RequestMetadata value)
public SetAclRequest.Builder mergeRequestMetadata(RequestMetadata value)The meta information collected about the end user, used to enforce access control for the service.
.google.cloud.contentwarehouse.v1.RequestMetadata request_metadata = 3;
| Parameter | |
|---|---|
| Name | Description |
value |
RequestMetadata |
| Returns | |
|---|---|
| Type | Description |
SetAclRequest.Builder |
|
mergeUnknownFields(UnknownFieldSet unknownFields)
public final SetAclRequest.Builder mergeUnknownFields(UnknownFieldSet unknownFields)| Parameter | |
|---|---|
| Name | Description |
unknownFields |
UnknownFieldSet |
| Returns | |
|---|---|
| Type | Description |
SetAclRequest.Builder |
|
setField(Descriptors.FieldDescriptor field, Object value)
public SetAclRequest.Builder setField(Descriptors.FieldDescriptor field, Object value)| Parameters | |
|---|---|
| Name | Description |
field |
FieldDescriptor |
value |
Object |
| Returns | |
|---|---|
| Type | Description |
SetAclRequest.Builder |
|
setPolicy(Policy value)
public SetAclRequest.Builder setPolicy(Policy value) 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];
| Parameter | |
|---|---|
| Name | Description |
value |
com.google.iam.v1.Policy |
| Returns | |
|---|---|
| Type | Description |
SetAclRequest.Builder |
|
setPolicy(Policy.Builder builderForValue)
public SetAclRequest.Builder setPolicy(Policy.Builder builderForValue) 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];
| Parameter | |
|---|---|
| Name | Description |
builderForValue |
com.google.iam.v1.Policy.Builder |
| Returns | |
|---|---|
| Type | Description |
SetAclRequest.Builder |
|
setProjectOwner(boolean value)
public SetAclRequest.Builder setProjectOwner(boolean value)For Set Project ACL only. Authorization check for end user will be ignored when project_owner=true.
bool project_owner = 4;
| Parameter | |
|---|---|
| Name | Description |
value |
booleanThe projectOwner to set. |
| Returns | |
|---|---|
| Type | Description |
SetAclRequest.Builder |
This builder for chaining. |
setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
public SetAclRequest.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)| Parameters | |
|---|---|
| Name | Description |
field |
FieldDescriptor |
index |
int |
value |
Object |
| Returns | |
|---|---|
| Type | Description |
SetAclRequest.Builder |
|
setRequestMetadata(RequestMetadata value)
public SetAclRequest.Builder setRequestMetadata(RequestMetadata value)The meta information collected about the end user, used to enforce access control for the service.
.google.cloud.contentwarehouse.v1.RequestMetadata request_metadata = 3;
| Parameter | |
|---|---|
| Name | Description |
value |
RequestMetadata |
| Returns | |
|---|---|
| Type | Description |
SetAclRequest.Builder |
|
setRequestMetadata(RequestMetadata.Builder builderForValue)
public SetAclRequest.Builder setRequestMetadata(RequestMetadata.Builder builderForValue)The meta information collected about the end user, used to enforce access control for the service.
.google.cloud.contentwarehouse.v1.RequestMetadata request_metadata = 3;
| Parameter | |
|---|---|
| Name | Description |
builderForValue |
RequestMetadata.Builder |
| Returns | |
|---|---|
| Type | Description |
SetAclRequest.Builder |
|
setResource(String value)
public SetAclRequest.Builder setResource(String value)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];
| Parameter | |
|---|---|
| Name | Description |
value |
StringThe resource to set. |
| Returns | |
|---|---|
| Type | Description |
SetAclRequest.Builder |
This builder for chaining. |
setResourceBytes(ByteString value)
public SetAclRequest.Builder setResourceBytes(ByteString value)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];
| Parameter | |
|---|---|
| Name | Description |
value |
ByteStringThe bytes for resource to set. |
| Returns | |
|---|---|
| Type | Description |
SetAclRequest.Builder |
This builder for chaining. |
setUnknownFields(UnknownFieldSet unknownFields)
public final SetAclRequest.Builder setUnknownFields(UnknownFieldSet unknownFields)| Parameter | |
|---|---|
| Name | Description |
unknownFields |
UnknownFieldSet |
| Returns | |
|---|---|
| Type | Description |
SetAclRequest.Builder |
|