Class Issue (0.8.0)

public final class Issue extends GeneratedMessageV3 implements IssueOrBuilder

Issue contains the details of a single issue found by the linter.

Protobuf type google.cloud.apihub.v1.Issue

Implements

IssueOrBuilder

Static Fields

CODE_FIELD_NUMBER

public static final int CODE_FIELD_NUMBER
Field Value
Type Description
int

MESSAGE_FIELD_NUMBER

public static final int MESSAGE_FIELD_NUMBER
Field Value
Type Description
int

PATH_FIELD_NUMBER

public static final int PATH_FIELD_NUMBER
Field Value
Type Description
int

RANGE_FIELD_NUMBER

public static final int RANGE_FIELD_NUMBER
Field Value
Type Description
int

SEVERITY_FIELD_NUMBER

public static final int SEVERITY_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static Issue getDefaultInstance()
Returns
Type Description
Issue

getDescriptor()

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

newBuilder()

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

newBuilder(Issue prototype)

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

parseDelimitedFrom(InputStream input)

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

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(byte[] data)

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

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteString data)

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

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(CodedInputStream input)

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

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(InputStream input)

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

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteBuffer data)

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

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

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

parser()

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

Methods

equals(Object obj)

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

getCode()

public String getCode()

Required. Rule code unique to each rule defined in linter.

string code = 1 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
String

The code.

getCodeBytes()

public ByteString getCodeBytes()

Required. Rule code unique to each rule defined in linter.

string code = 1 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
ByteString

The bytes for code.

getDefaultInstanceForType()

public Issue getDefaultInstanceForType()
Returns
Type Description
Issue

getMessage()

public String getMessage()

Required. Human-readable message describing the issue found by the linter.

string message = 3 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
String

The message.

getMessageBytes()

public ByteString getMessageBytes()

Required. Human-readable message describing the issue found by the linter.

string message = 3 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
ByteString

The bytes for message.

getParserForType()

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

getPath(int index)

public String getPath(int index)

Required. An array of strings indicating the location in the analyzed document where the rule was triggered.

repeated string path = 2 [(.google.api.field_behavior) = REQUIRED];

Parameter
Name Description
index int

The index of the element to return.

Returns
Type Description
String

The path at the given index.

getPathBytes(int index)

public ByteString getPathBytes(int index)

Required. An array of strings indicating the location in the analyzed document where the rule was triggered.

repeated string path = 2 [(.google.api.field_behavior) = REQUIRED];

Parameter
Name Description
index int

The index of the value to return.

Returns
Type Description
ByteString

The bytes of the path at the given index.

getPathCount()

public int getPathCount()

Required. An array of strings indicating the location in the analyzed document where the rule was triggered.

repeated string path = 2 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
int

The count of path.

getPathList()

public ProtocolStringList getPathList()

Required. An array of strings indicating the location in the analyzed document where the rule was triggered.

repeated string path = 2 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
ProtocolStringList

A list containing the path.

getRange()

public Range getRange()

Required. Object describing where in the file the issue was found.

.google.cloud.apihub.v1.Range range = 5 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
Range

The range.

getRangeOrBuilder()

public RangeOrBuilder getRangeOrBuilder()

Required. Object describing where in the file the issue was found.

.google.cloud.apihub.v1.Range range = 5 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
RangeOrBuilder

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

getSeverity()

public Severity getSeverity()

Required. Severity level of the rule violation.

.google.cloud.apihub.v1.Severity severity = 4 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
Severity

The severity.

getSeverityValue()

public int getSeverityValue()

Required. Severity level of the rule violation.

.google.cloud.apihub.v1.Severity severity = 4 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
int

The enum numeric value on the wire for severity.

hasRange()

public boolean hasRange()

Required. Object describing where in the file the issue was found.

.google.cloud.apihub.v1.Range range = 5 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
boolean

Whether the range 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 Issue.Builder newBuilderForType()
Returns
Type Description
Issue.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

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

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

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

toBuilder()

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

writeTo(CodedOutputStream output)

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