Query class

Submit a query to be processed in the background. If the submission of the query succeeds, the API returns a 201 status and an ID that refer to the query. In addition to the HTTP status 201, the state of "enqueued" means that the request succeeded. Note - this resource's API doesn't support deletion. When deleted, the resource will persist on Google Cloud even though it will be deleted from Pulumi state.

Constructors

Query(String name, {QueryArgs? args, CustomResourceOptions? options})

Creates a new Query. name The Pulumi resource name. args Arguments used to configure this Query. The set of arguments for Query. options Resource options controlling this resource's behavior.

Properties

childResources → Set<Resource>

final, inherited

completionSources ↔ Map<String, IOutputCompletionSource>

late, final, inherited

created ↔ Output<String>

Creation time of the query.

late, final

envgroupHostname ↔ Output<String>

Hostname is available only when query is executed at host level.

late, final

environmentId ↔ Output<String>

late, final

error ↔ Output<String>

Error is set when query fails.

late, final

executionTime ↔ Output<String>

ExecutionTime is available only after the query is completed.

late, final

hashCode → int

The hash code for this object.

no setter, inherited

id ↔ Output<String>

getter/setter pair, inherited

isCustom → bool

Returns whether this resource is provider-managed.

no setter, inherited

isProtected → bool

Returns whether this resource is protected from deletion.

no setter, inherited

isRemote → bool

Whether this resource is registered as remote.

no setter, inherited

isResourceReference → bool

Whether this instance represents a resource value returned over RPC.

final, inherited

name ↔ Output<String>

Asynchronous Query Name.

late, final

organizationId ↔ Output<String>

late, final

queryParams ↔ Output<GoogleCloudApigeeV1QueryMetadataResponse>

Contains information like metrics, dimenstions etc of the AsyncQuery.

late, final

reportDefinitionId ↔ Output<String>

Asynchronous Report ID.

late, final

resourceTransforms → List<ResourceTransform>

Inherited/explicit async transforms.

no setter, inherited

result ↔ Output<GoogleCloudApigeeV1AsyncQueryResultResponse>

Result is available only after the query is completed.

late, final

resultFileSize ↔ Output<String>

ResultFileSize is available only after the query is completed.

late, final

resultRows ↔ Output<String>

ResultRows is available only after the query is completed.

late, final

runtimeType → Type

A representation of the runtime type of the object.

no setter, inherited

self ↔ Output<String>

Self link of the query. Example: /organizations/myorg/environments/myenv/queries/9cfc0d85-0f30-46d6-ae6f-318d0cb961bd or following format if query is running at host level: /organizations/myorg/hostQueries/9cfc0d85-0f30-46d6-ae6f-318d0cb961bd

late, final

state ↔ Output<String>

Query state could be "enqueued", "running", "completed", "failed".

late, final

transformations → List<ResourceTransformation>

Inherited/explicit legacy transformations.

no setter, inherited

updated ↔ Output<String>

Last updated timestamp for the query.

late, final

urn ↔ Output<String>

late, final, inherited

Methods

failId(Object error) → void

Completes this resource ID with an error when registration fails.

inherited

failOutputs(Object error) → void

Completes all output properties with error.

inherited

failUrn(Object error) → void

Completes this resource URN with an error when registration fails.

inherited

getProvider(String moduleMember) → ProviderResource?

Returns provider for moduleMember's package, if configured.

inherited

getResourceName() → String

Returns this resource's logical name.

inherited

getResourceType() → String

Returns this resource's Pulumi type token.

inherited

noSuchMethod(Invocation invocation) → dynamic

Invoked when a nonexistent method or property is accessed.

inherited

registerOutput<T>(String propertyName, {Object? decoder(Object?)?, bool isSecret = false}) → Output<T>

Registers a dynamic output property for this resource.

inherited

resolveId(String? value, {required bool isKnown}) → void

Resolves the provider-assigned ID for this resource.

inherited

resolveOutputs(Struct outputs) → void

Resolves all output properties from a monitor response payload.

inherited

resolveUrn(String value) → void

Resolves this resource's URN once assigned by the engine.

inherited

serializeProperties(Map<String, dynamic> properties) → Future<Struct>

Serializes resource properties for RPC transmission.

inherited

toString() → String

A string representation of this object.

inherited

Operators

operator ==(Object other) → bool

The equality operator.

inherited