permissions

Creates, updates, deletes, gets or lists a permissions resource.

Overview

Name	permissions
Type	Resource
Id	gemini.corpora.permissions

Fields

The following fields are returned by SELECT queries:

get

Name	Datatype	Description
name	string	Output only. Identifier. The permission name. A unique name will be generated on create. Examples: tunedModels/{tuned_model}/permissions/{permission} corpora/{corpus}/permissions/{permission} Output only.
emailAddress	string	Optional. Immutable. The email address of the user of group which this permission refers. Field is not set when permission's grantee type is EVERYONE.
granteeType	string	Optional. Immutable. The type of the grantee. (GRANTEE_TYPE_UNSPECIFIED, USER, GROUP, EVERYONE)
role	string	Required. The role granted by this permission. (ROLE_UNSPECIFIED, OWNER, WRITER, READER)

list

Name	Datatype	Description
name	string	Output only. Identifier. The permission name. A unique name will be generated on create. Examples: tunedModels/{tuned_model}/permissions/{permission} corpora/{corpus}/permissions/{permission} Output only.
emailAddress	string	Optional. Immutable. The email address of the user of group which this permission refers. Field is not set when permission's grantee type is EVERYONE.
granteeType	string	Optional. Immutable. The type of the grantee. (GRANTEE_TYPE_UNSPECIFIED, USER, GROUP, EVERYONE)
role	string	Required. The role granted by this permission. (ROLE_UNSPECIFIED, OWNER, WRITER, READER)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	corporaId, permissionsId		Gets information about a specific Permission.
list	select	corporaId		Lists permissions for the specific resource.
create	insert	corporaId		Create a permission to a specific resource.
patch	update	corporaId, permissionsId	updateMask	Updates the permission.
delete	delete	corporaId, permissionsId		Deletes the permission.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
corporaId	string
permissionsId	string
updateMask	string (google-fieldmask)	Required. The list of fields to update. Accepted ones: - role (Permission.role field)

SELECT examples

get

Gets information about a specific Permission.

SELECT
name,
emailAddress,
granteeType,
role
FROM gemini.corpora.permissions
WHERE corporaId = '{{ corporaId }}' -- required
AND permissionsId = '{{ permissionsId }}' -- required
;

list

Lists permissions for the specific resource.

SELECT
name,
emailAddress,
granteeType,
role
FROM gemini.corpora.permissions
WHERE corporaId = '{{ corporaId }}' -- required
;

INSERT examples

create

Create a permission to a specific resource.

INSERT INTO gemini.corpora.permissions (
emailAddress,
granteeType,
role,
corporaId
)
SELECT 
'{{ emailAddress }}',
'{{ granteeType }}',
'{{ role }}',
'{{ corporaId }}'
RETURNING
name,
emailAddress,
granteeType,
role
;

Manifest

# Description fields are for documentation purposes
- name: permissions
props:
  - name: corporaId
    value: "{{ corporaId }}"
    description: Required parameter for the permissions resource.
  - name: emailAddress
    value: "{{ emailAddress }}"
    description: |
      Optional. Immutable. The email address of the user of group which this permission refers. Field is not set when permission's grantee type is EVERYONE.
  - name: granteeType
    value: "{{ granteeType }}"
    description: |
      Optional. Immutable. The type of the grantee.
    valid_values: ['GRANTEE_TYPE_UNSPECIFIED', 'USER', 'GROUP', 'EVERYONE']
  - name: role
    value: "{{ role }}"
    description: |
      Required. The role granted by this permission.
    valid_values: ['ROLE_UNSPECIFIED', 'OWNER', 'WRITER', 'READER']

UPDATE examples

patch

Updates the permission.

UPDATE gemini.corpora.permissions
SET 
emailAddress = '{{ emailAddress }}',
granteeType = '{{ granteeType }}',
role = '{{ role }}'
WHERE 
corporaId = '{{ corporaId }}' --required
WHERE permissionsId = '{{ permissionsId }}' --required
AND updateMask = '{{ updateMask}}'
RETURNING
name,
emailAddress,
granteeType,
role;

DELETE examples

delete

Deletes the permission.

DELETE FROM gemini.corpora.permissions
WHERE corporaId = '{{ corporaId }}' --required
AND permissionsId = '{{ permissionsId }}' --required
;