datacollectors

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

Overview

Name	datacollectors
Type	Resource
Id	google.apigee.datacollectors

Fields

The following fields are returned by SELECT queries:

organizations_datacollectors_get

Successful response

Name	Datatype	Description
name	string	ID of the data collector. Must begin with dc_.
createdAt	string (int64)	Output only. The time at which the data collector was created in milliseconds since the epoch.
description	string	A description of the data collector.
lastModifiedAt	string (int64)	Output only. The time at which the Data Collector was last updated in milliseconds since the epoch.
type	string	Immutable. The type of data this data collector will collect.

organizations_datacollectors_list

Successful response

Name	Datatype	Description
name	string	ID of the data collector. Must begin with dc_.
createdAt	string (int64)	Output only. The time at which the data collector was created in milliseconds since the epoch.
description	string	A description of the data collector.
lastModifiedAt	string (int64)	Output only. The time at which the Data Collector was last updated in milliseconds since the epoch.
type	string	Immutable. The type of data this data collector will collect.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
organizations_datacollectors_get	select	organizationsId, datacollectorsId		Gets a data collector.
organizations_datacollectors_list	select	organizationsId	pageSize, pageToken	Lists all data collectors.
organizations_datacollectors_create	insert	organizationsId	dataCollectorId	Creates a new data collector.
organizations_datacollectors_patch	update	organizationsId, datacollectorsId	updateMask	Updates a data collector.
organizations_datacollectors_delete	delete	organizationsId, datacollectorsId		Deletes a data collector.

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

SELECT examples

organizations_datacollectors_get

Gets a data collector.

SELECT
name,
createdAt,
description,
lastModifiedAt,
type
FROM google.apigee.datacollectors
WHERE organizationsId = '{{ organizationsId }}' -- required
AND datacollectorsId = '{{ datacollectorsId }}' -- required;

organizations_datacollectors_list

Lists all data collectors.

SELECT
name,
createdAt,
description,
lastModifiedAt,
type
FROM google.apigee.datacollectors
WHERE organizationsId = '{{ organizationsId }}' -- required
AND pageSize = '{{ pageSize }}'
AND pageToken = '{{ pageToken }}';

INSERT examples

organizations_datacollectors_create

Creates a new data collector.

INSERT INTO google.apigee.datacollectors (
data__name,
data__description,
data__type,
organizationsId,
dataCollectorId
)
SELECT 
'{{ name }}',
'{{ description }}',
'{{ type }}',
'{{ organizationsId }}',
'{{ dataCollectorId }}'
RETURNING
name,
createdAt,
description,
lastModifiedAt,
type
;

Manifest

# Description fields are for documentation purposes
- name: datacollectors
  props:
    - name: organizationsId
      value: string
      description: Required parameter for the datacollectors resource.
    - name: name
      value: string
      description: >
        ID of the data collector. Must begin with `dc_`.
        
    - name: description
      value: string
      description: >
        A description of the data collector.
        
    - name: type
      value: string
      description: >
        Immutable. The type of data this data collector will collect.
        
      valid_values: ['TYPE_UNSPECIFIED', 'INTEGER', 'FLOAT', 'STRING', 'BOOLEAN', 'DATETIME']
    - name: dataCollectorId
      value: string

UPDATE examples

organizations_datacollectors_patch

Updates a data collector.

UPDATE google.apigee.datacollectors
SET 
data__name = '{{ name }}',
data__description = '{{ description }}',
data__type = '{{ type }}'
WHERE 
organizationsId = '{{ organizationsId }}' --required
AND datacollectorsId = '{{ datacollectorsId }}' --required
AND updateMask = '{{ updateMask}}'
RETURNING
name,
createdAt,
description,
lastModifiedAt,
type;

DELETE examples

organizations_datacollectors_delete

Deletes a data collector.

DELETE FROM google.apigee.datacollectors
WHERE organizationsId = '{{ organizationsId }}' --required
AND datacollectorsId = '{{ datacollectorsId }}' --required;