Google Cloud Api Hub V1 Client - Class CreatePluginRequest (0.4.1)

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

The CreatePlugin method's request.

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

Namespace

Google \ Cloud \ ApiHub \ V1

Methods

__construct

Constructor.

Parameters
Name Description
data array

Optional. Data for populating the Message object.
↳ parent string

Required. The parent resource where this plugin will be created. Format: projects/{project}/locations/{location}.
↳ plugin_id string

Optional. The ID to use for the Plugin resource, which will become the final component of the Plugin's resource name. This field is optional. * * If provided, the same will be used. The service will throw an error if the specified id is already used by another Plugin resource in the API hub instance. * * If not provided, a system generated id will be used. This value should be 4-63 characters, overall resource name which will be of format projects/{project}/locations/{location}/plugins/{plugin}, its length is limited to 1000 characters and valid characters are /[a-z][A-Z][0-9]-_/.
↳ plugin Plugin

Required. The plugin to create.

getParent

Required. The parent resource where this plugin will be created.

Format: projects/{project}/locations/{location}.

Returns
Type Description
string

setParent

Required. The parent resource where this plugin will be created.

Format: projects/{project}/locations/{location}.

Parameter
Name Description
var string
Returns
Type Description
$this

getPluginId

Optional. The ID to use for the Plugin resource, which will become the final component of the Plugin's resource name. This field is optional.

  • If provided, the same will be used. The service will throw an error if the specified id is already used by another Plugin resource in the API hub instance.
  • If not provided, a system generated id will be used. This value should be 4-63 characters, overall resource name which will be of format projects/{project}/locations/{location}/plugins/{plugin}, its length is limited to 1000 characters and valid characters are /[a-z][A-Z][0-9]-_/.
Returns
Type Description
string

setPluginId

Optional. The ID to use for the Plugin resource, which will become the final component of the Plugin's resource name. This field is optional.

  • If provided, the same will be used. The service will throw an error if the specified id is already used by another Plugin resource in the API hub instance.
  • If not provided, a system generated id will be used. This value should be 4-63 characters, overall resource name which will be of format projects/{project}/locations/{location}/plugins/{plugin}, its length is limited to 1000 characters and valid characters are /[a-z][A-Z][0-9]-_/.
Parameter
Name Description
var string
Returns
Type Description
$this

getPlugin

Required. The plugin to create.

Returns
Type Description
Plugin|null

hasPlugin

clearPlugin

setPlugin

Required. The plugin to create.

Parameter
Name Description
var Plugin
Returns
Type Description
$this

static::build

Parameters
Name Description
parent string

Required. The parent resource where this plugin will be created. Format: projects/{project}/locations/{location}. Please see ApiHubPluginClient::locationName() for help formatting this field.
plugin Plugin

Required. The plugin to create.
pluginId string

Optional. The ID to use for the Plugin resource, which will become the final component of the Plugin's resource name. This field is optional.

    • If provided, the same will be used. The service will throw an error if the specified id is already used by another Plugin resource in the API hub instance.
    • If not provided, a system generated id will be used.

This value should be 4-63 characters, overall resource name which will be of format projects/{project}/locations/{location}/plugins/{plugin}, its length is limited to 1000 characters and valid characters are /[a-z][A-Z][0-9]-_/.
Returns
Type Description
CreatePluginRequest