Class PluginInstance

java.lang.Object
com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessage
com.google.protobuf.GeneratedMessage
com.google.cloud.apihub.v1.PluginInstance
All Implemented Interfaces:
PluginInstanceOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable

@Generated public final class PluginInstance extends com.google.protobuf.GeneratedMessage implements PluginInstanceOrBuilder
 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.
 
Protobuf type google.cloud.apihub.v1.PluginInstance
See Also:
  • Field Details

    • NAME_FIELD_NUMBER

      public static final int NAME_FIELD_NUMBER
      See Also:
    • DISPLAY_NAME_FIELD_NUMBER

      public static final int DISPLAY_NAME_FIELD_NUMBER
      See Also:
    • AUTH_CONFIG_FIELD_NUMBER

      public static final int AUTH_CONFIG_FIELD_NUMBER
      See Also:
    • ADDITIONAL_CONFIG_FIELD_NUMBER

      public static final int ADDITIONAL_CONFIG_FIELD_NUMBER
      See Also:
    • STATE_FIELD_NUMBER

      public static final int STATE_FIELD_NUMBER
      See Also:
    • ERROR_MESSAGE_FIELD_NUMBER

      public static final int ERROR_MESSAGE_FIELD_NUMBER
      See Also:
    • ACTIONS_FIELD_NUMBER

      public static final int ACTIONS_FIELD_NUMBER
      See Also:
    • CREATE_TIME_FIELD_NUMBER

      public static final int CREATE_TIME_FIELD_NUMBER
      See Also:
    • UPDATE_TIME_FIELD_NUMBER

      public static final int UPDATE_TIME_FIELD_NUMBER
      See Also:
    • SOURCE_PROJECT_ID_FIELD_NUMBER

      public static final int SOURCE_PROJECT_ID_FIELD_NUMBER
      See Also:
  • Method Details

    • getDescriptor

      public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()
    • internalGetMapFieldReflection

      protected com.google.protobuf.MapFieldReflectionAccessor internalGetMapFieldReflection(int number)
      Overrides:
      internalGetMapFieldReflection in class com.google.protobuf.GeneratedMessage
    • internalGetFieldAccessorTable

      protected com.google.protobuf.GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()
      Specified by:
      internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessage
    • getName

      public 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];
      Specified by:
      getName in interface PluginInstanceOrBuilder
      Returns:
      The name.
    • getNameBytes

      public 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];
      Specified by:
      getNameBytes in interface PluginInstanceOrBuilder
      Returns:
      The bytes for name.
    • getDisplayName

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

      public 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];
      Specified by:
      getDisplayNameBytes in interface PluginInstanceOrBuilder
      Returns:
      The bytes for displayName.
    • hasAuthConfig

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

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

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

      public int getAdditionalConfigCount()
      Description copied from interface: PluginInstanceOrBuilder
       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];
      Specified by:
      getAdditionalConfigCount in interface PluginInstanceOrBuilder
    • containsAdditionalConfig

      public 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];
      Specified by:
      containsAdditionalConfig in interface PluginInstanceOrBuilder
    • getAdditionalConfig

      @Deprecated public Map<String,ConfigVariable> getAdditionalConfig()
      Deprecated.
      Specified by:
      getAdditionalConfig in interface PluginInstanceOrBuilder
    • getAdditionalConfigMap

      public 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];
      Specified by:
      getAdditionalConfigMap in interface PluginInstanceOrBuilder
    • getAdditionalConfigOrDefault

      public 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];
      Specified by:
      getAdditionalConfigOrDefault in interface PluginInstanceOrBuilder
    • getAdditionalConfigOrThrow

      public 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];
      Specified by:
      getAdditionalConfigOrThrow in interface PluginInstanceOrBuilder
    • getStateValue

      public 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];
      Specified by:
      getStateValue in interface PluginInstanceOrBuilder
      Returns:
      The enum numeric value on the wire for state.
    • getState

      public PluginInstance.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];
      Specified by:
      getState in interface PluginInstanceOrBuilder
      Returns:
      The state.
    • getErrorMessage

      public 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];
      Specified by:
      getErrorMessage in interface PluginInstanceOrBuilder
      Returns:
      The errorMessage.
    • getErrorMessageBytes

      public 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];
      Specified by:
      getErrorMessageBytes in interface PluginInstanceOrBuilder
      Returns:
      The bytes for errorMessage.
    • getActionsList

      public List<PluginInstanceAction> getActionsList()
       Required. The action status for the plugin instance.
       
      repeated .google.cloud.apihub.v1.PluginInstanceAction actions = 7 [(.google.api.field_behavior) = REQUIRED];
      Specified by:
      getActionsList in interface PluginInstanceOrBuilder
    • getActionsOrBuilderList

      public 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];
      Specified by:
      getActionsOrBuilderList in interface PluginInstanceOrBuilder
    • getActionsCount

      public int getActionsCount()
       Required. The action status for the plugin instance.
       
      repeated .google.cloud.apihub.v1.PluginInstanceAction actions = 7 [(.google.api.field_behavior) = REQUIRED];
      Specified by:
      getActionsCount in interface PluginInstanceOrBuilder
    • getActions

      public 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];
      Specified by:
      getActions in interface PluginInstanceOrBuilder
    • getActionsOrBuilder

      public 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];
      Specified by:
      getActionsOrBuilder in interface PluginInstanceOrBuilder
    • hasCreateTime

      public boolean hasCreateTime()
       Output only. Timestamp indicating when the plugin instance was created.
       
      .google.protobuf.Timestamp create_time = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      hasCreateTime in interface PluginInstanceOrBuilder
      Returns:
      Whether the createTime field is set.
    • getCreateTime

      public 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];
      Specified by:
      getCreateTime in interface PluginInstanceOrBuilder
      Returns:
      The createTime.
    • getCreateTimeOrBuilder

      public 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];
      Specified by:
      getCreateTimeOrBuilder in interface PluginInstanceOrBuilder
    • hasUpdateTime

      public 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];
      Specified by:
      hasUpdateTime in interface PluginInstanceOrBuilder
      Returns:
      Whether the updateTime field is set.
    • getUpdateTime

      public 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];
      Specified by:
      getUpdateTime in interface PluginInstanceOrBuilder
      Returns:
      The updateTime.
    • getUpdateTimeOrBuilder

      public 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];
      Specified by:
      getUpdateTimeOrBuilder in interface PluginInstanceOrBuilder
    • getSourceProjectId

      public 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];
      Specified by:
      getSourceProjectId in interface PluginInstanceOrBuilder
      Returns:
      The sourceProjectId.
    • getSourceProjectIdBytes

      public 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];
      Specified by:
      getSourceProjectIdBytes in interface PluginInstanceOrBuilder
      Returns:
      The bytes for sourceProjectId.
    • isInitialized

      public final boolean isInitialized()
      Specified by:
      isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
      Overrides:
      isInitialized in class com.google.protobuf.GeneratedMessage
    • writeTo

      public void writeTo(com.google.protobuf.CodedOutputStream output) throws IOException
      Specified by:
      writeTo in interface com.google.protobuf.MessageLite
      Overrides:
      writeTo in class com.google.protobuf.GeneratedMessage
      Throws:
      IOException
    • getSerializedSize

      public int getSerializedSize()
      Specified by:
      getSerializedSize in interface com.google.protobuf.MessageLite
      Overrides:
      getSerializedSize in class com.google.protobuf.GeneratedMessage
    • equals

      public boolean equals(Object obj)
      Specified by:
      equals in interface com.google.protobuf.Message
      Overrides:
      equals in class com.google.protobuf.AbstractMessage
    • hashCode

      public int hashCode()
      Specified by:
      hashCode in interface com.google.protobuf.Message
      Overrides:
      hashCode in class com.google.protobuf.AbstractMessage
    • parseFrom

      public static PluginInstance parseFrom(ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException
    • parseFrom

      public static PluginInstance parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException
    • parseFrom

      public static PluginInstance parseFrom(com.google.protobuf.ByteString data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException
    • parseFrom

      public static PluginInstance parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException
    • parseFrom

      public static PluginInstance parseFrom(byte[] data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException
    • parseFrom

      public static PluginInstance parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException
    • parseFrom

      public static PluginInstance parseFrom(InputStream input) throws IOException
      Throws:
      IOException
    • parseFrom

      public static PluginInstance parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException
    • parseDelimitedFrom

      public static PluginInstance parseDelimitedFrom(InputStream input) throws IOException
      Throws:
      IOException
    • parseDelimitedFrom

      public static PluginInstance parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException
    • parseFrom

      public static PluginInstance parseFrom(com.google.protobuf.CodedInputStream input) throws IOException
      Throws:
      IOException
    • parseFrom

      public static PluginInstance parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException
    • newBuilderForType

      public PluginInstance.Builder newBuilderForType()
      Specified by:
      newBuilderForType in interface com.google.protobuf.Message
      Specified by:
      newBuilderForType in interface com.google.protobuf.MessageLite
    • newBuilder

      public static PluginInstance.Builder newBuilder()
    • newBuilder

      public static PluginInstance.Builder newBuilder(PluginInstance prototype)
    • toBuilder

      public PluginInstance.Builder toBuilder()
      Specified by:
      toBuilder in interface com.google.protobuf.Message
      Specified by:
      toBuilder in interface com.google.protobuf.MessageLite
    • newBuilderForType

      protected PluginInstance.Builder newBuilderForType(com.google.protobuf.AbstractMessage.BuilderParent parent)
      Overrides:
      newBuilderForType in class com.google.protobuf.AbstractMessage
    • getDefaultInstance

      public static PluginInstance getDefaultInstance()
    • parser

      public static com.google.protobuf.Parser<PluginInstance> parser()
    • getParserForType

      public com.google.protobuf.Parser<PluginInstance> getParserForType()
      Specified by:
      getParserForType in interface com.google.protobuf.Message
      Specified by:
      getParserForType in interface com.google.protobuf.MessageLite
      Overrides:
      getParserForType in class com.google.protobuf.GeneratedMessage
    • getDefaultInstanceForType

      public PluginInstance getDefaultInstanceForType()
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder