Package com.google.cloud.contentwarehouse.v1

Class SetAclRequest

  • All Implemented Interfaces:
    SetAclRequestOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable
    public final class SetAclRequest
extends com.google.protobuf.GeneratedMessageV3
implements SetAclRequestOrBuilder
     Request message for DocumentService.SetAcl.
    Protobuf type google.cloud.contentwarehouse.v1.SetAclRequest
    See Also:
    Serialized Form

    • Nested Class Summary

      Nested Classes 
      Modifier and Type Class Description
      static class  SetAclRequest.Builder
      Request message for DocumentService.SetAcl.

      • Nested classes/interfaces inherited from class com.google.protobuf.GeneratedMessageV3

        com.google.protobuf.GeneratedMessageV3.BuilderParent, com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>,​BuilderT extends com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT,​BuilderT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessageOrBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.FieldAccessorTable, com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter

      • Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessageLite

        com.google.protobuf.AbstractMessageLite.InternalOneOfEnum

    • Method Detail

      • newInstance

        protected Object newInstance​(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
        Overrides:
        newInstance in class com.google.protobuf.GeneratedMessageV3

      • getDescriptor

        public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()

      • internalGetFieldAccessorTable

        protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
        Specified by:
        internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3

      • 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];
        Specified by:
        getResource in interface SetAclRequestOrBuilder
        Returns:
        The resource.

      • getResourceBytes

        public com.google.protobuf.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];
        Specified by:
        getResourceBytes in interface SetAclRequestOrBuilder
        Returns:
        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];
        Specified by:
        hasPolicy in interface SetAclRequestOrBuilder
        Returns:
        Whether the policy field is set.

      • getPolicy

        public com.google.iam.v1.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];
        Specified by:
        getPolicy in interface SetAclRequestOrBuilder
        Returns:
        The policy.

      • getPolicyOrBuilder

        public com.google.iam.v1.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];
        Specified by:
        getPolicyOrBuilder in interface SetAclRequestOrBuilder

      • 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;
        Specified by:
        hasRequestMetadata in interface SetAclRequestOrBuilder
        Returns:
        Whether the requestMetadata field is set.

      • 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;
        Specified by:
        getRequestMetadata in interface SetAclRequestOrBuilder
        Returns:
        The requestMetadata.

      • 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;
        Specified by:
        getProjectOwner in interface SetAclRequestOrBuilder
        Returns:
        The projectOwner.

      • isInitialized

        public final boolean isInitialized()
        Specified by:
        isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
        Overrides:
        isInitialized in class com.google.protobuf.GeneratedMessageV3

      • writeTo

        public void writeTo​(com.google.protobuf.CodedOutputStream output)
             throws IOException
        Specified by:
        writeTo in interface com.google.protobuf.MessageLite
        Overrides:
        writeTo in class com.google.protobuf.GeneratedMessageV3
        Throws:
        IOException

      • getSerializedSize

        public int getSerializedSize()
        Specified by:
        getSerializedSize in interface com.google.protobuf.MessageLite
        Overrides:
        getSerializedSize in class com.google.protobuf.GeneratedMessageV3

      • equals

        public boolean equals​(Object obj)
        Specified by:
        equals in interface com.google.protobuf.Message
        Overrides:
        equals in class com.google.protobuf.AbstractMessage

      • hashCode

        public int hashCode()
        Specified by:
        hashCode in interface com.google.protobuf.Message
        Overrides:
        hashCode in class com.google.protobuf.AbstractMessage

      • parseFrom

        public static SetAclRequest parseFrom​(ByteBuffer data)
                               throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static SetAclRequest parseFrom​(ByteBuffer data,
                                      com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                               throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static SetAclRequest parseFrom​(com.google.protobuf.ByteString data)
                               throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static SetAclRequest parseFrom​(com.google.protobuf.ByteString data,
                                      com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                               throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static SetAclRequest parseFrom​(byte[] data)
                               throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static SetAclRequest parseFrom​(byte[] data,
                                      com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                               throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static SetAclRequest parseFrom​(com.google.protobuf.CodedInputStream input,
                                      com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                               throws IOException
        Throws:
        IOException

      • newBuilderForType

        public SetAclRequest.Builder newBuilderForType()
        Specified by:
        newBuilderForType in interface com.google.protobuf.Message
        Specified by:
        newBuilderForType in interface com.google.protobuf.MessageLite

      • toBuilder

        public SetAclRequest.Builder toBuilder()
        Specified by:
        toBuilder in interface com.google.protobuf.Message
        Specified by:
        toBuilder in interface com.google.protobuf.MessageLite

      • newBuilderForType

        protected SetAclRequest.Builder newBuilderForType​(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
        Specified by:
        newBuilderForType in class com.google.protobuf.GeneratedMessageV3

      • getDefaultInstance

        public static SetAclRequest getDefaultInstance()

      • parser

        public static com.google.protobuf.Parser<SetAclRequest> parser()

      • getParserForType

        public com.google.protobuf.Parser<SetAclRequest> getParserForType()
        Specified by:
        getParserForType in interface com.google.protobuf.Message
        Specified by:
        getParserForType in interface com.google.protobuf.MessageLite
        Overrides:
        getParserForType in class com.google.protobuf.GeneratedMessageV3

      • getDefaultInstanceForType

        public SetAclRequest getDefaultInstanceForType()
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder