Class PreconditionFailure.Violation (2.39.0)

public static final class PreconditionFailure.Violation extends GeneratedMessageV3 implements PreconditionFailure.ViolationOrBuilder

A message type used to describe a single precondition failure.

Protobuf type google.rpc.PreconditionFailure.Violation

Static Fields

DESCRIPTION_FIELD_NUMBER

public static final int DESCRIPTION_FIELD_NUMBER
Field Value
Type Description
int

SUBJECT_FIELD_NUMBER

public static final int SUBJECT_FIELD_NUMBER
Field Value
Type Description
int

TYPE_FIELD_NUMBER

public static final int TYPE_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static PreconditionFailure.Violation getDefaultInstance()
Returns
Type Description
PreconditionFailure.Violation

getDescriptor()

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

newBuilder()

public static PreconditionFailure.Violation.Builder newBuilder()
Returns
Type Description
PreconditionFailure.Violation.Builder

newBuilder(PreconditionFailure.Violation prototype)

public static PreconditionFailure.Violation.Builder newBuilder(PreconditionFailure.Violation prototype)
Parameter
Name Description
prototype PreconditionFailure.Violation
Returns
Type Description
PreconditionFailure.Violation.Builder

parseDelimitedFrom(InputStream input)

public static PreconditionFailure.Violation parseDelimitedFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
PreconditionFailure.Violation
Exceptions
Type Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static PreconditionFailure.Violation parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
PreconditionFailure.Violation
Exceptions
Type Description
IOException

parseFrom(byte[] data)

public static PreconditionFailure.Violation parseFrom(byte[] data)
Parameter
Name Description
data byte[]
Returns
Type Description
PreconditionFailure.Violation
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static PreconditionFailure.Violation parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data byte[]
extensionRegistry ExtensionRegistryLite
Returns
Type Description
PreconditionFailure.Violation
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static PreconditionFailure.Violation parseFrom(ByteString data)
Parameter
Name Description
data ByteString
Returns
Type Description
PreconditionFailure.Violation
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static PreconditionFailure.Violation parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteString
extensionRegistry ExtensionRegistryLite
Returns
Type Description
PreconditionFailure.Violation
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static PreconditionFailure.Violation parseFrom(CodedInputStream input)
Parameter
Name Description
input CodedInputStream
Returns
Type Description
PreconditionFailure.Violation
Exceptions
Type Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static PreconditionFailure.Violation parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
PreconditionFailure.Violation
Exceptions
Type Description
IOException

parseFrom(InputStream input)

public static PreconditionFailure.Violation parseFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
PreconditionFailure.Violation
Exceptions
Type Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static PreconditionFailure.Violation parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
PreconditionFailure.Violation
Exceptions
Type Description
IOException

parseFrom(ByteBuffer data)

public static PreconditionFailure.Violation parseFrom(ByteBuffer data)
Parameter
Name Description
data ByteBuffer
Returns
Type Description
PreconditionFailure.Violation
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static PreconditionFailure.Violation parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteBuffer
extensionRegistry ExtensionRegistryLite
Returns
Type Description
PreconditionFailure.Violation
Exceptions
Type Description
InvalidProtocolBufferException

parser()

public static Parser<PreconditionFailure.Violation> parser()
Returns
Type Description
Parser<Violation>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
Name Description
obj Object
Returns
Type Description
boolean
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.

getParserForType()

public Parser<PreconditionFailure.Violation> getParserForType()
Returns
Type Description
Parser<Violation>
Overrides

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
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.

hashCode()

public int hashCode()
Returns
Type Description
int
Overrides

internalGetFieldAccessorTable()

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

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

newBuilderForType()

public PreconditionFailure.Violation.Builder newBuilderForType()
Returns
Type Description
PreconditionFailure.Violation.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected PreconditionFailure.Violation.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
PreconditionFailure.Violation.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Name Description
unused UnusedPrivateParameter
Returns
Type Description
Object
Overrides

toBuilder()

public PreconditionFailure.Violation.Builder toBuilder()
Returns
Type Description
PreconditionFailure.Violation.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
Name Description
output CodedOutputStream
Overrides
Exceptions
Type Description
IOException