Interface IssueOrBuilder (0.5.0)

Version 0.5.0

• 0.8.0 (latest)
• 0.7.0
• 0.6.0
• 0.5.0
• 0.4.0
• 0.2.0
• 0.1.0

public interface IssueOrBuilder extends MessageOrBuilder

Implements

MessageOrBuilder

Methods

getCode()

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

getMessage()

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

getPath(int index)

public abstract 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 abstract 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 abstract 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 abstract List<String> 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
List<String>	A list containing the path.

getRange()

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

getSeverity()

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