sharedflows

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

Overview

Name	sharedflows
Type	Resource
Id	google.apigee.sharedflows

Fields

The following fields are returned by SELECT queries:

organizations_sharedflows_get

Successful response

Name	Datatype	Description
name	string	The ID of the shared flow.
latestRevisionId	string	The id of the most recently created revision for this shared flow.
metaData	object	Metadata describing the shared flow. (id: GoogleCloudApigeeV1EntityMetadata)
revision	array	A list of revisions of this shared flow.
space	string	Optional. The ID of the space associated with this shared flow. Any IAM policies applied to the space will control access to this shared flow. To learn how Spaces can be used to manage resources, read the Apigee Spaces Overview.

organizations_sharedflows_list

Successful response

Name	Datatype	Description
sharedFlows	array

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
organizations_sharedflows_get	select	organizationsId, sharedflowsId		Gets a shared flow by name, including a list of its revisions.
organizations_sharedflows_list	select	organizationsId	includeRevisions, includeMetaData, space	Lists all shared flows in the organization. If the resource has the space attribute set, the response may not return all resources. To learn more, read the Apigee Spaces Overview.
organizations_sharedflows_create	insert	organizationsId	action, name, space	Uploads a ZIP-formatted shared flow configuration bundle to an organization. If the shared flow already exists, this creates a new revision of it. If the shared flow does not exist, this creates it. Once imported, the shared flow revision must be deployed before it can be accessed at runtime. The size limit of a shared flow bundle is 15 MB.
organizations_sharedflows_delete	delete	organizationsId, sharedflowsId		Deletes a shared flow and all it's revisions. The shared flow must be undeployed before you can delete it.
organizations_sharedflows_move	exec	organizationsId, sharedflowsId		Moves an shared flow to a different 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
sharedflowsId	string
action	string
includeMetaData	boolean
includeRevisions	boolean
name	string
space	string

SELECT examples

organizations_sharedflows_get

Gets a shared flow by name, including a list of its revisions.

SELECT
name,
latestRevisionId,
metaData,
revision,
space
FROM google.apigee.sharedflows
WHERE organizationsId = '{{ organizationsId }}' -- required
AND sharedflowsId = '{{ sharedflowsId }}' -- required;

organizations_sharedflows_list

Lists all shared flows in the organization. If the resource has the space attribute set, the response may not return all resources. To learn more, read the Apigee Spaces Overview.

SELECT
sharedFlows
FROM google.apigee.sharedflows
WHERE organizationsId = '{{ organizationsId }}' -- required
AND includeRevisions = '{{ includeRevisions }}'
AND includeMetaData = '{{ includeMetaData }}'
AND space = '{{ space }}';

INSERT examples

organizations_sharedflows_create

Uploads a ZIP-formatted shared flow configuration bundle to an organization. If the shared flow already exists, this creates a new revision of it. If the shared flow does not exist, this creates it. Once imported, the shared flow revision must be deployed before it can be accessed at runtime. The size limit of a shared flow bundle is 15 MB.

INSERT INTO google.apigee.sharedflows (
data__contentType,
data__data,
data__extensions,
organizationsId,
action,
name,
space
)
SELECT 
'{{ contentType }}',
'{{ data }}',
'{{ extensions }}',
'{{ organizationsId }}',
'{{ action }}',
'{{ name }}',
'{{ space }}'
RETURNING
name,
configurationVersion,
contextInfo,
createdAt,
description,
displayName,
entityMetaDataAsProperties,
lastModifiedAt,
policies,
resourceFiles,
resources,
revision,
sharedFlows,
type
;

Manifest

# Description fields are for documentation purposes
- name: sharedflows
  props:
    - name: organizationsId
      value: string
      description: Required parameter for the sharedflows resource.
    - name: contentType
      value: string
      description: >
        The HTTP Content-Type header value specifying the content type of the body.
        
    - name: data
      value: string
      description: >
        The HTTP request/response body as raw binary.
        
    - name: extensions
      value: array
      description: >
        Application specific response metadata. Must be set in the first response for streaming APIs.
        
    - name: action
      value: string
    - name: name
      value: string
    - name: space
      value: string

DELETE examples

organizations_sharedflows_delete

Deletes a shared flow and all it's revisions. The shared flow must be undeployed before you can delete it.

DELETE FROM google.apigee.sharedflows
WHERE organizationsId = '{{ organizationsId }}' --required
AND sharedflowsId = '{{ sharedflowsId }}' --required;

Lifecycle Methods

organizations_sharedflows_move

Moves an shared flow to a different space.

EXEC google.apigee.sharedflows.organizations_sharedflows_move 
@organizationsId='{{ organizationsId }}' --required, 
@sharedflowsId='{{ sharedflowsId }}' --required 
@@json=
'{
"space": "{{ space }}"
}';