Class Help.Builder (2.40.0)

public static final class Help.Builder extends GeneratedMessageV3.Builder<Help.Builder> implements HelpOrBuilder

Provides links to documentation or for performing an out of band action.

For example, if a quota check failed with an error indicating the calling project hasn't enabled the accessed service, this can contain a URL pointing directly to the right place in the developer console to flip the bit.

Protobuf type google.rpc.Help

Implements

HelpOrBuilder

Static Methods

getDescriptor()

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

Methods

public Help.Builder addAllLinks(Iterable<? extends Help.Link> values)

URL(s) pointing to additional information on handling the current error.

repeated .google.rpc.Help.Link links = 1;

Parameter
Name Description
values Iterable<? extends com.google.rpc.Help.Link>
Returns
Type Description
Help.Builder
public Help.Builder addLinks(Help.Link value)

URL(s) pointing to additional information on handling the current error.

repeated .google.rpc.Help.Link links = 1;

Parameter
Name Description
value Help.Link
Returns
Type Description
Help.Builder
public Help.Builder addLinks(Help.Link.Builder builderForValue)

URL(s) pointing to additional information on handling the current error.

repeated .google.rpc.Help.Link links = 1;

Parameter
Name Description
builderForValue Help.Link.Builder
Returns
Type Description
Help.Builder
public Help.Builder addLinks(int index, Help.Link value)

URL(s) pointing to additional information on handling the current error.

repeated .google.rpc.Help.Link links = 1;

Parameters
Name Description
index int
value Help.Link
Returns
Type Description
Help.Builder
public Help.Builder addLinks(int index, Help.Link.Builder builderForValue)

URL(s) pointing to additional information on handling the current error.

repeated .google.rpc.Help.Link links = 1;

Parameters
Name Description
index int
builderForValue Help.Link.Builder
Returns
Type Description
Help.Builder

addLinksBuilder()

public Help.Link.Builder addLinksBuilder()

URL(s) pointing to additional information on handling the current error.

repeated .google.rpc.Help.Link links = 1;

Returns
Type Description
Help.Link.Builder

addLinksBuilder(int index)

public Help.Link.Builder addLinksBuilder(int index)

URL(s) pointing to additional information on handling the current error.

repeated .google.rpc.Help.Link links = 1;

Parameter
Name Description
index int
Returns
Type Description
Help.Link.Builder

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

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

build()

public Help build()
Returns
Type Description
Help

buildPartial()

public Help buildPartial()
Returns
Type Description
Help

clear()

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

clearField(Descriptors.FieldDescriptor field)

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

URL(s) pointing to additional information on handling the current error.

repeated .google.rpc.Help.Link links = 1;

Returns
Type Description
Help.Builder

clearOneof(Descriptors.OneofDescriptor oneof)

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

clone()

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

getDefaultInstanceForType()

public Help getDefaultInstanceForType()
Returns
Type Description
Help

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
Type Description
Descriptor
Overrides
public Help.Link getLinks(int index)

URL(s) pointing to additional information on handling the current error.

repeated .google.rpc.Help.Link links = 1;

Parameter
Name Description
index int
Returns
Type Description
Help.Link

getLinksBuilder(int index)

public Help.Link.Builder getLinksBuilder(int index)

URL(s) pointing to additional information on handling the current error.

repeated .google.rpc.Help.Link links = 1;

Parameter
Name Description
index int
Returns
Type Description
Help.Link.Builder

getLinksBuilderList()

public List<Help.Link.Builder> getLinksBuilderList()

URL(s) pointing to additional information on handling the current error.

repeated .google.rpc.Help.Link links = 1;

Returns
Type Description
List<Builder>

getLinksCount()

public int getLinksCount()

URL(s) pointing to additional information on handling the current error.

repeated .google.rpc.Help.Link links = 1;

Returns
Type Description
int
public List<Help.Link> getLinksList()

URL(s) pointing to additional information on handling the current error.

repeated .google.rpc.Help.Link links = 1;

Returns
Type Description
List<Link>

getLinksOrBuilder(int index)

public Help.LinkOrBuilder getLinksOrBuilder(int index)

URL(s) pointing to additional information on handling the current error.

repeated .google.rpc.Help.Link links = 1;

Parameter
Name Description
index int
Returns
Type Description
Help.LinkOrBuilder

getLinksOrBuilderList()

public List<? extends Help.LinkOrBuilder> getLinksOrBuilderList()

URL(s) pointing to additional information on handling the current error.

repeated .google.rpc.Help.Link links = 1;

Returns
Type Description
List<? extends com.google.rpc.Help.LinkOrBuilder>

internalGetFieldAccessorTable()

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

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

mergeFrom(Message other)

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

mergeFrom(Help other)

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

mergeUnknownFields(UnknownFieldSet unknownFields)

public final Help.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
Help.Builder
Overrides
public Help.Builder removeLinks(int index)

URL(s) pointing to additional information on handling the current error.

repeated .google.rpc.Help.Link links = 1;

Parameter
Name Description
index int
Returns
Type Description
Help.Builder

setField(Descriptors.FieldDescriptor field, Object value)

public Help.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
Help.Builder
Overrides
public Help.Builder setLinks(int index, Help.Link value)

URL(s) pointing to additional information on handling the current error.

repeated .google.rpc.Help.Link links = 1;

Parameters
Name Description
index int
value Help.Link
Returns
Type Description
Help.Builder
public Help.Builder setLinks(int index, Help.Link.Builder builderForValue)

URL(s) pointing to additional information on handling the current error.

repeated .google.rpc.Help.Link links = 1;

Parameters
Name Description
index int
builderForValue Help.Link.Builder
Returns
Type Description
Help.Builder

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

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

setUnknownFields(UnknownFieldSet unknownFields)

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