Class UriOverride (2.73.0)

publicfinalclass UriOverrideextendsGeneratedMessageV3implementsUriOverrideOrBuilder

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

Inherited Members

com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT)
com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT,int)
com.google.protobuf.GeneratedMessageV3.<T>emptyList(java.lang.Class<T>)
com.google.protobuf.GeneratedMessageV3.internalGetMapFieldReflection(int)

Static Fields

HOST_FIELD_NUMBER

publicstaticfinalintHOST_FIELD_NUMBER
Field Value
Type Description
int

PATH_OVERRIDE_FIELD_NUMBER

publicstaticfinalintPATH_OVERRIDE_FIELD_NUMBER
Field Value
Type Description
int

PORT_FIELD_NUMBER

publicstaticfinalintPORT_FIELD_NUMBER
Field Value
Type Description
int

QUERY_OVERRIDE_FIELD_NUMBER

publicstaticfinalintQUERY_OVERRIDE_FIELD_NUMBER
Field Value
Type Description
int

SCHEME_FIELD_NUMBER

publicstaticfinalintSCHEME_FIELD_NUMBER
Field Value
Type Description
int

URI_OVERRIDE_ENFORCE_MODE_FIELD_NUMBER

publicstaticfinalintURI_OVERRIDE_ENFORCE_MODE_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

publicstaticUriOverridegetDefaultInstance()
Returns
Type Description
UriOverride

getDescriptor()

publicstaticfinalDescriptors.DescriptorgetDescriptor()
Returns
Type Description
Descriptor

newBuilder()

publicstaticUriOverride.BuildernewBuilder()
Returns
Type Description
UriOverride.Builder

newBuilder(UriOverride prototype)

publicstaticUriOverride.BuildernewBuilder(UriOverrideprototype)
Parameter
Name Description
prototype UriOverride
Returns
Type Description
UriOverride.Builder

parseDelimitedFrom(InputStream input)

publicstaticUriOverrideparseDelimitedFrom(InputStreaminput)
Parameter
Name Description
input InputStream
Returns
Type Description
UriOverride
Exceptions
Type Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

publicstaticUriOverrideparseDelimitedFrom(InputStreaminput,ExtensionRegistryLiteextensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
UriOverride
Exceptions
Type Description
IOException

parseFrom(byte[] data)

publicstaticUriOverrideparseFrom(byte[]data)
Parameter
Name Description
data byte[]
Returns
Type Description
UriOverride
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

publicstaticUriOverrideparseFrom(byte[]data,ExtensionRegistryLiteextensionRegistry)
Parameters
Name Description
data byte[]
extensionRegistry ExtensionRegistryLite
Returns
Type Description
UriOverride
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data)

publicstaticUriOverrideparseFrom(ByteStringdata)
Parameter
Name Description
data ByteString
Returns
Type Description
UriOverride
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

publicstaticUriOverrideparseFrom(ByteStringdata,ExtensionRegistryLiteextensionRegistry)
Parameters
Name Description
data ByteString
extensionRegistry ExtensionRegistryLite
Returns
Type Description
UriOverride
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

publicstaticUriOverrideparseFrom(CodedInputStreaminput)
Parameter
Name Description
input CodedInputStream
Returns
Type Description
UriOverride
Exceptions
Type Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

publicstaticUriOverrideparseFrom(CodedInputStreaminput,ExtensionRegistryLiteextensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
UriOverride
Exceptions
Type Description
IOException

parseFrom(InputStream input)

publicstaticUriOverrideparseFrom(InputStreaminput)
Parameter
Name Description
input InputStream
Returns
Type Description
UriOverride
Exceptions
Type Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

publicstaticUriOverrideparseFrom(InputStreaminput,ExtensionRegistryLiteextensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
UriOverride
Exceptions
Type Description
IOException

parseFrom(ByteBuffer data)

publicstaticUriOverrideparseFrom(ByteBufferdata)
Parameter
Name Description
data ByteBuffer
Returns
Type Description
UriOverride
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

publicstaticUriOverrideparseFrom(ByteBufferdata,ExtensionRegistryLiteextensionRegistry)
Parameters
Name Description
data ByteBuffer
extensionRegistry ExtensionRegistryLite
Returns
Type Description
UriOverride
Exceptions
Type Description
InvalidProtocolBufferException

parser()

publicstaticParser<UriOverride>parser()
Returns
Type Description
Parser<UriOverride>

Methods

equals(Object obj)

publicbooleanequals(Objectobj)
Parameter
Name Description
obj Object
Returns
Type Description
boolean
Overrides

getDefaultInstanceForType()

publicUriOverridegetDefaultInstanceForType()
Returns
Type Description
UriOverride

getHost()

publicStringgetHost()

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

publicByteStringgetHostBytes()

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.

getParserForType()

publicParser<UriOverride>getParserForType()
Returns
Type Description
Parser<UriOverride>
Overrides

getPathOverride()

publicPathOverridegetPathOverride()

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.

getPathOverrideOrBuilder()

publicPathOverrideOrBuildergetPathOverrideOrBuilder()

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

publiclonggetPort()

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

publicQueryOverridegetQueryOverride()

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.

getQueryOverrideOrBuilder()

publicQueryOverrideOrBuildergetQueryOverrideOrBuilder()

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

publicUriOverride.SchemegetScheme()

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

publicintgetSchemeValue()

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.

getSerializedSize()

publicintgetSerializedSize()
Returns
Type Description
int
Overrides

getUriOverrideEnforceMode()

publicUriOverride.UriOverrideEnforceModegetUriOverrideEnforceMode()

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

publicintgetUriOverrideEnforceModeValue()

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

publicbooleanhasHost()

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

publicbooleanhasPathOverride()

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

publicbooleanhasPort()

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

publicbooleanhasQueryOverride()

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

publicbooleanhasScheme()

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.

hashCode()

publicinthashCode()
Returns
Type Description
int
Overrides

internalGetFieldAccessorTable()

protectedGeneratedMessageV3.FieldAccessorTableinternalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

isInitialized()

publicfinalbooleanisInitialized()
Returns
Type Description
boolean
Overrides

newBuilderForType()

publicUriOverride.BuildernewBuilderForType()
Returns
Type Description
UriOverride.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protectedUriOverride.BuildernewBuilderForType(GeneratedMessageV3.BuilderParentparent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
UriOverride.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protectedObjectnewInstance(GeneratedMessageV3.UnusedPrivateParameterunused)
Parameter
Name Description
unused UnusedPrivateParameter
Returns
Type Description
Object
Overrides

toBuilder()

publicUriOverride.BuildertoBuilder()
Returns
Type Description
UriOverride.Builder

writeTo(CodedOutputStream output)

publicvoidwriteTo(CodedOutputStreamoutput)
Parameter
Name Description
output CodedOutputStream
Overrides
Exceptions
Type Description
IOException

Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License, and code samples are licensed under the Apache 2.0 License. For details, see the Google Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.

Last updated 2025年11月19日 UTC.