public final class StyleGuide extends GeneratedMessageV3 implements StyleGuideOrBuilder
Represents a singleton style guide resource to be used for linting Open API specs.
Protobuf type google.cloud.apihub.v1.StyleGuide
Inheritance
Object > AbstractMessageLite<MessageType,BuilderType> > AbstractMessage > GeneratedMessageV3 > StyleGuideImplements
StyleGuideOrBuilderStatic Fields
CONTENTS_FIELD_NUMBER
public static final int CONTENTS_FIELD_NUMBER
Field Value | |
---|---|
Type | Description |
int |
LINTER_FIELD_NUMBER
public static final int LINTER_FIELD_NUMBER
Field Value | |
---|---|
Type | Description |
int |
NAME_FIELD_NUMBER
public static final int NAME_FIELD_NUMBER
Field Value | |
---|---|
Type | Description |
int |
Static Methods
getDefaultInstance()
public static StyleGuide getDefaultInstance()
Returns | |
---|---|
Type | Description |
StyleGuide |
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()
Returns | |
---|---|
Type | Description |
Descriptor |
newBuilder()
public static StyleGuide.Builder newBuilder()
Returns | |
---|---|
Type | Description |
StyleGuide.Builder |
newBuilder(StyleGuide prototype)
public static StyleGuide.Builder newBuilder(StyleGuide prototype)
Parameter | |
---|---|
Name | Description |
prototype |
StyleGuide |
Returns | |
---|---|
Type | Description |
StyleGuide.Builder |
parseDelimitedFrom(InputStream input)
public static StyleGuide parseDelimitedFrom(InputStream input)
Parameter | |
---|---|
Name | Description |
input |
InputStream |
Returns | |
---|---|
Type | Description |
StyleGuide |
Exceptions | |
---|---|
Type | Description |
IOException |
parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
public static StyleGuide parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters | |
---|---|
Name | Description |
input |
InputStream |
extensionRegistry |
ExtensionRegistryLite |
Returns | |
---|---|
Type | Description |
StyleGuide |
Exceptions | |
---|---|
Type | Description |
IOException |
parseFrom(byte[] data)
public static StyleGuide parseFrom(byte[] data)
Parameter | |
---|---|
Name | Description |
data |
byte[] |
Returns | |
---|---|
Type | Description |
StyleGuide |
Exceptions | |
---|---|
Type | Description |
InvalidProtocolBufferException |
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static StyleGuide parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters | |
---|---|
Name | Description |
data |
byte[] |
extensionRegistry |
ExtensionRegistryLite |
Returns | |
---|---|
Type | Description |
StyleGuide |
Exceptions | |
---|---|
Type | Description |
InvalidProtocolBufferException |
parseFrom(ByteString data)
public static StyleGuide parseFrom(ByteString data)
Parameter | |
---|---|
Name | Description |
data |
ByteString |
Returns | |
---|---|
Type | Description |
StyleGuide |
Exceptions | |
---|---|
Type | Description |
InvalidProtocolBufferException |
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static StyleGuide parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters | |
---|---|
Name | Description |
data |
ByteString |
extensionRegistry |
ExtensionRegistryLite |
Returns | |
---|---|
Type | Description |
StyleGuide |
Exceptions | |
---|---|
Type | Description |
InvalidProtocolBufferException |
parseFrom(CodedInputStream input)
public static StyleGuide parseFrom(CodedInputStream input)
Parameter | |
---|---|
Name | Description |
input |
CodedInputStream |
Returns | |
---|---|
Type | Description |
StyleGuide |
Exceptions | |
---|---|
Type | Description |
IOException |
parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public static StyleGuide parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters | |
---|---|
Name | Description |
input |
CodedInputStream |
extensionRegistry |
ExtensionRegistryLite |
Returns | |
---|---|
Type | Description |
StyleGuide |
Exceptions | |
---|---|
Type | Description |
IOException |
parseFrom(InputStream input)
public static StyleGuide parseFrom(InputStream input)
Parameter | |
---|---|
Name | Description |
input |
InputStream |
Returns | |
---|---|
Type | Description |
StyleGuide |
Exceptions | |
---|---|
Type | Description |
IOException |
parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
public static StyleGuide parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters | |
---|---|
Name | Description |
input |
InputStream |
extensionRegistry |
ExtensionRegistryLite |
Returns | |
---|---|
Type | Description |
StyleGuide |
Exceptions | |
---|---|
Type | Description |
IOException |
parseFrom(ByteBuffer data)
public static StyleGuide parseFrom(ByteBuffer data)
Parameter | |
---|---|
Name | Description |
data |
ByteBuffer |
Returns | |
---|---|
Type | Description |
StyleGuide |
Exceptions | |
---|---|
Type | Description |
InvalidProtocolBufferException |
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static StyleGuide parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters | |
---|---|
Name | Description |
data |
ByteBuffer |
extensionRegistry |
ExtensionRegistryLite |
Returns | |
---|---|
Type | Description |
StyleGuide |
Exceptions | |
---|---|
Type | Description |
InvalidProtocolBufferException |
parser()
public static Parser<StyleGuide> parser()
Returns | |
---|---|
Type | Description |
Parser<StyleGuide> |
Methods
equals(Object obj)
public boolean equals(Object obj)
Parameter | |
---|---|
Name | Description |
obj |
Object |
Returns | |
---|---|
Type | Description |
boolean |
getContents()
public StyleGuideContents getContents()
Required. Input only. The contents of the uploaded style guide.
.google.cloud.apihub.v1.StyleGuideContents contents = 3 [(.google.api.field_behavior) = REQUIRED, (.google.api.field_behavior) = INPUT_ONLY];
Returns | |
---|---|
Type | Description |
StyleGuideContents |
The contents. |
getContentsOrBuilder()
public StyleGuideContentsOrBuilder getContentsOrBuilder()
Required. Input only. The contents of the uploaded style guide.
.google.cloud.apihub.v1.StyleGuideContents contents = 3 [(.google.api.field_behavior) = REQUIRED, (.google.api.field_behavior) = INPUT_ONLY];
Returns | |
---|---|
Type | Description |
StyleGuideContentsOrBuilder |
getDefaultInstanceForType()
public StyleGuide getDefaultInstanceForType()
Returns | |
---|---|
Type | Description |
StyleGuide |
getLinter()
public Linter getLinter()
Required. Target linter for the style guide.
.google.cloud.apihub.v1.Linter linter = 2 [(.google.api.field_behavior) = REQUIRED];
Returns | |
---|---|
Type | Description |
Linter |
The linter. |
getLinterValue()
public int getLinterValue()
Required. Target linter for the style guide.
.google.cloud.apihub.v1.Linter linter = 2 [(.google.api.field_behavior) = REQUIRED];
Returns | |
---|---|
Type | Description |
int |
The enum numeric value on the wire for linter. |
getName()
public String getName()
Identifier. The name of the style guide.
Format:
projects/{project}/locations/{location}/plugins/{plugin}/styleGuide
string name = 1 [(.google.api.field_behavior) = IDENTIFIER];
Returns | |
---|---|
Type | Description |
String |
The name. |
getNameBytes()
public ByteString getNameBytes()
Identifier. The name of the style guide.
Format:
projects/{project}/locations/{location}/plugins/{plugin}/styleGuide
string name = 1 [(.google.api.field_behavior) = IDENTIFIER];
Returns | |
---|---|
Type | Description |
ByteString |
The bytes for name. |
getParserForType()
public Parser<StyleGuide> getParserForType()
Returns | |
---|---|
Type | Description |
Parser<StyleGuide> |
getSerializedSize()
public int getSerializedSize()
Returns | |
---|---|
Type | Description |
int |
hasContents()
public boolean hasContents()
Required. Input only. The contents of the uploaded style guide.
.google.cloud.apihub.v1.StyleGuideContents contents = 3 [(.google.api.field_behavior) = REQUIRED, (.google.api.field_behavior) = INPUT_ONLY];
Returns | |
---|---|
Type | Description |
boolean |
Whether the contents field is set. |
hashCode()
public int hashCode()
Returns | |
---|---|
Type | Description |
int |
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns | |
---|---|
Type | Description |
FieldAccessorTable |
isInitialized()
public final boolean isInitialized()
Returns | |
---|---|
Type | Description |
boolean |
newBuilderForType()
public StyleGuide.Builder newBuilderForType()
Returns | |
---|---|
Type | Description |
StyleGuide.Builder |
newBuilderForType(GeneratedMessageV3.BuilderParent parent)
protected StyleGuide.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter | |
---|---|
Name | Description |
parent |
BuilderParent |
Returns | |
---|---|
Type | Description |
StyleGuide.Builder |
newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter | |
---|---|
Name | Description |
unused |
UnusedPrivateParameter |
Returns | |
---|---|
Type | Description |
Object |
toBuilder()
public StyleGuide.Builder toBuilder()
Returns | |
---|---|
Type | Description |
StyleGuide.Builder |
writeTo(CodedOutputStream output)
public void writeTo(CodedOutputStream output)
Parameter | |
---|---|
Name | Description |
output |
CodedOutputStream |
Exceptions | |
---|---|
Type | Description |
IOException |