Interface UriOverrideOrBuilder (2.31.0)

Version 2.31.0

• 2.53.0 (latest)
• 2.52.0
• 2.51.0
• 2.49.0
• 2.48.0
• 2.47.0
• 2.46.0
• 2.45.0
• 2.44.0
• 2.43.0
• 2.42.0
• 2.41.0
• 2.40.0
• 2.39.0
• 2.37.0
• 2.36.0
• 2.35.0
• 2.34.0
• 2.33.0
• 2.32.0
• 2.31.0
• 2.30.0
• 2.29.0
• 2.28.0
• 2.27.0
• 2.24.0
• 2.23.0
• 2.22.0
• 2.21.0
• 2.20.0
• 2.19.0
• 2.18.0
• 2.17.0
• 2.16.0
• 2.15.0
• 2.14.0
• 2.13.0
• 2.12.0
• 2.11.0
• 2.9.0
• 2.8.0
• 2.7.0
• 2.6.0
• 2.5.0
• 2.4.0
• 2.3.12
• 2.2.0
• 2.1.11

public interface UriOverrideOrBuilder extends MessageOrBuilder

Implements

MessageOrBuilder

Methods

getHost()

public abstract String getHost()

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).

optional string host = 2;

Returns
Type	Description
String	The host.

getHostBytes()

public abstract ByteString getHostBytes()

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).

optional string host = 2;

Returns
Type	Description
ByteString	The bytes for host.

getPathOverride()

public abstract PathOverride getPathOverride()

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.

.google.cloud.tasks.v2beta2.PathOverride path_override = 4;

Returns
Type	Description
PathOverride	The pathOverride.

getPathOverrideOrBuilder()

public abstract PathOverrideOrBuilder getPathOverrideOrBuilder()

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.

.google.cloud.tasks.v2beta2.PathOverride path_override = 4;

Returns
Type	Description
PathOverrideOrBuilder

getPort()

public abstract long getPort()

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.

optional int64 port = 3;

Returns
Type	Description
long	The port.

getQueryOverride()

public abstract QueryOverride getQueryOverride()

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.

.google.cloud.tasks.v2beta2.QueryOverride query_override = 5;

Returns
Type	Description
QueryOverride	The queryOverride.

getQueryOverrideOrBuilder()

public abstract QueryOverrideOrBuilder getQueryOverrideOrBuilder()

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.

.google.cloud.tasks.v2beta2.QueryOverride query_override = 5;

Returns
Type	Description
QueryOverrideOrBuilder

getScheme()

public abstract UriOverride.Scheme getScheme()

Scheme override.

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

optional .google.cloud.tasks.v2beta2.UriOverride.Scheme scheme = 1;

Returns
Type	Description
UriOverride.Scheme	The scheme.

getSchemeValue()

public abstract int getSchemeValue()

Scheme override.

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

optional .google.cloud.tasks.v2beta2.UriOverride.Scheme scheme = 1;

Returns
Type	Description
int	The enum numeric value on the wire for scheme.

getUriOverrideEnforceMode()

public abstract UriOverride.UriOverrideEnforceMode getUriOverrideEnforceMode()

URI Override Enforce Mode

When specified, determines the Target UriOverride mode. If not specified, it defaults to ALWAYS.

.google.cloud.tasks.v2beta2.UriOverride.UriOverrideEnforceMode uri_override_enforce_mode = 6;

Returns
Type	Description
UriOverride.UriOverrideEnforceMode	The uriOverrideEnforceMode.

getUriOverrideEnforceModeValue()

public abstract int getUriOverrideEnforceModeValue()

URI Override Enforce Mode

When specified, determines the Target UriOverride mode. If not specified, it defaults to ALWAYS.

.google.cloud.tasks.v2beta2.UriOverride.UriOverrideEnforceMode uri_override_enforce_mode = 6;

Returns
Type	Description
int	The enum numeric value on the wire for uriOverrideEnforceMode.

hasHost()

public abstract boolean hasHost()

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).

optional string host = 2;

Returns
Type	Description
boolean	Whether the host field is set.

hasPathOverride()

public abstract boolean hasPathOverride()

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.

.google.cloud.tasks.v2beta2.PathOverride path_override = 4;

Returns
Type	Description
boolean	Whether the pathOverride field is set.

hasPort()

public abstract boolean hasPort()

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.

optional int64 port = 3;

Returns
Type	Description
boolean	Whether the port field is set.

hasQueryOverride()

public abstract boolean hasQueryOverride()

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.

.google.cloud.tasks.v2beta2.QueryOverride query_override = 5;

Returns
Type	Description
boolean	Whether the queryOverride field is set.

hasScheme()

public abstract boolean hasScheme()

Scheme override.

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

optional .google.cloud.tasks.v2beta2.UriOverride.Scheme scheme = 1;

Returns
Type	Description
boolean	Whether the scheme field is set.