Class CheckError (1.42.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
Type Description
int

DETAIL_FIELD_NUMBER

public static final int DETAIL_FIELD_NUMBER
Field Value
Type Description
int

STATUS_FIELD_NUMBER

public static final int STATUS_FIELD_NUMBER
Field Value
Type Description
int

SUBJECT_FIELD_NUMBER

public static final int SUBJECT_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static CheckError getDefaultInstance()
Returns
Type Description
CheckError

getDescriptor()

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

newBuilder()

public static CheckError.Builder newBuilder()
Returns
Type Description
CheckError.Builder

newBuilder(CheckError prototype)

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

parseDelimitedFrom(InputStream input)

public static CheckError parseDelimitedFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
CheckError
Exceptions
Type Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(byte[] data)

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

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteString data)

public static CheckError parseFrom(ByteString data)
Parameter
Name Description
data ByteString
Returns
Type Description
CheckError
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(CodedInputStream input)

public static CheckError parseFrom(CodedInputStream input)
Parameter
Name Description
input CodedInputStream
Returns
Type Description
CheckError
Exceptions
Type Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(InputStream input)

public static CheckError parseFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
CheckError
Exceptions
Type Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteBuffer data)

public static CheckError parseFrom(ByteBuffer data)
Parameter
Name Description
data ByteBuffer
Returns
Type Description
CheckError
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

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

parser()

public static Parser<CheckError> parser()
Returns
Type Description
Parser<CheckError>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
Name Description
obj Object
Returns
Type Description
boolean
Overrides

getCode()

public CheckError.Code getCode()

The error code.

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

Returns
Type Description
CheckError.Code

The code.

getCodeValue()

public int getCodeValue()

The error code.

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

Returns
Type Description
int

The enum numeric value on the wire for code.

getDefaultInstanceForType()

public CheckError getDefaultInstanceForType()
Returns
Type Description
CheckError

getDetail()

public String getDetail()

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

string detail = 2;

Returns
Type Description
String

The detail.

getDetailBytes()

public ByteString getDetailBytes()

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

string detail = 2;

Returns
Type Description
ByteString

The bytes for detail.

getParserForType()

public Parser<CheckError> getParserForType()
Returns
Type Description
Parser<CheckError>
Overrides

getSerializedSize()

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

Whether the status field is set.

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 CheckError.Builder newBuilderForType()
Returns
Type Description
CheckError.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

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

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

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

toBuilder()

public CheckError.Builder toBuilder()
Returns
Type Description
CheckError.Builder

writeTo(CodedOutputStream output)

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