Interface PluginOrBuilder

All Superinterfaces:
com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder
All Known Implementing Classes:
Plugin, Plugin.Builder

@Generated public interface PluginOrBuilder extends com.google.protobuf.MessageOrBuilder
  • Method Details

    • getName

      String getName()
       Identifier. The name of the plugin.
       Format: `projects/{project}/locations/{location}/plugins/{plugin}`
       
      string name = 1 [(.google.api.field_behavior) = IDENTIFIER];
      Returns:
      The name.
    • getNameBytes

      com.google.protobuf.ByteString getNameBytes()
       Identifier. The name of the plugin.
       Format: `projects/{project}/locations/{location}/plugins/{plugin}`
       
      string name = 1 [(.google.api.field_behavior) = IDENTIFIER];
      Returns:
      The bytes for name.
    • getDisplayName

      String getDisplayName()
       Required. The display name of the plugin. Max length is 50 characters
       (Unicode code points).
       
      string display_name = 2 [(.google.api.field_behavior) = REQUIRED];
      Returns:
      The displayName.
    • getDisplayNameBytes

      com.google.protobuf.ByteString getDisplayNameBytes()
       Required. The display name of the plugin. Max length is 50 characters
       (Unicode code points).
       
      string display_name = 2 [(.google.api.field_behavior) = REQUIRED];
      Returns:
      The bytes for displayName.
    • hasType

      boolean hasType()
       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.
       
      .google.cloud.apihub.v1.AttributeValues type = 3 [(.google.api.field_behavior) = OPTIONAL];
      Returns:
      Whether the type field is set.
    • getType

      AttributeValues 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.
       
      .google.cloud.apihub.v1.AttributeValues type = 3 [(.google.api.field_behavior) = OPTIONAL];
      Returns:
      The type.
    • getTypeOrBuilder

      AttributeValuesOrBuilder getTypeOrBuilder()
       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.
       
      .google.cloud.apihub.v1.AttributeValues type = 3 [(.google.api.field_behavior) = OPTIONAL];
    • getDescription

      String getDescription()
       Optional. The plugin description. Max length is 2000 characters (Unicode
       code points).
       
      string description = 4 [(.google.api.field_behavior) = OPTIONAL];
      Returns:
      The description.
    • getDescriptionBytes

      com.google.protobuf.ByteString getDescriptionBytes()
       Optional. The plugin description. Max length is 2000 characters (Unicode
       code points).
       
      string description = 4 [(.google.api.field_behavior) = OPTIONAL];
      Returns:
      The bytes for description.
    • getStateValue

      int getStateValue()
       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.
       
      .google.cloud.apihub.v1.Plugin.State state = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Returns:
      The enum numeric value on the wire for state.
    • getState

      Plugin.State 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.
       
      .google.cloud.apihub.v1.Plugin.State state = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Returns:
      The state.
    • getOwnershipTypeValue

      int getOwnershipTypeValue()
       Output only. The type of the plugin, indicating whether it is
       'SYSTEM_OWNED' or 'USER_OWNED'.
       
      .google.cloud.apihub.v1.Plugin.OwnershipType ownership_type = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Returns:
      The enum numeric value on the wire for ownershipType.
    • getOwnershipType

      Plugin.OwnershipType getOwnershipType()
       Output only. The type of the plugin, indicating whether it is
       'SYSTEM_OWNED' or 'USER_OWNED'.
       
      .google.cloud.apihub.v1.Plugin.OwnershipType ownership_type = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Returns:
      The ownershipType.
    • hasHostingService

      boolean hasHostingService()
       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.
       
      .google.cloud.apihub.v1.Plugin.HostingService hosting_service = 7 [(.google.api.field_behavior) = OPTIONAL];
      Returns:
      Whether the hostingService field is set.
    • getHostingService

      Plugin.HostingService 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.
       
      .google.cloud.apihub.v1.Plugin.HostingService hosting_service = 7 [(.google.api.field_behavior) = OPTIONAL];
      Returns:
      The hostingService.
    • getHostingServiceOrBuilder

      Plugin.HostingServiceOrBuilder getHostingServiceOrBuilder()
       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.
       
      .google.cloud.apihub.v1.Plugin.HostingService hosting_service = 7 [(.google.api.field_behavior) = OPTIONAL];
    • getActionsConfigList

      List<PluginActionConfig> getActionsConfigList()
       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.
       
      repeated .google.cloud.apihub.v1.PluginActionConfig actions_config = 8 [(.google.api.field_behavior) = OPTIONAL];
    • getActionsConfig

      PluginActionConfig getActionsConfig(int index)
       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.
       
      repeated .google.cloud.apihub.v1.PluginActionConfig actions_config = 8 [(.google.api.field_behavior) = OPTIONAL];
    • getActionsConfigCount

      int getActionsConfigCount()
       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.
       
      repeated .google.cloud.apihub.v1.PluginActionConfig actions_config = 8 [(.google.api.field_behavior) = OPTIONAL];
    • getActionsConfigOrBuilderList

      List<? extends PluginActionConfigOrBuilder> getActionsConfigOrBuilderList()
       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.
       
      repeated .google.cloud.apihub.v1.PluginActionConfig actions_config = 8 [(.google.api.field_behavior) = OPTIONAL];
    • getActionsConfigOrBuilder

      PluginActionConfigOrBuilder getActionsConfigOrBuilder(int index)
       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.
       
      repeated .google.cloud.apihub.v1.PluginActionConfig actions_config = 8 [(.google.api.field_behavior) = OPTIONAL];
    • hasDocumentation

      boolean hasDocumentation()
       Optional. The documentation of the plugin, that explains how to set up and
       use the plugin.
       
      .google.cloud.apihub.v1.Documentation documentation = 9 [(.google.api.field_behavior) = OPTIONAL];
      Returns:
      Whether the documentation field is set.
    • getDocumentation

      Documentation getDocumentation()
       Optional. The documentation of the plugin, that explains how to set up and
       use the plugin.
       
      .google.cloud.apihub.v1.Documentation documentation = 9 [(.google.api.field_behavior) = OPTIONAL];
      Returns:
      The documentation.
    • getDocumentationOrBuilder

      DocumentationOrBuilder getDocumentationOrBuilder()
       Optional. The documentation of the plugin, that explains how to set up and
       use the plugin.
       
      .google.cloud.apihub.v1.Documentation documentation = 9 [(.google.api.field_behavior) = OPTIONAL];
    • getPluginCategoryValue

      int getPluginCategoryValue()
       Optional. The category of the plugin, identifying its primary category or
       purpose. This field is required for all plugins.
       
      .google.cloud.apihub.v1.PluginCategory plugin_category = 11 [(.google.api.field_behavior) = OPTIONAL];
      Returns:
      The enum numeric value on the wire for pluginCategory.
    • getPluginCategory

      PluginCategory getPluginCategory()
       Optional. The category of the plugin, identifying its primary category or
       purpose. This field is required for all plugins.
       
      .google.cloud.apihub.v1.PluginCategory plugin_category = 11 [(.google.api.field_behavior) = OPTIONAL];
      Returns:
      The pluginCategory.
    • hasConfigTemplate

      boolean hasConfigTemplate()
       Optional. The configuration template for the plugin.
       
      .google.cloud.apihub.v1.Plugin.ConfigTemplate config_template = 12 [(.google.api.field_behavior) = OPTIONAL];
      Returns:
      Whether the configTemplate field is set.
    • getConfigTemplate

      Plugin.ConfigTemplate getConfigTemplate()
       Optional. The configuration template for the plugin.
       
      .google.cloud.apihub.v1.Plugin.ConfigTemplate config_template = 12 [(.google.api.field_behavior) = OPTIONAL];
      Returns:
      The configTemplate.
    • getConfigTemplateOrBuilder

      Plugin.ConfigTemplateOrBuilder getConfigTemplateOrBuilder()
       Optional. The configuration template for the plugin.
       
      .google.cloud.apihub.v1.Plugin.ConfigTemplate config_template = 12 [(.google.api.field_behavior) = OPTIONAL];
    • hasCreateTime

      boolean hasCreateTime()
       Output only. Timestamp indicating when the plugin was created.
       
      .google.protobuf.Timestamp create_time = 13 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Returns:
      Whether the createTime field is set.
    • getCreateTime

      com.google.protobuf.Timestamp getCreateTime()
       Output only. Timestamp indicating when the plugin was created.
       
      .google.protobuf.Timestamp create_time = 13 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Returns:
      The createTime.
    • getCreateTimeOrBuilder

      com.google.protobuf.TimestampOrBuilder getCreateTimeOrBuilder()
       Output only. Timestamp indicating when the plugin was created.
       
      .google.protobuf.Timestamp create_time = 13 [(.google.api.field_behavior) = OUTPUT_ONLY];
    • hasUpdateTime

      boolean hasUpdateTime()
       Output only. Timestamp indicating when the plugin was last updated.
       
      .google.protobuf.Timestamp update_time = 14 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Returns:
      Whether the updateTime field is set.
    • getUpdateTime

      com.google.protobuf.Timestamp getUpdateTime()
       Output only. Timestamp indicating when the plugin was last updated.
       
      .google.protobuf.Timestamp update_time = 14 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Returns:
      The updateTime.
    • getUpdateTimeOrBuilder

      com.google.protobuf.TimestampOrBuilder getUpdateTimeOrBuilder()
       Output only. Timestamp indicating when the plugin was last updated.
       
      .google.protobuf.Timestamp update_time = 14 [(.google.api.field_behavior) = OUTPUT_ONLY];
    • getGatewayTypeValue

      int getGatewayTypeValue()
       Optional. The type of the gateway.
       
      .google.cloud.apihub.v1.GatewayType gateway_type = 15 [(.google.api.field_behavior) = OPTIONAL];
      Returns:
      The enum numeric value on the wire for gatewayType.
    • getGatewayType

      GatewayType getGatewayType()
       Optional. The type of the gateway.
       
      .google.cloud.apihub.v1.GatewayType gateway_type = 15 [(.google.api.field_behavior) = OPTIONAL];
      Returns:
      The gatewayType.