resourcefiles

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

Overview

Name	resourcefiles
Type	Resource
Id	google.apigee.resourcefiles

Fields

The following fields are returned by SELECT queries:

organizations_environments_resourcefiles_get

Successful response

Name	Datatype	Description
contentType	string	The HTTP Content-Type header value specifying the content type of the body.
data	string (byte)	The HTTP request/response body as raw binary.
extensions	array	Application specific response metadata. Must be set in the first response for streaming APIs.

organizations_environments_resourcefiles_list_environment_resources

Successful response

Name	Datatype	Description
resourceFile	array	List of resources files.

organizations_environments_resourcefiles_list

Successful response

Name	Datatype	Description
resourceFile	array	List of resources files.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
organizations_environments_resourcefiles_get	select	organizationsId, environmentsId, type, name		Gets the contents of a resource file. For more information about resource files, see Resource files.
organizations_environments_resourcefiles_list_environment_resources	select	organizationsId, environmentsId, type		Lists all resource files, optionally filtering by type. For more information about resource files, see Resource files.
organizations_environments_resourcefiles_list	select	organizationsId, environmentsId	type	Lists all resource files, optionally filtering by type. For more information about resource files, see Resource files.
organizations_environments_resourcefiles_create	insert	organizationsId, environmentsId	type, name	Creates a resource file. Specify the Content-Type as application/octet-stream or multipart/form-data. For more information about resource files, see Resource files.
organizations_environments_resourcefiles_update	replace	organizationsId, environmentsId, type, name		Updates a resource file. Specify the Content-Type as application/octet-stream or multipart/form-data. For more information about resource files, see Resource files.
organizations_environments_resourcefiles_delete	delete	organizationsId, environmentsId, type, name		Deletes a resource file. For more information about resource files, see Resource files.

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
environmentsId	string
name	string
organizationsId	string
type	string
name	string
type	string

SELECT examples

organizations_environments_resourcefiles_get

Gets the contents of a resource file. For more information about resource files, see Resource files.

SELECT
contentType,
data,
extensions
FROM google.apigee.resourcefiles
WHERE organizationsId = '{{ organizationsId }}' -- required
AND environmentsId = '{{ environmentsId }}' -- required
AND type = '{{ type }}' -- required
AND name = '{{ name }}' -- required;

organizations_environments_resourcefiles_list_environment_resources

Lists all resource files, optionally filtering by type. For more information about resource files, see Resource files.

SELECT
resourceFile
FROM google.apigee.resourcefiles
WHERE organizationsId = '{{ organizationsId }}' -- required
AND environmentsId = '{{ environmentsId }}' -- required
AND type = '{{ type }}' -- required;

organizations_environments_resourcefiles_list

Lists all resource files, optionally filtering by type. For more information about resource files, see Resource files.

SELECT
resourceFile
FROM google.apigee.resourcefiles
WHERE organizationsId = '{{ organizationsId }}' -- required
AND environmentsId = '{{ environmentsId }}' -- required
AND type = '{{ type }}';

INSERT examples

organizations_environments_resourcefiles_create

Creates a resource file. Specify the Content-Type as application/octet-stream or multipart/form-data. For more information about resource files, see Resource files.

INSERT INTO google.apigee.resourcefiles (
data__contentType,
data__data,
data__extensions,
organizationsId,
environmentsId,
type,
name
)
SELECT 
'{{ contentType }}',
'{{ data }}',
'{{ extensions }}',
'{{ organizationsId }}',
'{{ environmentsId }}',
'{{ type }}',
'{{ name }}'
RETURNING
name,
type
;

Manifest

# Description fields are for documentation purposes
- name: resourcefiles
  props:
    - name: organizationsId
      value: string
      description: Required parameter for the resourcefiles resource.
    - name: environmentsId
      value: string
      description: Required parameter for the resourcefiles 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: type
      value: string
    - name: name
      value: string

REPLACE examples

organizations_environments_resourcefiles_update

Updates a resource file. Specify the Content-Type as application/octet-stream or multipart/form-data. For more information about resource files, see Resource files.

REPLACE google.apigee.resourcefiles
SET 
data__contentType = '{{ contentType }}',
data__data = '{{ data }}',
data__extensions = '{{ extensions }}'
WHERE 
organizationsId = '{{ organizationsId }}' --required
AND environmentsId = '{{ environmentsId }}' --required
AND type = '{{ type }}' --required
AND name = '{{ name }}' --required
RETURNING
name,
type;

DELETE examples

organizations_environments_resourcefiles_delete

Deletes a resource file. For more information about resource files, see Resource files.

DELETE FROM google.apigee.resourcefiles
WHERE organizationsId = '{{ organizationsId }}' --required
AND environmentsId = '{{ environmentsId }}' --required
AND type = '{{ type }}' --required
AND name = '{{ name }}' --required;