public final class PreconditionFailure extends GeneratedMessageV3 implements PreconditionFailureOrBuilderDescribes what preconditions have failed.
For example, if an RPC failed because it required the Terms of Service to be acknowledged, it could list the terms of service violation in the PreconditionFailure message.
Protobuf type google.rpc.PreconditionFailure
Inheritance
Object > AbstractMessageLite<MessageType,BuilderType> > AbstractMessage > GeneratedMessageV3 > PreconditionFailureImplements
PreconditionFailureOrBuilderStatic Fields
VIOLATIONS_FIELD_NUMBER
public static final int VIOLATIONS_FIELD_NUMBER| Field Value | |
|---|---|
| Type | Description |
int |
|
Static Methods
getDefaultInstance()
public static PreconditionFailure getDefaultInstance()| Returns | |
|---|---|
| Type | Description |
PreconditionFailure |
|
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()| Returns | |
|---|---|
| Type | Description |
Descriptor |
|
newBuilder()
public static PreconditionFailure.Builder newBuilder()| Returns | |
|---|---|
| Type | Description |
PreconditionFailure.Builder |
|
newBuilder(PreconditionFailure prototype)
public static PreconditionFailure.Builder newBuilder(PreconditionFailure prototype)| Parameter | |
|---|---|
| Name | Description |
prototype |
PreconditionFailure |
| Returns | |
|---|---|
| Type | Description |
PreconditionFailure.Builder |
|
parseDelimitedFrom(InputStream input)
public static PreconditionFailure parseDelimitedFrom(InputStream input)| Parameter | |
|---|---|
| Name | Description |
input |
InputStream |
| Returns | |
|---|---|
| Type | Description |
PreconditionFailure |
|
| Exceptions | |
|---|---|
| Type | Description |
IOException |
|
parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
public static PreconditionFailure parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)| Parameters | |
|---|---|
| Name | Description |
input |
InputStream |
extensionRegistry |
ExtensionRegistryLite |
| Returns | |
|---|---|
| Type | Description |
PreconditionFailure |
|
| Exceptions | |
|---|---|
| Type | Description |
IOException |
|
parseFrom(byte[] data)
public static PreconditionFailure parseFrom(byte[] data)| Parameter | |
|---|---|
| Name | Description |
data |
byte[] |
| Returns | |
|---|---|
| Type | Description |
PreconditionFailure |
|
| Exceptions | |
|---|---|
| Type | Description |
InvalidProtocolBufferException |
|
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static PreconditionFailure parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)| Parameters | |
|---|---|
| Name | Description |
data |
byte[] |
extensionRegistry |
ExtensionRegistryLite |
| Returns | |
|---|---|
| Type | Description |
PreconditionFailure |
|
| Exceptions | |
|---|---|
| Type | Description |
InvalidProtocolBufferException |
|
parseFrom(ByteString data)
public static PreconditionFailure parseFrom(ByteString data)| Parameter | |
|---|---|
| Name | Description |
data |
ByteString |
| Returns | |
|---|---|
| Type | Description |
PreconditionFailure |
|
| Exceptions | |
|---|---|
| Type | Description |
InvalidProtocolBufferException |
|
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static PreconditionFailure parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)| Parameters | |
|---|---|
| Name | Description |
data |
ByteString |
extensionRegistry |
ExtensionRegistryLite |
| Returns | |
|---|---|
| Type | Description |
PreconditionFailure |
|
| Exceptions | |
|---|---|
| Type | Description |
InvalidProtocolBufferException |
|
parseFrom(CodedInputStream input)
public static PreconditionFailure parseFrom(CodedInputStream input)| Parameter | |
|---|---|
| Name | Description |
input |
CodedInputStream |
| Returns | |
|---|---|
| Type | Description |
PreconditionFailure |
|
| Exceptions | |
|---|---|
| Type | Description |
IOException |
|
parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public static PreconditionFailure parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)| Parameters | |
|---|---|
| Name | Description |
input |
CodedInputStream |
extensionRegistry |
ExtensionRegistryLite |
| Returns | |
|---|---|
| Type | Description |
PreconditionFailure |
|
| Exceptions | |
|---|---|
| Type | Description |
IOException |
|
parseFrom(InputStream input)
public static PreconditionFailure parseFrom(InputStream input)| Parameter | |
|---|---|
| Name | Description |
input |
InputStream |
| Returns | |
|---|---|
| Type | Description |
PreconditionFailure |
|
| Exceptions | |
|---|---|
| Type | Description |
IOException |
|
parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
public static PreconditionFailure parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)| Parameters | |
|---|---|
| Name | Description |
input |
InputStream |
extensionRegistry |
ExtensionRegistryLite |
| Returns | |
|---|---|
| Type | Description |
PreconditionFailure |
|
| Exceptions | |
|---|---|
| Type | Description |
IOException |
|
parseFrom(ByteBuffer data)
public static PreconditionFailure parseFrom(ByteBuffer data)| Parameter | |
|---|---|
| Name | Description |
data |
ByteBuffer |
| Returns | |
|---|---|
| Type | Description |
PreconditionFailure |
|
| Exceptions | |
|---|---|
| Type | Description |
InvalidProtocolBufferException |
|
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static PreconditionFailure parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)| Parameters | |
|---|---|
| Name | Description |
data |
ByteBuffer |
extensionRegistry |
ExtensionRegistryLite |
| Returns | |
|---|---|
| Type | Description |
PreconditionFailure |
|
| Exceptions | |
|---|---|
| Type | Description |
InvalidProtocolBufferException |
|
parser()
public static Parser<PreconditionFailure> parser()| Returns | |
|---|---|
| Type | Description |
Parser<PreconditionFailure> |
|
Methods
equals(Object obj)
public boolean equals(Object obj)| Parameter | |
|---|---|
| Name | Description |
obj |
Object |
| Returns | |
|---|---|
| Type | Description |
boolean |
|
getDefaultInstanceForType()
public PreconditionFailure getDefaultInstanceForType()| Returns | |
|---|---|
| Type | Description |
PreconditionFailure |
|
getParserForType()
public Parser<PreconditionFailure> getParserForType()| Returns | |
|---|---|
| Type | Description |
Parser<PreconditionFailure> |
|
getSerializedSize()
public int getSerializedSize()| Returns | |
|---|---|
| Type | Description |
int |
|
getViolations(int index)
public PreconditionFailure.Violation getViolations(int index)Describes all precondition violations.
repeated .google.rpc.PreconditionFailure.Violation violations = 1;
| Parameter | |
|---|---|
| Name | Description |
index |
int |
| Returns | |
|---|---|
| Type | Description |
PreconditionFailure.Violation |
|
getViolationsCount()
public int getViolationsCount()Describes all precondition violations.
repeated .google.rpc.PreconditionFailure.Violation violations = 1;
| Returns | |
|---|---|
| Type | Description |
int |
|
getViolationsList()
public List<PreconditionFailure.Violation> getViolationsList()Describes all precondition violations.
repeated .google.rpc.PreconditionFailure.Violation violations = 1;
| Returns | |
|---|---|
| Type | Description |
List<Violation> |
|
getViolationsOrBuilder(int index)
public PreconditionFailure.ViolationOrBuilder getViolationsOrBuilder(int index)Describes all precondition violations.
repeated .google.rpc.PreconditionFailure.Violation violations = 1;
| Parameter | |
|---|---|
| Name | Description |
index |
int |
| Returns | |
|---|---|
| Type | Description |
PreconditionFailure.ViolationOrBuilder |
|
getViolationsOrBuilderList()
public List<? extends PreconditionFailure.ViolationOrBuilder> getViolationsOrBuilderList()Describes all precondition violations.
repeated .google.rpc.PreconditionFailure.Violation violations = 1;
| Returns | |
|---|---|
| Type | Description |
List<? extends com.google.rpc.PreconditionFailure.ViolationOrBuilder> |
|
hashCode()
public int hashCode()| Returns | |
|---|---|
| Type | Description |
int |
|
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()| Returns | |
|---|---|
| Type | Description |
FieldAccessorTable |
|
isInitialized()
public final boolean isInitialized()| Returns | |
|---|---|
| Type | Description |
boolean |
|
newBuilderForType()
public PreconditionFailure.Builder newBuilderForType()| Returns | |
|---|---|
| Type | Description |
PreconditionFailure.Builder |
|
newBuilderForType(GeneratedMessageV3.BuilderParent parent)
protected PreconditionFailure.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)| Parameter | |
|---|---|
| Name | Description |
parent |
BuilderParent |
| Returns | |
|---|---|
| Type | Description |
PreconditionFailure.Builder |
|
newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)| Parameter | |
|---|---|
| Name | Description |
unused |
UnusedPrivateParameter |
| Returns | |
|---|---|
| Type | Description |
Object |
|
toBuilder()
public PreconditionFailure.Builder toBuilder()| Returns | |
|---|---|
| Type | Description |
PreconditionFailure.Builder |
|
writeTo(CodedOutputStream output)
public void writeTo(CodedOutputStream output)| Parameter | |
|---|---|
| Name | Description |
output |
CodedOutputStream |
| Exceptions | |
|---|---|
| Type | Description |
IOException |
|