public sealed class UriOverride : IMessage<UriOverride>, IEquatable<UriOverride>, IDeepCloneable<UriOverride>, IBufferMessage, IMessageReference documentation and code samples for the Google Cloud Tasks v2beta3 API class UriOverride.
URI Override.
When specified, all the HTTP tasks inside the queue will be partially or fully overridden depending on the configured values.
Implements
IMessageUriOverride, IEquatableUriOverride, IDeepCloneableUriOverride, IBufferMessage, IMessageNamespace
Google.Cloud.Tasks.V2Beta3Assembly
Google.Cloud.Tasks.V2Beta3.dll
Constructors
UriOverride()
public UriOverride()UriOverride(UriOverride)
public UriOverride(UriOverride other)| Parameter | |
|---|---|
| Name | Description |
other |
UriOverride |
Properties
HasHost
public bool HasHost { get; }Gets whether the "host" field is set
| Property Value | |
|---|---|
| Type | Description |
bool |
|
HasPort
public bool HasPort { get; }Gets whether the "port" field is set
| Property Value | |
|---|---|
| Type | Description |
bool |
|
HasScheme
public bool HasScheme { get; }Gets whether the "scheme" field is set
| Property Value | |
|---|---|
| Type | Description |
bool |
|
Host
public string Host { get; set; }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).
| Property Value | |
|---|---|
| Type | Description |
string |
|
PathOverride
public PathOverride PathOverride { get; set; }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.
| Property Value | |
|---|---|
| Type | Description |
PathOverride |
|
Port
public long Port { get; set; }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.
| Property Value | |
|---|---|
| Type | Description |
long |
|
QueryOverride
public QueryOverride QueryOverride { get; set; }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.
| Property Value | |
|---|---|
| Type | Description |
QueryOverride |
|
Scheme
public UriOverride.Types.Scheme Scheme { get; set; }Scheme override.
When specified, the task URI scheme is replaced by the provided value (HTTP or HTTPS).
| Property Value | |
|---|---|
| Type | Description |
UriOverrideTypesScheme |
|
UriOverrideEnforceMode
public UriOverride.Types.UriOverrideEnforceMode UriOverrideEnforceMode { get; set; }URI Override Enforce Mode
When specified, determines the Target UriOverride mode. If not specified, it defaults to ALWAYS.
| Property Value | |
|---|---|
| Type | Description |
UriOverrideTypesUriOverrideEnforceMode |
|