Interface PreconditionFailure.ViolationOrBuilder (2.46.0)

public static interface PreconditionFailure.ViolationOrBuilder extends MessageOrBuilder

Implements

MessageOrBuilder

Methods

getDescription()

public abstract 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 abstract 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.

getSubject()

public abstract 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 abstract 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 abstract 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 abstract 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.