envgroups

Creates, updates, deletes, gets or lists an envgroups resource.

Overview

Name	envgroups
Type	Resource
Id	google.apigee.envgroups

Fields

The following fields are returned by SELECT queries:

organizations_envgroups_get

Successful response

Name	Datatype	Description
name	string	ID of the environment group.
createdAt	string (int64)	Output only. The time at which the environment group was created as milliseconds since epoch.
hostnames	array	Required. Host names for this environment group.
lastModifiedAt	string (int64)	Output only. The time at which the environment group was last updated as milliseconds since epoch.
state	string	Output only. State of the environment group. Values other than ACTIVE means the resource is not ready to use.

organizations_envgroups_list

Successful response

Name	Datatype	Description
name	string	ID of the environment group.
createdAt	string (int64)	Output only. The time at which the environment group was created as milliseconds since epoch.
hostnames	array	Required. Host names for this environment group.
lastModifiedAt	string (int64)	Output only. The time at which the environment group was last updated as milliseconds since epoch.
state	string	Output only. State of the environment group. Values other than ACTIVE means the resource is not ready to use.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
organizations_envgroups_get	select	organizationsId, envgroupsId		Gets an environment group.
organizations_envgroups_list	select	organizationsId	pageSize, pageToken	Lists all environment groups.
organizations_envgroups_create	insert	organizationsId	name	Creates a new environment group.
organizations_envgroups_patch	update	organizationsId, envgroupsId	updateMask	Updates an environment group.
organizations_envgroups_delete	delete	organizationsId, envgroupsId		Deletes an environment group.

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

SELECT examples

organizations_envgroups_get

Gets an environment group.

SELECT
name,
createdAt,
hostnames,
lastModifiedAt,
state
FROM google.apigee.envgroups
WHERE organizationsId = '{{ organizationsId }}' -- required
AND envgroupsId = '{{ envgroupsId }}' -- required;

organizations_envgroups_list

Lists all environment groups.

SELECT
name,
createdAt,
hostnames,
lastModifiedAt,
state
FROM google.apigee.envgroups
WHERE organizationsId = '{{ organizationsId }}' -- required
AND pageSize = '{{ pageSize }}'
AND pageToken = '{{ pageToken }}';

INSERT examples

organizations_envgroups_create

Creates a new environment group.

INSERT INTO google.apigee.envgroups (
data__name,
data__hostnames,
organizationsId,
name
)
SELECT 
'{{ name }}',
'{{ hostnames }}',
'{{ organizationsId }}',
'{{ name }}'
RETURNING
name,
done,
error,
metadata,
response
;

Manifest

# Description fields are for documentation purposes
- name: envgroups
  props:
    - name: organizationsId
      value: string
      description: Required parameter for the envgroups resource.
    - name: name
      value: string
      description: >
        ID of the environment group.
        
    - name: hostnames
      value: array
      description: >
        Required. Host names for this environment group.
        
    - name: name
      value: string

UPDATE examples

organizations_envgroups_patch

Updates an environment group.

UPDATE google.apigee.envgroups
SET 
data__name = '{{ name }}',
data__hostnames = '{{ hostnames }}'
WHERE 
organizationsId = '{{ organizationsId }}' --required
AND envgroupsId = '{{ envgroupsId }}' --required
AND updateMask = '{{ updateMask}}'
RETURNING
name,
done,
error,
metadata,
response;

DELETE examples

organizations_envgroups_delete

Deletes an environment group.

DELETE FROM google.apigee.envgroups
WHERE organizationsId = '{{ organizationsId }}' --required
AND envgroupsId = '{{ envgroupsId }}' --required;