Google Cloud Api Hub V1 Client - Class Plugin (0.1.2)

Reference documentation and code samples for the Google Cloud Api Hub V1 Client class Plugin.

A plugin resource in the API Hub.

Generated from protobuf message google.cloud.apihub.v1.Plugin

Namespace

Google \ Cloud \ ApiHub \ V1

Methods

__construct

Constructor.

Parameters
Name Description
data array

Optional. Data for populating the Message object.

↳ name string

Identifier. The name of the plugin. Format: projects/{project}/locations/{location}/plugins/{plugin}

↳ display_name string

Required. The display name of the plugin. Max length is 50 characters (Unicode code points).

↳ type Google\Cloud\ApiHub\V1\AttributeValues

Required. The type of the API. This maps to the following system defined attribute: projects/{project}/locations/{location}/attributes/system-plugin-type attribute. The number of allowed values for this attribute will be based on the cardinality of the attribute. The same can be retrieved via GetAttribute API. All values should be from the list of allowed values defined for the attribute.

↳ description string

Optional. The plugin description. Max length is 2000 characters (Unicode code points).

↳ state int

Output only. Represents the state of the plugin.

getName

Identifier. The name of the plugin.

Format: projects/{project}/locations/{location}/plugins/{plugin}

Returns
Type Description
string

setName

Identifier. The name of the plugin.

Format: projects/{project}/locations/{location}/plugins/{plugin}

Parameter
Name Description
var string
Returns
Type Description
$this

getDisplayName

Required. The display name of the plugin. Max length is 50 characters (Unicode code points).

Returns
Type Description
string

setDisplayName

Required. The display name of the plugin. Max length is 50 characters (Unicode code points).

Parameter
Name Description
var string
Returns
Type Description
$this

getType

Required. The type of the API.

This maps to the following system defined attribute: projects/{project}/locations/{location}/attributes/system-plugin-type attribute. The number of allowed values for this attribute will be based on the cardinality of the attribute. The same can be retrieved via GetAttribute API. All values should be from the list of allowed values defined for the attribute.

Returns
Type Description
Google\Cloud\ApiHub\V1\AttributeValues|null

hasType

clearType

setType

Required. The type of the API.

This maps to the following system defined attribute: projects/{project}/locations/{location}/attributes/system-plugin-type attribute. The number of allowed values for this attribute will be based on the cardinality of the attribute. The same can be retrieved via GetAttribute API. All values should be from the list of allowed values defined for the attribute.

Parameter
Name Description
var Google\Cloud\ApiHub\V1\AttributeValues
Returns
Type Description
$this

getDescription

Optional. The plugin description. Max length is 2000 characters (Unicode code points).

Returns
Type Description
string

setDescription

Optional. The plugin description. Max length is 2000 characters (Unicode code points).

Parameter
Name Description
var string
Returns
Type Description
$this

getState

Output only. Represents the state of the plugin.

Returns
Type Description
int

setState

Output only. Represents the state of the plugin.

Parameter
Name Description
var int
Returns
Type Description
$this