🎯API Stability
Long-TermThis API is stable and will remain supported across versions with minimal breaking changes.

Summary

The testGcsAction() mutation tests a Google Cloud Storage (GCS) action configuration by sending sample event data to the specified GCS bucket without saving the action.

Syntax

graphql
testGcsAction(
      input: TestGcsAction!
   ): TestResult!

This mutation accepts a TestGcsAction input object and returns a TestResult! object with the outcome of the test.

Input Parameters

The mutation accepts a single TestGcsAction input object. The following table describes the available fields:

Table: TestGcsAction Input

ParameterTypeRequiredDefaultStabilityAvailabilityDescription
bucketNameStringyes  added in 1.259Name of the bucket.
eventDataStringyes  added in 1.259JSON data representing zero or more events. One event can be supplied as a JSON object. Multiple events must be supplied as a list of JSON objects.
fileNameStringyes  added in 1.259Name of the file(s). You can use most message templates for this. See documentation for GCS action: https://library.humio.com/data-analysis/automated-actions-gcs.html.
nameStringyes  added in 1.259Name of the action.
outputFormatCloudStorageActionEventOutputFormatyes  added in 1.259Output format type for the result. Can be either NDJSON or CSV.
outputMetadataBooleanyes  added in 1.259Whether to output metadata for the result. Metadata will be output as a separate JSON file.
projectIdStringyes  added in 1.259The GCP project ID.
serviceAccountEmailStringyes  added in 1.259The email of the GCP service account to impersonate.
triggerNameStringyes  added in 1.259Name of the action. This is a mock value, the trigger does not have to exist.
useProxyBooleanyes  added in 1.259Defines whether the action should use the configured HTTP proxy to send requests.
viewNameRepoOrViewNameyes  added in 1.259Name of the view of the action.

Returned Values

The mutation returns a TestResult! object. The following table lists the available fields:

Table: TestResult Datatype

ParameterTypeRequiredDefaultStabilityAvailabilityDescription
messageStringyes Long-Term A message explaining the test result.
successBooleanyes Long-Term True if the test was a success, false otherwise.