LintingService

google.cloud.apihub.v1. LintingService

Represents a LintingService

Constructor

new LintingService(rpcImpl, requestDelimitedopt, responseDelimitedopt)

Constructs a new LintingService service.

Parameters:
Name Type Attributes Default Description
rpcImpl $protobuf.RPCImpl

RPC implementation

requestDelimited boolean <optional>
false

Whether requests are length-delimited

responseDelimited boolean <optional>
false

Whether responses are length-delimited

Extends

  • $protobuf.rpc.Service

Methods

getStyleGuide(request, callback) → {undefined}

Calls GetStyleGuide.

Parameters:
Name Type Description
request google.cloud.apihub.v1.IGetStyleGuideRequest

GetStyleGuideRequest message or plain object

callback google.cloud.apihub.v1.LintingService.GetStyleGuideCallback

Node-style callback called with the error, if any, and StyleGuide

Returns:
Type Description
undefined

getStyleGuide(request) → {Promise.<google.cloud.apihub.v1.StyleGuide>}

Calls GetStyleGuide.

Parameters:
Name Type Description
request google.cloud.apihub.v1.IGetStyleGuideRequest

GetStyleGuideRequest message or plain object

Returns:
Type Description
Promise.<google.cloud.apihub.v1.StyleGuide>

Promise

getStyleGuideContents(request, callback) → {undefined}

Calls GetStyleGuideContents.

Parameters:
Name Type Description
request google.cloud.apihub.v1.IGetStyleGuideContentsRequest

GetStyleGuideContentsRequest message or plain object

callback google.cloud.apihub.v1.LintingService.GetStyleGuideContentsCallback

Node-style callback called with the error, if any, and StyleGuideContents

Returns:
Type Description
undefined

getStyleGuideContents(request) → {Promise.<google.cloud.apihub.v1.StyleGuideContents>}

Calls GetStyleGuideContents.

Parameters:
Name Type Description
request google.cloud.apihub.v1.IGetStyleGuideContentsRequest

GetStyleGuideContentsRequest message or plain object

Returns:
Type Description
Promise.<google.cloud.apihub.v1.StyleGuideContents>

Promise

lintSpec(request, callback) → {undefined}

Calls LintSpec.

Parameters:
Name Type Description
request google.cloud.apihub.v1.ILintSpecRequest

LintSpecRequest message or plain object

callback google.cloud.apihub.v1.LintingService.LintSpecCallback

Node-style callback called with the error, if any, and Empty

Returns:
Type Description
undefined

lintSpec(request) → {Promise.<google.protobuf.Empty>}

Calls LintSpec.

Parameters:
Name Type Description
request google.cloud.apihub.v1.ILintSpecRequest

LintSpecRequest message or plain object

Returns:
Type Description
Promise.<google.protobuf.Empty>

Promise

updateStyleGuide(request, callback) → {undefined}

Calls UpdateStyleGuide.

Parameters:
Name Type Description
request google.cloud.apihub.v1.IUpdateStyleGuideRequest

UpdateStyleGuideRequest message or plain object

callback google.cloud.apihub.v1.LintingService.UpdateStyleGuideCallback

Node-style callback called with the error, if any, and StyleGuide

Returns:
Type Description
undefined

updateStyleGuide(request) → {Promise.<google.cloud.apihub.v1.StyleGuide>}

Calls UpdateStyleGuide.

Parameters:
Name Type Description
request google.cloud.apihub.v1.IUpdateStyleGuideRequest

UpdateStyleGuideRequest message or plain object

Returns:
Type Description
Promise.<google.cloud.apihub.v1.StyleGuide>

Promise

(static) create(rpcImpl, requestDelimitedopt, responseDelimitedopt) → {LintingService}

Creates new LintingService service using the specified rpc implementation.

Parameters:
Name Type Attributes Default Description
rpcImpl $protobuf.RPCImpl

RPC implementation

requestDelimited boolean <optional>
false

Whether requests are length-delimited

responseDelimited boolean <optional>
false

Whether responses are length-delimited

Returns:
Type Description
LintingService

RPC service. Useful where requests and/or responses are streamed.

Type Definitions

GetStyleGuideCallback(error, responseopt)

Callback as used by getStyleGuide.

Parameters:
Name Type Attributes Description
error Error | null

Error, if any

response google.cloud.apihub.v1.StyleGuide <optional>

StyleGuide

GetStyleGuideContentsCallback(error, responseopt)

Callback as used by getStyleGuideContents.

Parameters:
Name Type Attributes Description
error Error | null

Error, if any

response google.cloud.apihub.v1.StyleGuideContents <optional>

StyleGuideContents

LintSpecCallback(error, responseopt)

Callback as used by lintSpec.

Parameters:
Name Type Attributes Description
error Error | null

Error, if any

response google.protobuf.Empty <optional>

Empty

UpdateStyleGuideCallback(error, responseopt)

Callback as used by updateStyleGuide.

Parameters:
Name Type Attributes Description
error Error | null

Error, if any

response google.cloud.apihub.v1.StyleGuide <optional>

StyleGuide