Class UriOverride.Builder (2.48.0)

public static final class UriOverride.Builder extends GeneratedMessageV3.Builder<UriOverride.Builder> implements UriOverrideOrBuilder

URI Override.

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

Protobuf type google.cloud.tasks.v2beta3.UriOverride

Static Methods

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
Type Description
Descriptor

Methods

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public UriOverride.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
UriOverride.Builder
Overrides

build()

public UriOverride build()
Returns
Type Description
UriOverride

buildPartial()

public UriOverride buildPartial()
Returns
Type Description
UriOverride

clear()

public UriOverride.Builder clear()
Returns
Type Description
UriOverride.Builder
Overrides

clearField(Descriptors.FieldDescriptor field)

public UriOverride.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
Name Description
field FieldDescriptor
Returns
Type Description
UriOverride.Builder
Overrides

clearHost()

public UriOverride.Builder clearHost()

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
UriOverride.Builder

This builder for chaining.

clearOneof(Descriptors.OneofDescriptor oneof)

public UriOverride.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
Name Description
oneof OneofDescriptor
Returns
Type Description
UriOverride.Builder
Overrides

clearPathOverride()

public UriOverride.Builder clearPathOverride()

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.v2beta3.PathOverride path_override = 4;

Returns
Type Description
UriOverride.Builder

clearPort()

public UriOverride.Builder clearPort()

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
UriOverride.Builder

This builder for chaining.

clearQueryOverride()

public UriOverride.Builder clearQueryOverride()

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.v2beta3.QueryOverride query_override = 5;

Returns
Type Description
UriOverride.Builder

clearScheme()

public UriOverride.Builder clearScheme()

Scheme override.

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

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

Returns
Type Description
UriOverride.Builder

This builder for chaining.

clearUriOverrideEnforceMode()

public UriOverride.Builder clearUriOverrideEnforceMode()

URI Override Enforce Mode

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

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

Returns
Type Description
UriOverride.Builder

This builder for chaining.

clone()

public UriOverride.Builder clone()
Returns
Type Description
UriOverride.Builder
Overrides

getDefaultInstanceForType()

public UriOverride getDefaultInstanceForType()
Returns
Type Description
UriOverride

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
Type Description
Descriptor
Overrides

getHost()

public 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 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 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.v2beta3.PathOverride path_override = 4;

Returns
Type Description
PathOverride

The pathOverride.

getPathOverrideBuilder()

public PathOverride.Builder getPathOverrideBuilder()

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.v2beta3.PathOverride path_override = 4;

Returns
Type Description
PathOverride.Builder

getPathOverrideOrBuilder()

public 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.v2beta3.PathOverride path_override = 4;

Returns
Type Description
PathOverrideOrBuilder

getPort()

public 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 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.v2beta3.QueryOverride query_override = 5;

Returns
Type Description
QueryOverride

The queryOverride.

getQueryOverrideBuilder()

public QueryOverride.Builder getQueryOverrideBuilder()

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.v2beta3.QueryOverride query_override = 5;

Returns
Type Description
QueryOverride.Builder

getQueryOverrideOrBuilder()

public 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.v2beta3.QueryOverride query_override = 5;

Returns
Type Description
QueryOverrideOrBuilder

getScheme()

public UriOverride.Scheme getScheme()

Scheme override.

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

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

Returns
Type Description
UriOverride.Scheme

The scheme.

getSchemeValue()

public int getSchemeValue()

Scheme override.

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

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

Returns
Type Description
int

The enum numeric value on the wire for scheme.

getUriOverrideEnforceMode()

public UriOverride.UriOverrideEnforceMode getUriOverrideEnforceMode()

URI Override Enforce Mode

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

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

Returns
Type Description
UriOverride.UriOverrideEnforceMode

The uriOverrideEnforceMode.

getUriOverrideEnforceModeValue()

public int getUriOverrideEnforceModeValue()

URI Override Enforce Mode

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

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

Returns
Type Description
int

The enum numeric value on the wire for uriOverrideEnforceMode.

hasHost()

public 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 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.v2beta3.PathOverride path_override = 4;

Returns
Type Description
boolean

Whether the pathOverride field is set.

hasPort()

public 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 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.v2beta3.QueryOverride query_override = 5;

Returns
Type Description
boolean

Whether the queryOverride field is set.

hasScheme()

public boolean hasScheme()

Scheme override.

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

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

Returns
Type Description
boolean

Whether the scheme field is set.

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

mergeFrom(UriOverride other)

