spaces

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

Overview

Name	spaces
Type	Resource
Id	google.apigee.spaces

Fields

The following fields are returned by SELECT queries:

organizations_spaces_get

Successful response

Name	Datatype	Description
name	string	Output only. Identifier. Id of the space. This field is used as the resource name, and must follow AIP-122 guidelines.
createTime	string (google-datetime)	Output only. Create timestamp of the space.
displayName	string	Optional. Display name of the space.
updateTime	string (google-datetime)	Output only. Last modified timestamp of the space.

organizations_spaces_list

Successful response

Name	Datatype	Description
name	string	Output only. Identifier. Id of the space. This field is used as the resource name, and must follow AIP-122 guidelines.
createTime	string (google-datetime)	Output only. Create timestamp of the space.
displayName	string	Optional. Display name of the space.
updateTime	string (google-datetime)	Output only. Last modified timestamp of the space.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
organizations_spaces_get	select	organizationsId, spacesId		Get a space under an Organization.
organizations_spaces_list	select	organizationsId	pageSize, pageToken	Lists spaces under an organization.
organizations_spaces_create	insert	organizationsId	spaceId	Create a space under an organization.
organizations_spaces_patch	update	organizationsId, spacesId	updateMask	Updates a space.
organizations_spaces_delete	delete	organizationsId, spacesId		Deletes an organization space.

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
organizationsId	string
spacesId	string
pageSize	integer (int32)
pageToken	string
spaceId	string
updateMask	string (google-fieldmask)

SELECT examples

organizations_spaces_get

Get a space under an Organization.

SELECT
name,
createTime,
displayName,
updateTime
FROM google.apigee.spaces
WHERE organizationsId = '{{ organizationsId }}' -- required
AND spacesId = '{{ spacesId }}' -- required;

organizations_spaces_list

Lists spaces under an organization.

SELECT
name,
createTime,
displayName,
updateTime
FROM google.apigee.spaces
WHERE organizationsId = '{{ organizationsId }}' -- required
AND pageSize = '{{ pageSize }}'
AND pageToken = '{{ pageToken }}';

INSERT examples

organizations_spaces_create

Create a space under an organization.

INSERT INTO google.apigee.spaces (
data__displayName,
organizationsId,
spaceId
)
SELECT 
'{{ displayName }}',
'{{ organizationsId }}',
'{{ spaceId }}'
RETURNING
name,
createTime,
displayName,
updateTime
;

Manifest

# Description fields are for documentation purposes
- name: spaces
  props:
    - name: organizationsId
      value: string
      description: Required parameter for the spaces resource.
    - name: displayName
      value: string
      description: >
        Optional. Display name of the space.
        
    - name: spaceId
      value: string

UPDATE examples

organizations_spaces_patch

Updates a space.

UPDATE google.apigee.spaces
SET 
data__displayName = '{{ displayName }}'
WHERE 
organizationsId = '{{ organizationsId }}' --required
AND spacesId = '{{ spacesId }}' --required
AND updateMask = '{{ updateMask}}'
RETURNING
name,
createTime,
displayName,
updateTime;

DELETE examples

organizations_spaces_delete

Deletes an organization space.

DELETE FROM google.apigee.spaces
WHERE organizationsId = '{{ organizationsId }}' --required
AND spacesId = '{{ spacesId }}' --required;