Class CheckError (1.40.0)

public final class CheckError extends GeneratedMessageV3 implements CheckErrorOrBuilder

Defines the errors to be returned in google.api.servicecontrol.v1.CheckResponse.check_errors.

Protobuf type google.api.servicecontrol.v1.CheckError

Implements

CheckErrorOrBuilder

Static Fields

CODE_FIELD_NUMBER

public static final int CODE_FIELD_NUMBER
Field Value
TypeDescription
int

DETAIL_FIELD_NUMBER

public static final int DETAIL_FIELD_NUMBER
Field Value
TypeDescription
int

STATUS_FIELD_NUMBER

public static final int STATUS_FIELD_NUMBER
Field Value
TypeDescription
int

SUBJECT_FIELD_NUMBER

public static final int SUBJECT_FIELD_NUMBER
Field Value
TypeDescription
int

Static Methods

getDefaultInstance()

public static CheckError getDefaultInstance()
Returns
TypeDescription
CheckError

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
TypeDescription
Descriptor

newBuilder()

public static CheckError.Builder newBuilder()
Returns
TypeDescription
CheckError.Builder

newBuilder(CheckError prototype)

public static CheckError.Builder newBuilder(CheckError prototype)
Parameter
NameDescription
prototypeCheckError
Returns
TypeDescription
CheckError.Builder

parseDelimitedFrom(InputStream input)

public static CheckError parseDelimitedFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
CheckError
Exceptions
TypeDescription
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static CheckError parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
CheckError
Exceptions
TypeDescription
IOException

parseFrom(byte[] data)

public static CheckError parseFrom(byte[] data)
Parameter
NameDescription
databyte[]
Returns
TypeDescription
CheckError
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static CheckError parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
databyte[]
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
CheckError
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data)

public static CheckError parseFrom(ByteString data)
Parameter
NameDescription
dataByteString
Returns
TypeDescription
CheckError
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static CheckError parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteString
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
CheckError
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static CheckError parseFrom(CodedInputStream input)
Parameter
NameDescription
inputCodedInputStream
Returns
TypeDescription
CheckError
Exceptions
TypeDescription
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static CheckError parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputCodedInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
CheckError
Exceptions
TypeDescription
IOException

parseFrom(InputStream input)

public static CheckError parseFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
CheckError
Exceptions
TypeDescription
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static CheckError parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
CheckError
Exceptions
TypeDescription
IOException

parseFrom(ByteBuffer data)

public static CheckError parseFrom(ByteBuffer data)
Parameter
NameDescription
dataByteBuffer
Returns
TypeDescription
CheckError
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static CheckError parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteBuffer
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
CheckError
Exceptions
TypeDescription
InvalidProtocolBufferException

parser()

public static Parser<CheckError> parser()
Returns
TypeDescription
Parser<CheckError>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
NameDescription
objObject
Returns
TypeDescription
boolean
Overrides

getCode()

public CheckError.Code getCode()

The error code.

.google.api.servicecontrol.v1.CheckError.Code code = 1;

Returns
TypeDescription
CheckError.Code

The code.

getCodeValue()

public int getCodeValue()

The error code.

.google.api.servicecontrol.v1.CheckError.Code code = 1;

Returns
TypeDescription
int

The enum numeric value on the wire for code.

getDefaultInstanceForType()

public CheckError getDefaultInstanceForType()
Returns
TypeDescription
CheckError

getDetail()

public String getDetail()

Free-form text providing details on the error cause of the error.

string detail = 2;

Returns
TypeDescription
String

The detail.

getDetailBytes()

public ByteString getDetailBytes()

Free-form text providing details on the error cause of the error.

string detail = 2;

Returns
TypeDescription
ByteString

The bytes for detail.

getParserForType()

public Parser<CheckError> getParserForType()
Returns
TypeDescription
Parser<CheckError>
Overrides

getSerializedSize()

public int getSerializedSize()
Returns
TypeDescription
int
Overrides

getStatus()

public Status getStatus()

Contains public information about the check error. If available, status.code will be non zero and client can propagate it out as public error.

.google.rpc.Status status = 3;

Returns
TypeDescription
com.google.rpc.Status

The status.

getStatusOrBuilder()

public StatusOrBuilder getStatusOrBuilder()

Contains public information about the check error. If available, status.code will be non zero and client can propagate it out as public error.

.google.rpc.Status status = 3;

Returns
TypeDescription
com.google.rpc.StatusOrBuilder

getSubject()

public String getSubject()

Subject to whom this error applies. See the specific code enum for more details on this field. For example:

  • "project:<project-id or project-number>"
  • "folder:<folder-id>"
  • "organization:<organization-id>"

string subject = 4;

Returns
TypeDescription
String

The subject.

getSubjectBytes()

public ByteString getSubjectBytes()

Subject to whom this error applies. See the specific code enum for more details on this field. For example:

  • "project:<project-id or project-number>"
  • "folder:<folder-id>"
  • "organization:<organization-id>"

string subject = 4;

Returns
TypeDescription
ByteString

The bytes for subject.

hasStatus()

public boolean hasStatus()

Contains public information about the check error. If available, status.code will be non zero and client can propagate it out as public error.

.google.rpc.Status status = 3;

Returns
TypeDescription
boolean

Whether the status field is set.

hashCode()

public int hashCode()
Returns
TypeDescription
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
TypeDescription
boolean
Overrides

newBuilderForType()

public CheckError.Builder newBuilderForType()
Returns
TypeDescription
CheckError.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected CheckError.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
NameDescription
parentBuilderParent
Returns
TypeDescription
CheckError.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
NameDescription
unusedUnusedPrivateParameter
Returns
TypeDescription
Object
Overrides

toBuilder()

public CheckError.Builder toBuilder()
Returns
TypeDescription
CheckError.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
NameDescription
outputCodedOutputStream
Overrides
Exceptions
TypeDescription
IOException