plugins_style_guide

Creates, updates, deletes, gets or lists a plugins_style_guide resource.

Overview

Name	plugins_style_guide
Type	Resource
Id	google.apihub.plugins_style_guide

Fields

The following fields are returned by SELECT queries:

get_style_guide

Successful response

Name	Datatype	Description
name	string	Identifier. The name of the style guide. Format: projects/{project}/locations/{location}/plugins/{plugin}/styleGuide
contents	object	Required. Input only. The contents of the uploaded style guide. (id: GoogleCloudApihubV1StyleGuideContents)
linter	string	Required. Target linter for the style guide.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_style_guide	select	projectsId, locationsId, pluginsId		Get the style guide being used for linting.
update_style_guide	update	projectsId, locationsId, pluginsId	updateMask	Update the styleGuide to be used for liniting in by API hub.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
locationsId	string
pluginsId	string
projectsId	string
updateMask	string (google-fieldmask)

SELECT examples

get_style_guide

Get the style guide being used for linting.

SELECT
name,
contents,
linter
FROM google.apihub.plugins_style_guide
WHERE projectsId = '{{ projectsId }}' -- required
AND locationsId = '{{ locationsId }}' -- required
AND pluginsId = '{{ pluginsId }}' -- required;

UPDATE examples

update_style_guide

Update the styleGuide to be used for liniting in by API hub.

UPDATE google.apihub.plugins_style_guide
SET 
data__name = '{{ name }}',
data__linter = '{{ linter }}',
data__contents = '{{ contents }}'
WHERE 
projectsId = '{{ projectsId }}' --required
AND locationsId = '{{ locationsId }}' --required
AND pluginsId = '{{ pluginsId }}' --required
AND updateMask = '{{ updateMask}}'
RETURNING
name,
contents,
linter;