public UriOverride.Builder mergeFrom(UriOverride other)
Parameter
Name Description
other UriOverride
Returns
Type Description
UriOverride.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public UriOverride.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
UriOverride.Builder
Overrides
Exceptions
Type Description
IOException

mergeFrom(Message other)

public UriOverride.Builder mergeFrom(Message other)
Parameter
Name Description
other Message
Returns
Type Description
UriOverride.Builder
Overrides

mergePathOverride(PathOverride value)

public UriOverride.Builder mergePathOverride(PathOverride value)

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.v2beta3.PathOverride path_override = 4;

Parameter
Name Description
value PathOverride
Returns
Type Description
UriOverride.Builder

mergeQueryOverride(QueryOverride value)

public UriOverride.Builder mergeQueryOverride(QueryOverride value)

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.v2beta3.QueryOverride query_override = 5;

Parameter
Name Description
value QueryOverride
Returns
Type Description
UriOverride.Builder

mergeUnknownFields(UnknownFieldSet unknownFields)

public final UriOverride.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
UriOverride.Builder
Overrides

setField(Descriptors.FieldDescriptor field, Object value)

public UriOverride.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
UriOverride.Builder
Overrides

setHost(String value)

public UriOverride.Builder setHost(String value)

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;

Parameter
Name Description
value String

The host to set.

Returns
Type Description
UriOverride.Builder

This builder for chaining.

setHostBytes(ByteString value)

public UriOverride.Builder setHostBytes(ByteString value)

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;

Parameter
Name Description
value ByteString

The bytes for host to set.

Returns
Type Description
UriOverride.Builder

This builder for chaining.

setPathOverride(PathOverride value)

public UriOverride.Builder setPathOverride(PathOverride value)

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.v2beta3.PathOverride path_override = 4;

Parameter
Name Description
value PathOverride
Returns
Type Description
UriOverride.Builder

setPathOverride(PathOverride.Builder builderForValue)

public UriOverride.Builder setPathOverride(PathOverride.Builder builderForValue)

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.v2beta3.PathOverride path_override = 4;

Parameter
Name Description
builderForValue PathOverride.Builder
Returns
Type Description
UriOverride.Builder

setPort(long value)

public UriOverride.Builder setPort(long value)

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;

Parameter
Name Description
value long

The port to set.

Returns
Type Description
UriOverride.Builder

This builder for chaining.

setQueryOverride(QueryOverride value)

public UriOverride.Builder setQueryOverride(QueryOverride value)

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.v2beta3.QueryOverride query_override = 5;

Parameter
Name Description
value QueryOverride
Returns
Type Description
UriOverride.Builder

setQueryOverride(QueryOverride.Builder builderForValue)

public UriOverride.Builder setQueryOverride(QueryOverride.Builder builderForValue)

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.v2beta3.QueryOverride query_override = 5;

Parameter
Name Description
builderForValue QueryOverride.Builder
Returns
Type Description
UriOverride.Builder

setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

public UriOverride.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Parameters
Name Description
field FieldDescriptor
index int
value Object
Returns
Type Description
UriOverride.Builder
Overrides

setScheme(UriOverride.Scheme value)

public UriOverride.Builder setScheme(UriOverride.Scheme value)

Scheme override.

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

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

Parameter
Name Description
value UriOverride.Scheme

The scheme to set.

Returns
Type Description
UriOverride.Builder

This builder for chaining.

setSchemeValue(int value)

public UriOverride.Builder setSchemeValue(int value)

Scheme override.

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

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

Parameter
Name Description
value int

The enum numeric value on the wire for scheme to set.

Returns
Type Description
UriOverride.Builder

This builder for chaining.

setUnknownFields(UnknownFieldSet unknownFields)

public final UriOverride.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
UriOverride.Builder
Overrides

setUriOverrideEnforceMode(UriOverride.UriOverrideEnforceMode value)

public UriOverride.Builder setUriOverrideEnforceMode(UriOverride.UriOverrideEnforceMode value)

URI Override Enforce Mode

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

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

Parameter
Name Description
value UriOverride.UriOverrideEnforceMode

The uriOverrideEnforceMode to set.

Returns
Type Description
UriOverride.Builder

This builder for chaining.

setUriOverrideEnforceModeValue(int value)

public UriOverride.Builder setUriOverrideEnforceModeValue(int value)

URI Override Enforce Mode

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

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

Parameter
Name Description
value int

The enum numeric value on the wire for uriOverrideEnforceMode to set.

Returns
Type Description
UriOverride.Builder

This builder for chaining.