overrides

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

Overview

Name	overrides
Type	Resource
Id	google.apigee.overrides

Fields

The following fields are returned by SELECT queries:

organizations_environments_trace_config_overrides_get

Name	Datatype	Description
name	string	ID of the trace configuration override specified as a system-generated UUID.
apiProxy	string	ID of the API proxy that will have its trace configuration overridden.
samplingConfig	object	Trace configuration to override. (id: GoogleCloudApigeeV1TraceSamplingConfig)

organizations_environments_trace_config_overrides_list

Name	Datatype	Description
name	string	ID of the trace configuration override specified as a system-generated UUID.
apiProxy	string	ID of the API proxy that will have its trace configuration overridden.
samplingConfig	object	Trace configuration to override. (id: GoogleCloudApigeeV1TraceSamplingConfig)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
organizations_environments_trace_config_overrides_get	select	organizationsId, environmentsId, overridesId		Gets a trace configuration override.
organizations_environments_trace_config_overrides_list	select	organizationsId, environmentsId	pageSize, pageToken	Lists all of the distributed trace configuration overrides in an environment.
organizations_environments_trace_config_overrides_create	insert	organizationsId, environmentsId		Creates a trace configuration override. The response contains a system-generated UUID, that can be used to view, update, or delete the configuration override. Use the List API to view the existing trace configuration overrides.
organizations_environments_trace_config_overrides_patch	update	organizationsId, environmentsId, overridesId	updateMask	Updates a distributed trace configuration override. Note that the repeated fields have replace semantics when included in the field mask and that they will be overwritten by the value of the fields in the request body.
organizations_environments_trace_config_overrides_delete	delete	organizationsId, environmentsId, overridesId		Deletes a distributed trace configuration override.

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

SELECT examples

organizations_environments_trace_config_overrides_get

Gets a trace configuration override.

SELECT
name,
apiProxy,
samplingConfig
FROM google.apigee.overrides
WHERE organizationsId = '{{ organizationsId }}' -- required
AND environmentsId = '{{ environmentsId }}' -- required
AND overridesId = '{{ overridesId }}' -- required
;

organizations_environments_trace_config_overrides_list

Lists all of the distributed trace configuration overrides in an environment.

SELECT
name,
apiProxy,
samplingConfig
FROM google.apigee.overrides
WHERE organizationsId = '{{ organizationsId }}' -- required
AND environmentsId = '{{ environmentsId }}' -- required
AND pageSize = '{{ pageSize }}'
AND pageToken = '{{ pageToken }}'
;

INSERT examples

organizations_environments_trace_config_overrides_create

Creates a trace configuration override. The response contains a system-generated UUID, that can be used to view, update, or delete the configuration override. Use the List API to view the existing trace configuration overrides.

INSERT INTO google.apigee.overrides (
data__apiProxy,
data__name,
data__samplingConfig,
organizationsId,
environmentsId
)
SELECT 
'{{ apiProxy }}',
'{{ name }}',
'{{ samplingConfig }}',
'{{ organizationsId }}',
'{{ environmentsId }}'
RETURNING
name,
apiProxy,
samplingConfig
;

Manifest

# Description fields are for documentation purposes
- name: overrides
props:
  - name: organizationsId
    value: "{{ organizationsId }}"
    description: Required parameter for the overrides resource.
  - name: environmentsId
    value: "{{ environmentsId }}"
    description: Required parameter for the overrides resource.
  - name: apiProxy
    value: "{{ apiProxy }}"
    description: |
      ID of the API proxy that will have its trace configuration overridden.
  - name: name
    value: "{{ name }}"
    description: |
      ID of the trace configuration override specified as a system-generated UUID.
  - name: samplingConfig
    description: |
      Trace configuration to override.
    value:
      sampler: "{{ sampler }}"
      samplingRate: {{ samplingRate }}

UPDATE examples

organizations_environments_trace_config_overrides_patch

Updates a distributed trace configuration override. Note that the repeated fields have replace semantics when included in the field mask and that they will be overwritten by the value of the fields in the request body.

UPDATE google.apigee.overrides
SET 
data__apiProxy = '{{ apiProxy }}',
data__name = '{{ name }}',
data__samplingConfig = '{{ samplingConfig }}'
WHERE 
organizationsId = '{{ organizationsId }}' --required
AND environmentsId = '{{ environmentsId }}' --required
AND overridesId = '{{ overridesId }}' --required
AND updateMask = '{{ updateMask}}'
RETURNING
name,
apiProxy,
samplingConfig;

DELETE examples

organizations_environments_trace_config_overrides_delete

Deletes a distributed trace configuration override.

DELETE FROM google.apigee.overrides
WHERE organizationsId = '{{ organizationsId }}' --required
AND environmentsId = '{{ environmentsId }}' --required
AND overridesId = '{{ overridesId }}' --required
;