Console
    Start free

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

    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
    AttributeValues

    Optional. 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. Note this field is not required for plugins developed via plugin framework.

    ↳ description
    string

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

    ↳ state
    int

    Output only. Represents the state of the plugin. Note this field will not be set for plugins developed via plugin framework as the state will be managed at plugin instance level.

    ↳ ownership_type
    int

    Output only. The type of the plugin, indicating whether it is 'SYSTEM_OWNED' or 'USER_OWNED'.

    ↳ hosting_service
    Plugin\HostingService

    Optional. This field is optional. It is used to notify the plugin hosting service for any lifecycle changes of the plugin instance and trigger execution of plugin instance actions in case of API hub managed actions. This field should be provided if the plugin instance lifecycle of the developed plugin needs to be managed from API hub. Also, in this case the plugin hosting service interface needs to be implemented. This field should not be provided if the plugin wants to manage plugin instance lifecycle events outside of hub interface and use plugin framework for only registering of plugin and plugin instances to capture the source of data into hub. Note, in this case the plugin hosting service interface is not required to be implemented. Also, the plugin instance lifecycle actions will be disabled from API hub's UI.

    ↳ actions_config
    array< PluginActionConfig >

    Optional. The configuration of actions supported by the plugin. REQUIRED: This field must be provided when creating or updating a Plugin. The server will reject requests if this field is missing.

    ↳ documentation
    Documentation

    Optional. The documentation of the plugin, that explains how to set up and use the plugin.

    ↳ plugin_category
    int

    Optional. The category of the plugin, identifying its primary category or purpose. This field is required for all plugins.

    ↳ config_template
    Plugin\ConfigTemplate

    Optional. The configuration template for the plugin.

    ↳ create_time
    Google\Protobuf\Timestamp

    Output only. Timestamp indicating when the plugin was created.

    ↳ update_time
    Google\Protobuf\Timestamp

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

    ↳ gateway_type
    int

    Optional. The type of the gateway.

    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

    Optional. 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. Note this field is not required for plugins developed via plugin framework.

    Returns
    Type
    Description
    AttributeValues |null

    hasType

    clearType

    setType

    Optional. 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. Note this field is not required for plugins developed via plugin framework.

    Parameter
    Name
    Description
    var
    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.

    Note this field will not be set for plugins developed via plugin framework as the state will be managed at plugin instance level.

    Returns
    Type
    Description
    int
    Enum of type State .

    setState

    Output only. Represents the state of the plugin.

    Note this field will not be set for plugins developed via plugin framework as the state will be managed at plugin instance level.

    Parameter
    Name
    Description
    var
    int

    Enum of type State .

    Returns
    Type
    Description
    $this

    getOwnershipType

    Output only. The type of the plugin, indicating whether it is 'SYSTEM_OWNED' or 'USER_OWNED'.

    Returns
    Type
    Description
    int
    Enum of type OwnershipType .

    setOwnershipType

    Output only. The type of the plugin, indicating whether it is 'SYSTEM_OWNED' or 'USER_OWNED'.

    Parameter
    Name
    Description
    var
    int

    Enum of type OwnershipType .

    Returns
    Type
    Description
    $this

    getHostingService

    Optional. This field is optional. It is used to notify the plugin hosting service for any lifecycle changes of the plugin instance and trigger execution of plugin instance actions in case of API hub managed actions.

    This field should be provided if the plugin instance lifecycle of the developed plugin needs to be managed from API hub. Also, in this case the plugin hosting service interface needs to be implemented. This field should not be provided if the plugin wants to manage plugin instance lifecycle events outside of hub interface and use plugin framework for only registering of plugin and plugin instances to capture the source of data into hub. Note, in this case the plugin hosting service interface is not required to be implemented. Also, the plugin instance lifecycle actions will be disabled from API hub's UI.

    Returns
    Type
    Description
    Plugin\HostingService |null

    hasHostingService

    clearHostingService

    setHostingService

    Optional. This field is optional. It is used to notify the plugin hosting service for any lifecycle changes of the plugin instance and trigger execution of plugin instance actions in case of API hub managed actions.

    This field should be provided if the plugin instance lifecycle of the developed plugin needs to be managed from API hub. Also, in this case the plugin hosting service interface needs to be implemented. This field should not be provided if the plugin wants to manage plugin instance lifecycle events outside of hub interface and use plugin framework for only registering of plugin and plugin instances to capture the source of data into hub. Note, in this case the plugin hosting service interface is not required to be implemented. Also, the plugin instance lifecycle actions will be disabled from API hub's UI.

    Parameter
    Name
    Description
    var
    Plugin\HostingService
    Returns
    Type
    Description
    $this

    getActionsConfig

    Optional. The configuration of actions supported by the plugin.

    REQUIRED: This field must be provided when creating or updating a Plugin. The server will reject requests if this field is missing.

    Returns
    Type
    Description
    Google\Protobuf\Internal\RepeatedField

    setActionsConfig

    Optional. The configuration of actions supported by the plugin.

    REQUIRED: This field must be provided when creating or updating a Plugin. The server will reject requests if this field is missing.

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

    getDocumentation

    Optional. The documentation of the plugin, that explains how to set up and use the plugin.

    Returns
    Type
    Description
    Documentation |null

    hasDocumentation

    clearDocumentation

    setDocumentation

    Optional. The documentation of the plugin, that explains how to set up and use the plugin.

    Parameter
    Name
    Description
    var
    Documentation
    Returns
    Type
    Description
    $this

    getPluginCategory

    Optional. The category of the plugin, identifying its primary category or purpose. This field is required for all plugins.

    Returns
    Type
    Description
    int
    Enum of type PluginCategory .

    setPluginCategory

    Optional. The category of the plugin, identifying its primary category or purpose. This field is required for all plugins.

    Parameter
    Name
    Description
    var
    int

    Enum of type PluginCategory .

    Returns
    Type
    Description
    $this

    getConfigTemplate

    Optional. The configuration template for the plugin.

    Returns
    Type
    Description
    Plugin\ConfigTemplate |null

    hasConfigTemplate

    clearConfigTemplate

    setConfigTemplate

    Optional. The configuration template for the plugin.

    Parameter
    Name
    Description
    var
    Plugin\ConfigTemplate
    Returns
    Type
    Description
    $this

    getCreateTime

    Output only. Timestamp indicating when the plugin was created.

    Returns
    Type
    Description
    Google\Protobuf\Timestamp |null

    hasCreateTime

    clearCreateTime

    setCreateTime

    Output only. Timestamp indicating when the plugin was created.

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

    getUpdateTime

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

    Returns
    Type
    Description
    Google\Protobuf\Timestamp |null

    hasUpdateTime

    clearUpdateTime

    setUpdateTime

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

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

    getGatewayType

    Optional. The type of the gateway.

    Returns
    Type
    Description
    int
    Enum of type GatewayType .

    setGatewayType

    Optional. The type of the gateway.

    Parameter
    Name
    Description
    var
    int

    Enum of type GatewayType .

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