Reference documentation and code samples for the Google Cloud Api Hub V1 Client class StyleGuide.
Represents a singleton style guide resource to be used for linting Open API specs.
Generated from protobuf message google.cloud.apihub.v1.StyleGuide
Namespace
Google \ Cloud \ ApiHub \ V1Methods
__construct
Constructor.
| Parameters | |
|---|---|
| Name | Description |
data |
array
Optional. Data for populating the Message object. |
↳ name |
string
Identifier. The name of the style guide. Format: |
↳ linter |
int
Required. Target linter for the style guide. |
↳ contents |
StyleGuideContents
Required. Input only. The contents of the uploaded style guide. |
getName
Identifier. The name of the style guide.
Format:
projects/{project}/locations/{location}/plugins/{plugin}/styleGuide
| Returns | |
|---|---|
| Type | Description |
string |
|
setName
Identifier. The name of the style guide.
Format:
projects/{project}/locations/{location}/plugins/{plugin}/styleGuide
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getLinter
Required. Target linter for the style guide.
| Returns | |
|---|---|
| Type | Description |
int |
|
setLinter
Required. Target linter for the style guide.
| Parameter | |
|---|---|
| Name | Description |
var |
int
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getContents
Required. Input only. The contents of the uploaded style guide.
| Returns | |
|---|---|
| Type | Description |
StyleGuideContents|null |
|
hasContents
clearContents
setContents
Required. Input only. The contents of the uploaded style guide.
| Parameter | |
|---|---|
| Name | Description |
var |
StyleGuideContents
|
| Returns | |
|---|---|
| Type | Description |
$this |
|