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

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

The CreatePluginInstance method's request.

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

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 of the plugin instance resource. Format: `projects/{project}/locations/{location}/plugins/{plugin}`
`↳ plugin_instance_id`	`string` Optional. The ID to use for the plugin instance, which will become the final component of the plugin instance'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 instance in the plugin resource. * * If not provided, a system generated id will be used. This value should be 4-63 characters, and valid characters are /[a-z][A-Z][0-9]-_/.
`↳ plugin_instance`	`PluginInstance` Required. The plugin instance to create.

getParent

Required. The parent of the plugin instance resource.

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

Returns
Type	Description
`string`

setParent

Required. The parent of the plugin instance resource.

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

Parameter
Name	Description
`var`	`string`

Returns
Type	Description
`$this`

getPluginInstanceId

Optional. The ID to use for the plugin instance, which will become the final component of the plugin instance'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 instance in the plugin resource.
If not provided, a system generated id will be used. This value should be 4-63 characters, and valid characters are /[a-z][A-Z][0-9]-_/.

Returns
Type	Description
`string`

setPluginInstanceId

Optional. The ID to use for the plugin instance, which will become the final component of the plugin instance'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 instance in the plugin resource.
If not provided, a system generated id will be used. This value should be 4-63 characters, and valid characters are /[a-z][A-Z][0-9]-_/.

Parameter
Name	Description
`var`	`string`

Returns
Type	Description
`$this`

getPluginInstance

Required. The plugin instance to create.

Returns
Type	Description
`PluginInstance\|null`

hasPluginInstance

clearPluginInstance

setPluginInstance

Required. The plugin instance to create.

Parameter
Name	Description
`var`	`PluginInstance`

Returns
Type	Description
`$this`

static::build

Parameters
Name	Description
`parent`	`string` Required. The parent of the plugin instance resource. Format: `projects/{project}/locations/{location}/plugins/{plugin}` Please see ApiHubPluginClient::pluginName() for help formatting this field.
`pluginInstance`	`PluginInstance` Required. The plugin instance to create.
`pluginInstanceId`	`string` Optional. The ID to use for the plugin instance, which will become the final component of the plugin instance'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 instance in the plugin resource. If not provided, a system generated id will be used. This value should be 4-63 characters, and valid characters are /[a-z][A-Z][0-9]-_/.

Returns
Type	Description
`CreatePluginInstanceRequest`