Interface PluginInstanceOrBuilder

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

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

    • getName

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

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

      String getDisplayName()
       Required. The display name for this plugin instance. Max length is 255
       characters.
       
      string display_name = 2 [(.google.api.field_behavior) = REQUIRED];
      Returns:
      The displayName.
    • getDisplayNameBytes

      com.google.protobuf.ByteString getDisplayNameBytes()
       Required. The display name for this plugin instance. Max length is 255
       characters.
       
      string display_name = 2 [(.google.api.field_behavior) = REQUIRED];
      Returns:
      The bytes for displayName.
    • hasAuthConfig

      boolean hasAuthConfig()
       Optional. The authentication information for this plugin instance.
       
      .google.cloud.apihub.v1.AuthConfig auth_config = 3 [(.google.api.field_behavior) = OPTIONAL];
      Returns:
      Whether the authConfig field is set.
    • getAuthConfig

      AuthConfig getAuthConfig()
       Optional. The authentication information for this plugin instance.
       
      .google.cloud.apihub.v1.AuthConfig auth_config = 3 [(.google.api.field_behavior) = OPTIONAL];
      Returns:
      The authConfig.
    • getAuthConfigOrBuilder

      AuthConfigOrBuilder getAuthConfigOrBuilder()
       Optional. The authentication information for this plugin instance.
       
      .google.cloud.apihub.v1.AuthConfig auth_config = 3 [(.google.api.field_behavior) = OPTIONAL];
    • getAdditionalConfigCount

      int getAdditionalConfigCount()
       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.
       
      map<string, .google.cloud.apihub.v1.ConfigVariable> additional_config = 4 [(.google.api.field_behavior) = OPTIONAL];
    • containsAdditionalConfig

      boolean containsAdditionalConfig(String key)
       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.
       
      map<string, .google.cloud.apihub.v1.ConfigVariable> additional_config = 4 [(.google.api.field_behavior) = OPTIONAL];
    • getAdditionalConfig

      @Deprecated Map<String,ConfigVariable> getAdditionalConfig()
      Deprecated.
    • getAdditionalConfigMap

      Map<String,ConfigVariable> getAdditionalConfigMap()
       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.
       
      map<string, .google.cloud.apihub.v1.ConfigVariable> additional_config = 4 [(.google.api.field_behavior) = OPTIONAL];
    • getAdditionalConfigOrDefault

      ConfigVariable getAdditionalConfigOrDefault(String key, ConfigVariable defaultValue)
       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.
       
      map<string, .google.cloud.apihub.v1.ConfigVariable> additional_config = 4 [(.google.api.field_behavior) = OPTIONAL];
    • getAdditionalConfigOrThrow

      ConfigVariable getAdditionalConfigOrThrow(String key)
       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.
       
      map<string, .google.cloud.apihub.v1.ConfigVariable> additional_config = 4 [(.google.api.field_behavior) = OPTIONAL];
    • getStateValue

      int getStateValue()
       Output only. The current state of the plugin instance (e.g., enabled,
       disabled, provisioning).
       
      .google.cloud.apihub.v1.PluginInstance.State state = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Returns:
      The enum numeric value on the wire for state.
    • getState

       Output only. The current state of the plugin instance (e.g., enabled,
       disabled, provisioning).
       
      .google.cloud.apihub.v1.PluginInstance.State state = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Returns:
      The state.
    • getErrorMessage

      String 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.
       
      string error_message = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Returns:
      The errorMessage.
    • getErrorMessageBytes

      com.google.protobuf.ByteString getErrorMessageBytes()
       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.
       
      string error_message = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Returns:
      The bytes for errorMessage.
    • getActionsList

      List<PluginInstanceAction> getActionsList()
       Required. The action status for the plugin instance.
       
      repeated .google.cloud.apihub.v1.PluginInstanceAction actions = 7 [(.google.api.field_behavior) = REQUIRED];
    • getActions

      PluginInstanceAction getActions(int index)
       Required. The action status for the plugin instance.
       
      repeated .google.cloud.apihub.v1.PluginInstanceAction actions = 7 [(.google.api.field_behavior) = REQUIRED];
    • getActionsCount

      int getActionsCount()
       Required. The action status for the plugin instance.
       
      repeated .google.cloud.apihub.v1.PluginInstanceAction actions = 7 [(.google.api.field_behavior) = REQUIRED];
    • getActionsOrBuilderList

      List<? extends PluginInstanceActionOrBuilder> getActionsOrBuilderList()
       Required. The action status for the plugin instance.
       
      repeated .google.cloud.apihub.v1.PluginInstanceAction actions = 7 [(.google.api.field_behavior) = REQUIRED];
    • getActionsOrBuilder

      PluginInstanceActionOrBuilder getActionsOrBuilder(int index)
       Required. The action status for the plugin instance.
       
      repeated .google.cloud.apihub.v1.PluginInstanceAction actions = 7 [(.google.api.field_behavior) = REQUIRED];
    • hasCreateTime

      boolean hasCreateTime()
       Output only. Timestamp indicating when the plugin instance was created.
       
      .google.protobuf.Timestamp create_time = 9 [(.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 instance was created.
       
      .google.protobuf.Timestamp create_time = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Returns:
      The createTime.
    • getCreateTimeOrBuilder

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

      boolean hasUpdateTime()
       Output only. Timestamp indicating when the plugin instance was last
       updated.
       
      .google.protobuf.Timestamp update_time = 10 [(.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 instance was last
       updated.
       
      .google.protobuf.Timestamp update_time = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Returns:
      The updateTime.
    • getUpdateTimeOrBuilder

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

      String 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.
       
      string source_project_id = 11 [(.google.api.field_behavior) = OPTIONAL];
      Returns:
      The sourceProjectId.
    • getSourceProjectIdBytes

      com.google.protobuf.ByteString getSourceProjectIdBytes()
       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.
       
      string source_project_id = 11 [(.google.api.field_behavior) = OPTIONAL];
      Returns:
      The bytes for sourceProjectId.