Class AclCreateParams.Body
-
- All Implemented Interfaces:
public final class AclCreateParams.BodyAn ACL grants a certain permission or role to a certain user or group on an object.
ACLs are inherited across the object hierarchy. So for example, if a user has read permissions on a project, they will also have read permissions on any experiment, dataset, etc. created within that project.
To restrict a grant to a particular sub-object, you may specify
restrict_object_typein the ACL, as part of a direct permission grant or as part of a role.
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description public final classAclCreateParams.Body.BuilderA builder for Body.
-
Method Summary
Modifier and Type Method Description final StringobjectId()The id of the object the ACL applies to final AclObjectTypeobjectType()The object type that the ACL applies to final Optional<String>groupId()Id of the group the ACL applies to. final Optional<Permission>permission()Permission the ACL grants. final Optional<AclObjectType>restrictObjectType()When setting a permission directly, optionally restricts the permission grant to just the specified object type. final Optional<String>roleId()Id of the role the ACL grants. final Optional<String>userId()Id of the user the ACL applies to. final JsonField<String>_objectId()Returns the raw JSON value of objectId. final JsonField<AclObjectType>_objectType()Returns the raw JSON value of objectType. final JsonField<String>_groupId()Returns the raw JSON value of groupId. final JsonField<Permission>_permission()Returns the raw JSON value of permission. final JsonField<AclObjectType>_restrictObjectType()Returns the raw JSON value of restrictObjectType. final JsonField<String>_roleId()Returns the raw JSON value of roleId. final JsonField<String>_userId()Returns the raw JSON value of userId. final Map<String, JsonValue>_additionalProperties()final AclCreateParams.Body.BuildertoBuilder()final AclCreateParams.Bodyvalidate()final BooleanisValid()Booleanequals(Object other)IntegerhashCode()StringtoString()final static AclCreateParams.Body.Builderbuilder()Returns a mutable builder for constructing an instance of Body. -
-
Method Detail
-
objectType
final AclObjectType objectType()
The object type that the ACL applies to
-
groupId
final Optional<String> groupId()
Id of the group the ACL applies to. Exactly one of
user_idandgroup_idwill be provided
-
permission
final Optional<Permission> permission()
Permission the ACL grants. Exactly one of
permissionandrole_idwill be provided
-
restrictObjectType
final Optional<AclObjectType> restrictObjectType()
When setting a permission directly, optionally restricts the permission grant to just the specified object type. Cannot be set alongside a
role_id.
-
roleId
final Optional<String> roleId()
Id of the role the ACL grants. Exactly one of
permissionandrole_idwill be provided
-
userId
final Optional<String> userId()
Id of the user the ACL applies to. Exactly one of
user_idandgroup_idwill be provided
-
_objectId
final JsonField<String> _objectId()
Returns the raw JSON value of objectId.
Unlike objectId, this method doesn't throw if the JSON field has an unexpected type.
-
_objectType
final JsonField<AclObjectType> _objectType()
Returns the raw JSON value of objectType.
Unlike objectType, this method doesn't throw if the JSON field has an unexpected type.
-
_groupId
final JsonField<String> _groupId()
Returns the raw JSON value of groupId.
Unlike groupId, this method doesn't throw if the JSON field has an unexpected type.
-
_permission
final JsonField<Permission> _permission()
Returns the raw JSON value of permission.
Unlike permission, this method doesn't throw if the JSON field has an unexpected type.
-
_restrictObjectType
final JsonField<AclObjectType> _restrictObjectType()
Returns the raw JSON value of restrictObjectType.
Unlike restrictObjectType, this method doesn't throw if the JSON field has an unexpected type.
-
_roleId
final JsonField<String> _roleId()
Returns the raw JSON value of roleId.
Unlike roleId, this method doesn't throw if the JSON field has an unexpected type.
-
_userId
final JsonField<String> _userId()
Returns the raw JSON value of userId.
Unlike userId, this method doesn't throw if the JSON field has an unexpected type.
-
_additionalProperties
final Map<String, JsonValue> _additionalProperties()
-
toBuilder
final AclCreateParams.Body.Builder toBuilder()
-
validate
final AclCreateParams.Body validate()
-
builder
final static AclCreateParams.Body.Builder builder()
Returns a mutable builder for constructing an instance of Body.
The following fields are required:
.objectId() .objectType()
-
-
-
-