Package com.google.cloud.contentwarehouse.v1

Interface SetAclRequestOrBuilder

  • All Superinterfaces:
    com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder
    All Known Implementing Classes:
    SetAclRequest, SetAclRequest.Builder
    public interface SetAclRequestOrBuilder
extends com.google.protobuf.MessageOrBuilder

    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      com.google.iam.v1.Policy getPolicy()
      Required.
      com.google.iam.v1.PolicyOrBuilder getPolicyOrBuilder()
      Required.
      boolean getProjectOwner()
      For Set Project ACL only.
      RequestMetadata getRequestMetadata()
      The meta information collected about the end user, used to enforce access control for the service.
      RequestMetadataOrBuilder getRequestMetadataOrBuilder()
      The meta information collected about the end user, used to enforce access control for the service.
      String getResource()
      Required.
      com.google.protobuf.ByteString getResourceBytes()
      Required.
      boolean hasPolicy()
      Required.
      boolean hasRequestMetadata()
      The meta information collected about the end user, used to enforce access control for the service.

      • Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder

        isInitialized

      • Methods inherited from interface com.google.protobuf.MessageOrBuilder

        findInitializationErrors, getAllFields, getDefaultInstanceForType, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

    • Method Detail

      • getResource

        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:
        The resource.

      • getResourceBytes

        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];
        Returns:
        The bytes for resource.

      • hasPolicy

        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:
        Whether the policy field is set.

      • getPolicy

        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];
        Returns:
        The policy.

      • getPolicyOrBuilder

        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];

      • hasRequestMetadata

        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:
        Whether the requestMetadata field is set.

      • getRequestMetadata

        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:
        The requestMetadata.

      • getRequestMetadataOrBuilder

        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;

      • getProjectOwner

        boolean getProjectOwner()
         For Set Project ACL only. Authorization check for end user will be ignored
 when project_owner=true.
        bool project_owner = 4;
        Returns:
        The projectOwner.