Some or all of the information on this page might not apply to Trusted Cloud by S3NS. See Differences from Google Cloud for more details.

Interface PluginInstanceOrBuilder (0.28.0)

public interface PluginInstanceOrBuilder extends MessageOrBuilder

Implements

MessageOrBuilder

Methods

containsAdditionalConfig(String key)

public abstract 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];

Parameter
Name	Description
`key`	`String`

Returns
Type	Description
`boolean`

getActions(int index)

public abstract 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];

Parameter
Name	Description
`index`	`int`

Returns
Type	Description
`PluginInstanceAction`

getActionsCount()

public abstract int getActionsCount()

Required. The action status for the plugin instance.

repeated .google.cloud.apihub.v1.PluginInstanceAction actions = 7 [(.google.api.field_behavior) = REQUIRED];

Returns
Type	Description
`int`

getActionsList()

public abstract List<PluginInstanceAction> getActionsList()

Required. The action status for the plugin instance.

repeated .google.cloud.apihub.v1.PluginInstanceAction actions = 7 [(.google.api.field_behavior) = REQUIRED];

Returns
Type	Description
`List<PluginInstanceAction>`

getActionsOrBuilder(int index)

public abstract 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];

Parameter
Name	Description
`index`	`int`

Returns
Type	Description
`PluginInstanceActionOrBuilder`

getActionsOrBuilderList()

public abstract 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];

Returns
Type	Description
`List<? extends com.google.cloud.apihub.v1.PluginInstanceActionOrBuilder>`

getAdditionalConfig() (deprecated)

public abstract Map<String,ConfigVariable> getAdditionalConfig()

Use #getAdditionalConfigMap() instead.

Returns
Type	Description
`Map<String,ConfigVariable>`

getAdditionalConfigCount()

public abstract 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];

Returns
Type	Description
`int`

getAdditionalConfigMap()

public abstract 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];

Returns
Type	Description
`Map<String,ConfigVariable>`

getAdditionalConfigOrDefault(String key, ConfigVariable defaultValue)

public abstract 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];

Parameters
Name	Description
`key`	`String`
`defaultValue`	`ConfigVariable`

Returns
Type	Description
`ConfigVariable`

getAdditionalConfigOrThrow(String key)

public abstract 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];

Parameter
Name	Description
`key`	`String`

Returns
Type	Description
`ConfigVariable`

getAuthConfig()

public abstract AuthConfig getAuthConfig()

Optional. The authentication information for this plugin instance.

.google.cloud.apihub.v1.AuthConfig auth_config = 3 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
`AuthConfig`	The authConfig.

getAuthConfigOrBuilder()

public abstract AuthConfigOrBuilder getAuthConfigOrBuilder()

Optional. The authentication information for this plugin instance.

.google.cloud.apihub.v1.AuthConfig auth_config = 3 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
`AuthConfigOrBuilder`

getCreateTime()

public abstract 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
Type	Description
`Timestamp`	The createTime.

getCreateTimeOrBuilder()

public abstract TimestampOrBuilder getCreateTimeOrBuilder()

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

.google.protobuf.Timestamp create_time = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
`TimestampOrBuilder`

getDisplayName()

public abstract 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
Type	Description
`String`	The displayName.

getDisplayNameBytes()

public abstract 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
Type	Description
`ByteString`	The bytes for displayName.

getErrorMessage()

public abstract 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
Type	Description
`String`	The errorMessage.

getErrorMessageBytes()

public abstract 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
Type	Description
`ByteString`	The bytes for errorMessage.

getName()

public abstract 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
Type	Description
`String`	The name.

getNameBytes()

public abstract 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
Type	Description
`ByteString`	The bytes for name.

getSourceProjectId()

public abstract 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
Type	Description
`String`	The sourceProjectId.

getSourceProjectIdBytes()

public abstract 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
Type	Description
`ByteString`	The bytes for sourceProjectId.

getState()

public abstract 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];

Returns
Type	Description
`PluginInstance.State`	The state.

getStateValue()

public abstract 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
Type	Description
`int`	The enum numeric value on the wire for state.

getUpdateTime()

public abstract 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
Type	Description
`Timestamp`	The updateTime.

getUpdateTimeOrBuilder()

public abstract 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];

Returns
Type	Description
`TimestampOrBuilder`

hasAuthConfig()

public abstract boolean hasAuthConfig()

Optional. The authentication information for this plugin instance.

.google.cloud.apihub.v1.AuthConfig auth_config = 3 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
`boolean`	Whether the authConfig field is set.

hasCreateTime()

public abstract 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
Type	Description
`boolean`	Whether the createTime field is set.

hasUpdateTime()

public abstract 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
Type	Description
`boolean`	Whether the updateTime field is set.

Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License, and code samples are licensed under the Apache 2.0 License. For details, see the Google Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.

Last updated 2025-10-02 UTC.