UriOverride

import type { UriOverride } from "https://googleapis.deno.dev/v1/cloudtasks:v2.ts";

URI Override. When specified, all the HTTP tasks inside the queue will be partially or fully overridden depending on the configured values.

interface UriOverride {

host?: string;

pathOverride?: PathOverride;

port?: bigint;

queryOverride?: QueryOverride;

scheme?: "SCHEME_UNSPECIFIED" | "HTTP" | "HTTPS";

uriOverrideEnforceMode?: "URI_OVERRIDE_ENFORCE_MODE_UNSPECIFIED" | "IF_NOT_EXISTS" | "ALWAYS";

}

§Properties

host?: string

[src]

Host override. When specified, replaces the host part of the task URL. For example, if the task URL is "https://www.google.com," and host value is set to "example.net", the overridden URI will be changed to "https://example.net." Host value cannot be an empty string (INVALID_ARGUMENT).

pathOverride?: PathOverride

[src]

URI path. When specified, replaces the existing path of the task URL. Setting the path value to an empty string clears the URI path segment.

port?: bigint

[src]

Port override. When specified, replaces the port part of the task URI. For instance, for a URI http://www.google.com/foo and port=123, the overridden URI becomes http://www.google.com:123/foo. Note that the port value must be a positive integer. Setting the port to 0 (Zero) clears the URI port.

queryOverride?: QueryOverride

[src]

URI query. When specified, replaces the query part of the task URI. Setting the query value to an empty string clears the URI query segment.

scheme?: "SCHEME_UNSPECIFIED" | "HTTP" | "HTTPS"

[src]

Scheme override. When specified, the task URI scheme is replaced by the provided value (HTTP or HTTPS).

uriOverrideEnforceMode?: "URI_OVERRIDE_ENFORCE_MODE_UNSPECIFIED" | "IF_NOT_EXISTS" | "ALWAYS"

[src]

URI Override Enforce Mode When specified, determines the Target UriOverride mode. If not specified, it defaults to ALWAYS.