Console
    Start free

    Google Cloud Api Hub V1 Client - Class PluginInstance (0.4.0)

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

    Represents a plugin instance resource in the API Hub.

    A PluginInstance is a specific instance of a hub plugin with its own configuration, state, and execution details.

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

    Namespace

    Google \ Cloud \ ApiHub \ V1

    Methods

    __construct

    Constructor.

    Parameters
    Name
    Description
    data
    array

    Optional. Data for populating the Message object.

    ↳ name
    string

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

    ↳ display_name
    string

    Required. The display name for this plugin instance. Max length is 255 characters.

    ↳ auth_config
    AuthConfig

    Optional. The authentication information for this plugin instance.

    ↳ additional_config
    array| Google\Protobuf\Internal\MapField

    Optional. The additional information for this plugin instance corresponding to the additional config template of the plugin. This information will be sent to plugin hosting service on each call to plugin hosted service. The key will be the config_variable_template.display_name to uniquely identify the config variable.

    ↳ state
    int

    Output only. The current state of the plugin instance (e.g., enabled, disabled, provisioning).

    ↳ error_message
    string

    Output only. Error message describing the failure, if any, during Create, Delete or ApplyConfig operation corresponding to the plugin instance.This field will only be populated if the plugin instance is in the ERROR or FAILED state.

    ↳ actions
    array< PluginInstanceAction >

    Required. The action status for the plugin instance.

    ↳ create_time
    Google\Protobuf\Timestamp

    Output only. Timestamp indicating when the plugin instance was created.

    ↳ update_time
    Google\Protobuf\Timestamp

    Output only. Timestamp indicating when the plugin instance was last updated.

    ↳ source_project_id
    string

    Optional. The source project id of the plugin instance. This will be the id of runtime project in case of gcp based plugins and org id in case of non gcp based plugins. This field will be a required field for Google provided on-ramp plugins.

    getName

    Identifier. The unique name of the plugin instance resource.

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

    Returns
    Type
    Description
    string

    setName

    Identifier. The unique name of the plugin instance resource.

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

    Parameter
    Name
    Description
    var
    string
    Returns
    Type
    Description
    $this

    getDisplayName

    Required. The display name for this plugin instance. Max length is 255 characters.

    Returns
    Type
    Description
    string

    setDisplayName

    Required. The display name for this plugin instance. Max length is 255 characters.

    Parameter
    Name
    Description
    var
    string
    Returns
    Type
    Description
    $this

    getAuthConfig

    Optional. The authentication information for this plugin instance.

    Returns
    Type
    Description
    AuthConfig |null

    hasAuthConfig

    clearAuthConfig

    setAuthConfig

    Optional. The authentication information for this plugin instance.

    Parameter
    Name
    Description
    var
    AuthConfig
    Returns
    Type
    Description
    $this

    getAdditionalConfig

    Optional. The additional information for this plugin instance corresponding to the additional config template of the plugin. This information will be sent to plugin hosting service on each call to plugin hosted service. The key will be the config_variable_template.display_name to uniquely identify the config variable.

    Returns
    Type
    Description
    Google\Protobuf\Internal\MapField

    setAdditionalConfig

    Optional. The additional information for this plugin instance corresponding to the additional config template of the plugin. This information will be sent to plugin hosting service on each call to plugin hosted service. The key will be the config_variable_template.display_name to uniquely identify the config variable.

    Parameter
    Name
    Description
    var
    array| Google\Protobuf\Internal\MapField
    Returns
    Type
    Description
    $this

    getState

    Output only. The current state of the plugin instance (e.g., enabled, disabled, provisioning).

    Returns
    Type
    Description
    int
    Enum of type State .

    setState

    Output only. The current state of the plugin instance (e.g., enabled, disabled, provisioning).

    Parameter
    Name
    Description
    var
    int

    Enum of type State .

    Returns
    Type
    Description
    $this

    getErrorMessage

    Output only. Error message describing the failure, if any, during Create, Delete or ApplyConfig operation corresponding to the plugin instance.This field will only be populated if the plugin instance is in the ERROR or FAILED state.

    Returns
    Type
    Description
    string

    setErrorMessage

    Output only. Error message describing the failure, if any, during Create, Delete or ApplyConfig operation corresponding to the plugin instance.This field will only be populated if the plugin instance is in the ERROR or FAILED state.

    Parameter
    Name
    Description
    var
    string
    Returns
    Type
    Description
    $this

    getActions

    Required. The action status for the plugin instance.

    Returns
    Type
    Description
    Google\Protobuf\Internal\RepeatedField

    setActions

    Required. The action status for the plugin instance.

    Parameter
    Name
    Description
    var
    array< PluginInstanceAction >
    Returns
    Type
    Description
    $this

    getCreateTime

    Output only. Timestamp indicating when the plugin instance was created.

    Returns
    Type
    Description
    Google\Protobuf\Timestamp |null

    hasCreateTime

    clearCreateTime

    setCreateTime

    Output only. Timestamp indicating when the plugin instance was created.

    Parameter
    Name
    Description
    var
    Google\Protobuf\Timestamp
    Returns
    Type
    Description
    $this

    getUpdateTime

    Output only. Timestamp indicating when the plugin instance was last updated.

    Returns
    Type
    Description
    Google\Protobuf\Timestamp |null

    hasUpdateTime

    clearUpdateTime

    setUpdateTime

    Output only. Timestamp indicating when the plugin instance was last updated.

    Parameter
    Name
    Description
    var
    Google\Protobuf\Timestamp
    Returns
    Type
    Description
    $this

    getSourceProjectId

    Optional. The source project id of the plugin instance. This will be the id of runtime project in case of gcp based plugins and org id in case of non gcp based plugins. This field will be a required field for Google provided on-ramp plugins.

    Returns
    Type
    Description
    string

    setSourceProjectId

    Optional. The source project id of the plugin instance. This will be the id of runtime project in case of gcp based plugins and org id in case of non gcp based plugins. This field will be a required field for Google provided on-ramp plugins.

    Parameter
    Name
    Description
    var
    string
    Returns
    Type
    Description
    $this
    Create a Mobile Website
    View Site in Mobile | Classic
    Share by: