public final class PluginInstance extends GeneratedMessageV3 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
Inherited Members
com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT)
com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT,int)
com.google.protobuf.GeneratedMessageV3.<T>emptyList(java.lang.Class<T>)
com.google.protobuf.GeneratedMessageV3.internalGetMapFieldReflection(int)
Static Fields
ACTIONS_FIELD_NUMBER
public static final int ACTIONS_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
ADDITIONAL_CONFIG_FIELD_NUMBER
public static final int ADDITIONAL_CONFIG_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
AUTH_CONFIG_FIELD_NUMBER
public static final int AUTH_CONFIG_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
CREATE_TIME_FIELD_NUMBER
public static final int CREATE_TIME_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
DISPLAY_NAME_FIELD_NUMBER
public static final int DISPLAY_NAME_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
ERROR_MESSAGE_FIELD_NUMBER
public static final int ERROR_MESSAGE_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
NAME_FIELD_NUMBER
public static final int NAME_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
SOURCE_PROJECT_ID_FIELD_NUMBER
public static final int SOURCE_PROJECT_ID_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
STATE_FIELD_NUMBER
public static final int STATE_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
UPDATE_TIME_FIELD_NUMBER
public static final int UPDATE_TIME_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
Static Methods
getDefaultInstance()
public static PluginInstance getDefaultInstance()
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()
newBuilder()
public static PluginInstance.Builder newBuilder()
newBuilder(PluginInstance prototype)
public static PluginInstance.Builder newBuilder(PluginInstance prototype)
public static PluginInstance parseDelimitedFrom(InputStream input)
public static PluginInstance parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
parseFrom(byte[] data)
public static PluginInstance parseFrom(byte[] data)
| Parameter |
| Name |
Description |
data |
byte[]
|
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static PluginInstance parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
parseFrom(ByteString data)
public static PluginInstance parseFrom(ByteString data)
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static PluginInstance parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static PluginInstance parseFrom(CodedInputStream input)
public static PluginInstance parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public static PluginInstance parseFrom(InputStream input)
public static PluginInstance parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
parseFrom(ByteBuffer data)
public static PluginInstance parseFrom(ByteBuffer data)
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static PluginInstance parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
parser()
public static Parser<PluginInstance> parser()
Methods
containsAdditionalConfig(String key)
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];
| Parameter |
| Name |
Description |
key |
String
|
equals(Object obj)
public boolean equals(Object obj)
| Parameter |
| Name |
Description |
obj |
Object
|
Overrides
getActions(int index)
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];
| Parameter |
| Name |
Description |
index |
int
|
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];
| Returns |
| Type |
Description |
int |
|
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];
getActionsOrBuilder(int index)
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];
| Parameter |
| Name |
Description |
index |
int
|
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];
| Returns |
| Type |
Description |
List<? extends com.google.cloud.apihub.v1.PluginInstanceActionOrBuilder> |
|
getAdditionalConfig() (deprecated)
public Map<String,ConfigVariable> getAdditionalConfig()
getAdditionalConfigCount()
public 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 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(String key, ConfigVariable defaultValue)
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];
getAdditionalConfigOrThrow(String key)
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];
| Parameter |
| Name |
Description |
key |
String
|
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];
| Returns |
| Type |
Description |
AuthConfig |
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];
getCreateTime()
public 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 TimestampOrBuilder getCreateTimeOrBuilder()
Output only. Timestamp indicating when the plugin instance was created.
.google.protobuf.Timestamp create_time = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];
getDefaultInstanceForType()
public PluginInstance getDefaultInstanceForType()
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];
| Returns |
| Type |
Description |
String |
The displayName.
|
getDisplayNameBytes()
public 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 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 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()
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 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.
|
getParserForType()
public Parser<PluginInstance> getParserForType()
Overrides
getSerializedSize()
public int getSerializedSize()
| Returns |
| Type |
Description |
int |
|
Overrides
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];
| Returns |
| Type |
Description |
String |
The sourceProjectId.
|
getSourceProjectIdBytes()
public 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 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];
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];
| Returns |
| Type |
Description |
int |
The enum numeric value on the wire for state.
|
getUpdateTime()
public 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 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];
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];
| Returns |
| Type |
Description |
boolean |
Whether the authConfig field is set.
|
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];
| Returns |
| Type |
Description |
boolean |
Whether the createTime field is set.
|
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];
| Returns |
| Type |
Description |
boolean |
Whether the updateTime field is set.
|
hashCode()
| Returns |
| Type |
Description |
int |
|
Overrides
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Overrides
internalGetMapFieldReflection(int number)
protected MapFieldReflectionAccessor internalGetMapFieldReflection(int number)
| Parameter |
| Name |
Description |
number |
int
|
| Returns |
| Type |
Description |
com.google.protobuf.MapFieldReflectionAccessor |
|
Overrides
com.google.protobuf.GeneratedMessageV3.internalGetMapFieldReflection(int)
isInitialized()
public final boolean isInitialized()
Overrides
newBuilderForType()
public PluginInstance.Builder newBuilderForType()
newBuilderForType(GeneratedMessageV3.BuilderParent parent)
protected PluginInstance.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Overrides
newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
| Returns |
| Type |
Description |
Object |
|
Overrides
toBuilder()
public PluginInstance.Builder toBuilder()
writeTo(CodedOutputStream output)
public void writeTo(CodedOutputStream output)
Overrides
