Class PreconditionFailure.Violation.Builder (2.38.0)

public static final class PreconditionFailure.Violation.Builder extends GeneratedMessageV3.Builder<PreconditionFailure.Violation.Builder> implements PreconditionFailure.ViolationOrBuilder

A message type used to describe a single precondition failure.

Protobuf type google.rpc.PreconditionFailure.Violation

Static Methods

getDescriptor()

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

Methods

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

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

build()

public PreconditionFailure.Violation build()
Returns
Type Description
PreconditionFailure.Violation

buildPartial()

public PreconditionFailure.Violation buildPartial()
Returns
Type Description
PreconditionFailure.Violation

clear()

public PreconditionFailure.Violation.Builder clear()
Returns
Type Description
PreconditionFailure.Violation.Builder
Overrides

clearDescription()

public PreconditionFailure.Violation.Builder clearDescription()

A description of how the precondition failed. Developers can use this description to understand how to fix the failure.

For example: "Terms of service not accepted".

string description = 3;

Returns
Type Description
PreconditionFailure.Violation.Builder

This builder for chaining.

clearField(Descriptors.FieldDescriptor field)

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

clearOneof(Descriptors.OneofDescriptor oneof)

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

clearSubject()

public PreconditionFailure.Violation.Builder clearSubject()

The subject, relative to the type, that failed. For example, "google.com/cloud" relative to the "TOS" type would indicate which terms of service is being referenced.

string subject = 2;

Returns
Type Description
PreconditionFailure.Violation.Builder

This builder for chaining.

clearType()

public PreconditionFailure.Violation.Builder clearType()

The type of PreconditionFailure. We recommend using a service-specific enum type to define the supported precondition violation subjects. For example, "TOS" for "Terms of Service violation".

string type = 1;

Returns
Type Description
PreconditionFailure.Violation.Builder

This builder for chaining.

clone()

public PreconditionFailure.Violation.Builder clone()
Returns
Type Description
PreconditionFailure.Violation.Builder
Overrides

getDefaultInstanceForType()

public PreconditionFailure.Violation getDefaultInstanceForType()
Returns
Type Description
PreconditionFailure.Violation

getDescription()

public String getDescription()

A description of how the precondition failed. Developers can use this description to understand how to fix the failure.

For example: "Terms of service not accepted".

string description = 3;

Returns
Type Description
String

The description.

getDescriptionBytes()

public ByteString getDescriptionBytes()

A description of how the precondition failed. Developers can use this description to understand how to fix the failure.

For example: "Terms of service not accepted".

string description = 3;

Returns
Type Description
ByteString

The bytes for description.

getDescriptorForType()

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

getSubject()

public String getSubject()

The subject, relative to the type, that failed. For example, "google.com/cloud" relative to the "TOS" type would indicate which terms of service is being referenced.

string subject = 2;

Returns
Type Description
String

The subject.

getSubjectBytes()

public ByteString getSubjectBytes()

The subject, relative to the type, that failed. For example, "google.com/cloud" relative to the "TOS" type would indicate which terms of service is being referenced.

string subject = 2;

Returns
Type Description
ByteString

The bytes for subject.

getType()

public String getType()

The type of PreconditionFailure. We recommend using a service-specific enum type to define the supported precondition violation subjects. For example, "TOS" for "Terms of Service violation".

string type = 1;

Returns
Type Description
String

The type.

getTypeBytes()

public ByteString getTypeBytes()

The type of PreconditionFailure. We recommend using a service-specific enum type to define the supported precondition violation subjects. For example, "TOS" for "Terms of Service violation".

string type = 1;

Returns
Type Description
ByteString

The bytes for type.

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 PreconditionFailure.Violation.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
PreconditionFailure.Violation.Builder
Overrides
Exceptions
Type Description
IOException

mergeFrom(Message other)

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

mergeFrom(PreconditionFailure.Violation other)

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

mergeUnknownFields(UnknownFieldSet unknownFields)

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

setDescription(String value)

public PreconditionFailure.Violation.Builder setDescription(String value)

A description of how the precondition failed. Developers can use this description to understand how to fix the failure.

For example: "Terms of service not accepted".

string description = 3;

Parameter
Name Description
value String

The description to set.

Returns
Type Description
PreconditionFailure.Violation.Builder

This builder for chaining.

setDescriptionBytes(ByteString value)

public PreconditionFailure.Violation.Builder setDescriptionBytes(ByteString value)

A description of how the precondition failed. Developers can use this description to understand how to fix the failure.

For example: "Terms of service not accepted".

string description = 3;

Parameter
Name Description
value ByteString

The bytes for description to set.

Returns
Type Description
PreconditionFailure.Violation.Builder

This builder for chaining.

setField(Descriptors.FieldDescriptor field, Object value)

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

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

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

setSubject(String value)

public PreconditionFailure.Violation.Builder setSubject(String value)

The subject, relative to the type, that failed. For example, "google.com/cloud" relative to the "TOS" type would indicate which terms of service is being referenced.

string subject = 2;

Parameter
Name Description
value String

The subject to set.

Returns
Type Description
PreconditionFailure.Violation.Builder

This builder for chaining.

setSubjectBytes(ByteString value)

public PreconditionFailure.Violation.Builder setSubjectBytes(ByteString value)

The subject, relative to the type, that failed. For example, "google.com/cloud" relative to the "TOS" type would indicate which terms of service is being referenced.

string subject = 2;

Parameter
Name Description
value ByteString

The bytes for subject to set.

Returns
Type Description
PreconditionFailure.Violation.Builder

This builder for chaining.

setType(String value)

public PreconditionFailure.Violation.Builder setType(String value)

The type of PreconditionFailure. We recommend using a service-specific enum type to define the supported precondition violation subjects. For example, "TOS" for "Terms of Service violation".

string type = 1;

Parameter
Name Description
value String

The type to set.

Returns
Type Description
PreconditionFailure.Violation.Builder

This builder for chaining.

setTypeBytes(ByteString value)

public PreconditionFailure.Violation.Builder setTypeBytes(ByteString value)

The type of PreconditionFailure. We recommend using a service-specific enum type to define the supported precondition violation subjects. For example, "TOS" for "Terms of Service violation".

string type = 1;

Parameter
Name Description
value ByteString

The bytes for type to set.

Returns
Type Description
PreconditionFailure.Violation.Builder

This builder for chaining.

setUnknownFields(UnknownFieldSet unknownFields)

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