public static final class PluginInstance.Builder extends GeneratedMessageV3.Builder<PluginInstance.Builder> implements PluginInstanceOrBuilderRepresents 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
Inheritance
Object > AbstractMessageLite.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessageV3.Builder > PluginInstance.BuilderImplements
PluginInstanceOrBuilderStatic Methods
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()| Returns | |
|---|---|
| Type | Description |
Descriptor |
|
Methods
addActions(PluginInstanceAction value)
public PluginInstance.Builder addActions(PluginInstanceAction value)Required. The action status for the plugin instance.
repeated .google.cloud.apihub.v1.PluginInstanceAction actions = 7 [(.google.api.field_behavior) = REQUIRED];
| Parameter | |
|---|---|
| Name | Description |
value |
PluginInstanceAction |
| Returns | |
|---|---|
| Type | Description |
PluginInstance.Builder |
|
addActions(PluginInstanceAction.Builder builderForValue)
public PluginInstance.Builder addActions(PluginInstanceAction.Builder builderForValue)Required. The action status for the plugin instance.
repeated .google.cloud.apihub.v1.PluginInstanceAction actions = 7 [(.google.api.field_behavior) = REQUIRED];
| Parameter | |
|---|---|
| Name | Description |
builderForValue |
PluginInstanceAction.Builder |
| Returns | |
|---|---|
| Type | Description |
PluginInstance.Builder |
|
addActions(int index, PluginInstanceAction value)
public PluginInstance.Builder addActions(int index, PluginInstanceAction value)Required. The action status for the plugin instance.
repeated .google.cloud.apihub.v1.PluginInstanceAction actions = 7 [(.google.api.field_behavior) = REQUIRED];
| Parameters | |
|---|---|
| Name | Description |
index |
int |
value |
PluginInstanceAction |
| Returns | |
|---|---|
| Type | Description |
PluginInstance.Builder |
|
addActions(int index, PluginInstanceAction.Builder builderForValue)
public PluginInstance.Builder addActions(int index, PluginInstanceAction.Builder builderForValue)Required. The action status for the plugin instance.
repeated .google.cloud.apihub.v1.PluginInstanceAction actions = 7 [(.google.api.field_behavior) = REQUIRED];
| Parameters | |
|---|---|
| Name | Description |
index |
int |
builderForValue |
PluginInstanceAction.Builder |
| Returns | |
|---|---|
| Type | Description |
PluginInstance.Builder |
|
addActionsBuilder()
public PluginInstanceAction.Builder addActionsBuilder()Required. The action status for the plugin instance.
repeated .google.cloud.apihub.v1.PluginInstanceAction actions = 7 [(.google.api.field_behavior) = REQUIRED];
| Returns | |
|---|---|
| Type | Description |
PluginInstanceAction.Builder |
|
addActionsBuilder(int index)
public PluginInstanceAction.Builder addActionsBuilder(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.Builder |
|
addAllActions(Iterable<? extends PluginInstanceAction> values)
public PluginInstance.Builder addAllActions(Iterable<? extends PluginInstanceAction> values)Required. The action status for the plugin instance.
repeated .google.cloud.apihub.v1.PluginInstanceAction actions = 7 [(.google.api.field_behavior) = REQUIRED];
| Parameter | |
|---|---|
| Name | Description |
values |
Iterable<? extends com.google.cloud.apihub.v1.PluginInstanceAction> |
| Returns | |
|---|---|
| Type | Description |
PluginInstance.Builder |
|
addRepeatedField(Descriptors.FieldDescriptor field, Object value)
public PluginInstance.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)| Parameters | |
|---|---|
| Name | Description |
field |
FieldDescriptor |
value |
Object |
| Returns | |
|---|---|
| Type | Description |
PluginInstance.Builder |
|
build()
public PluginInstance build()| Returns | |
|---|---|
| Type | Description |
PluginInstance |
|
buildPartial()
public PluginInstance buildPartial()| Returns | |
|---|---|
| Type | Description |
PluginInstance |
|
clear()
public PluginInstance.Builder clear()| Returns | |
|---|---|
| Type | Description |
PluginInstance.Builder |
|
clearActions()
public PluginInstance.Builder clearActions()Required. The action status for the plugin instance.
repeated .google.cloud.apihub.v1.PluginInstanceAction actions = 7 [(.google.api.field_behavior) = REQUIRED];
| Returns | |
|---|---|
| Type | Description |
PluginInstance.Builder |
|
clearAdditionalConfig()
public PluginInstance.Builder clearAdditionalConfig()| Returns | |
|---|---|
| Type | Description |
PluginInstance.Builder |
|
clearAuthConfig()
public PluginInstance.Builder clearAuthConfig()Optional. The authentication information for this plugin instance.
.google.cloud.apihub.v1.AuthConfig auth_config = 3 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
PluginInstance.Builder |
|
clearCreateTime()
public PluginInstance.Builder clearCreateTime()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 |
PluginInstance.Builder |
|
clearDisplayName()
public PluginInstance.Builder clearDisplayName()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 |
PluginInstance.Builder |
This builder for chaining. |
clearErrorMessage()
public PluginInstance.Builder clearErrorMessage()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 |
PluginInstance.Builder |
This builder for chaining. |
clearField(Descriptors.FieldDescriptor field)
public PluginInstance.Builder clearField(Descriptors.FieldDescriptor field)| Parameter | |
|---|---|
| Name | Description |
field |
FieldDescriptor |
| Returns | |
|---|---|
| Type | Description |
PluginInstance.Builder |
|
clearName()
public PluginInstance.Builder clearName() 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 |
PluginInstance.Builder |
This builder for chaining. |
clearOneof(Descriptors.OneofDescriptor oneof)
public PluginInstance.Builder clearOneof(Descriptors.OneofDescriptor oneof)| Parameter | |
|---|---|
| Name | Description |
oneof |
OneofDescriptor |
| Returns | |
|---|---|
| Type | Description |
PluginInstance.Builder |
|
clearSourceProjectId()
public PluginInstance.Builder clearSourceProjectId()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 |
PluginInstance.Builder |
This builder for chaining. |
clearState()
public PluginInstance.Builder clearState()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.Builder |
This builder for chaining. |
clearUpdateTime()
public PluginInstance.Builder clearUpdateTime()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 |
PluginInstance.Builder |
|
clone()
public PluginInstance.Builder clone()| Returns | |
|---|---|
| Type | Description |
PluginInstance.Builder |
|
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 |
| Returns | |
|---|---|
| Type | Description |
boolean |
|
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 |
| Returns | |
|---|---|
| Type | Description |
PluginInstanceAction |
|
getActionsBuilder(int index)
public PluginInstanceAction.Builder getActionsBuilder(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.Builder |
|
getActionsBuilderList()
public List<PluginInstanceAction.Builder> getActionsBuilderList()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<Builder> |
|
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];
| Returns | |
|---|---|
| Type | Description |
List<PluginInstanceAction> |
|
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 |
| Returns | |
|---|---|
| Type | Description |
PluginInstanceActionOrBuilder |
|
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()Use #getAdditionalConfigMap() instead.
| Returns | |
|---|---|
| Type | Description |
Map<String,ConfigVariable> |
|
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];
| Returns | |
|---|---|
| Type | Description |
Map<String,ConfigVariable> |
|
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];
| Parameters | |
|---|---|
| Name | Description |
key |
String |
defaultValue |
ConfigVariable |
| Returns | |
|---|---|
| Type | Description |
ConfigVariable |
|
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 |
| Returns | |
|---|---|
| Type | Description |
ConfigVariable |
|
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. |
getAuthConfigBuilder()
public AuthConfig.Builder getAuthConfigBuilder()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.Builder |
|
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];
| Returns | |
|---|---|
| Type | Description |
AuthConfigOrBuilder |
|
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. |
getCreateTimeBuilder()
public Timestamp.Builder getCreateTimeBuilder()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 |
Builder |
|
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];
| Returns | |
|---|---|
| Type | Description |
TimestampOrBuilder |
|
getDefaultInstanceForType()
public PluginInstance getDefaultInstanceForType()| Returns | |
|---|---|
| Type | Description |
PluginInstance |
|
getDescriptorForType()
public Descriptors.Descriptor getDescriptorForType()| Returns | |
|---|---|
| Type | Description |
Descriptor |
|
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. |
getMutableAdditionalConfig() (deprecated)
public Map<String,ConfigVariable> getMutableAdditionalConfig()Use alternate mutation accessors instead.
| Returns | |
|---|---|
| Type | Description |
Map<String,ConfigVariable> |
|
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];
| 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. |
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];
| Returns | |
|---|---|
| Type | Description |
PluginInstance.State |
The state. |
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. |
getUpdateTimeBuilder()
public Timestamp.Builder getUpdateTimeBuilder()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 |
Builder |
|
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];
| Returns | |
|---|---|
| Type | Description |
TimestampOrBuilder |
|
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. |
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()| Returns | |
|---|---|
| Type | Description |
FieldAccessorTable |
|
internalGetMapFieldReflection(int number)
protected MapFieldReflectionAccessor internalGetMapFieldReflection(int number)| Parameter | |
|---|---|
| Name | Description |
number |
int |
| Returns | |
|---|---|
| Type | Description |
com.google.protobuf.MapFieldReflectionAccessor |
|
internalGetMutableMapFieldReflection(int number)
protected MapFieldReflectionAccessor internalGetMutableMapFieldReflection(int number)| Parameter | |
|---|---|
| Name | Description |
number |
int |
| Returns | |
|---|---|
| Type | Description |
com.google.protobuf.MapFieldReflectionAccessor |
|
isInitialized()
public final boolean isInitialized()| Returns | |
|---|---|
| Type | Description |
boolean |
|
mergeAuthConfig(AuthConfig value)
public PluginInstance.Builder mergeAuthConfig(AuthConfig value)Optional. The authentication information for this plugin instance.
.google.cloud.apihub.v1.AuthConfig auth_config = 3 [(.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description |
value |
AuthConfig |
| Returns | |
|---|---|
| Type | Description |
PluginInstance.Builder |
|
mergeCreateTime(Timestamp value)
public PluginInstance.Builder mergeCreateTime(Timestamp value)Output only. Timestamp indicating when the plugin instance was created.
.google.protobuf.Timestamp create_time = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Parameter | |
|---|---|
| Name | Description |
value |
Timestamp |
| Returns | |
|---|---|
| Type | Description |
PluginInstance.Builder |
|
mergeFrom(PluginInstance other)
public PluginInstance.Builder mergeFrom(PluginInstance other)| Parameter | |
|---|---|
| Name | Description |
other |
PluginInstance |
| Returns | |
|---|---|
| Type | Description |
PluginInstance.Builder |
|
mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public PluginInstance.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)| Parameters | |
|---|---|
| Name | Description |
input |
CodedInputStream |
extensionRegistry |
ExtensionRegistryLite |
| Returns | |
|---|---|
| Type | Description |
PluginInstance.Builder |
|
| Exceptions | |
|---|---|
| Type | Description |
IOException |
|
mergeFrom(Message other)
public PluginInstance.Builder mergeFrom(Message other)| Parameter | |
|---|---|
| Name | Description |
other |
Message |
| Returns | |
|---|---|
| Type | Description |
PluginInstance.Builder |
|
mergeUnknownFields(UnknownFieldSet unknownFields)
public final PluginInstance.Builder mergeUnknownFields(UnknownFieldSet unknownFields)| Parameter | |
|---|---|
| Name | Description |
unknownFields |
UnknownFieldSet |
| Returns | |
|---|---|
| Type | Description |
PluginInstance.Builder |
|
mergeUpdateTime(Timestamp value)
public PluginInstance.Builder mergeUpdateTime(Timestamp value)Output only. Timestamp indicating when the plugin instance was last updated.
.google.protobuf.Timestamp update_time = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Parameter | |
|---|---|
| Name | Description |
value |
Timestamp |
| Returns | |
|---|---|
| Type | Description |
PluginInstance.Builder |
|
putAdditionalConfig(String key, ConfigVariable value)
public PluginInstance.Builder putAdditionalConfig(String key, ConfigVariable value)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 |
value |
ConfigVariable |
| Returns | |
|---|---|
| Type | Description |
PluginInstance.Builder |
|
putAdditionalConfigBuilderIfAbsent(String key)
public ConfigVariable.Builder putAdditionalConfigBuilderIfAbsent(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.Builder |
|
putAllAdditionalConfig(Map<String,ConfigVariable> values)
public PluginInstance.Builder putAllAdditionalConfig(Map<String,ConfigVariable> values)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 |
values |
Map<String,ConfigVariable> |
| Returns | |
|---|---|
| Type | Description |
PluginInstance.Builder |
|
removeActions(int index)
public PluginInstance.Builder removeActions(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 |
PluginInstance.Builder |
|
removeAdditionalConfig(String key)
public PluginInstance.Builder removeAdditionalConfig(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 |
PluginInstance.Builder |
|
setActions(int index, PluginInstanceAction value)
public PluginInstance.Builder setActions(int index, PluginInstanceAction value)Required. The action status for the plugin instance.
repeated .google.cloud.apihub.v1.PluginInstanceAction actions = 7 [(.google.api.field_behavior) = REQUIRED];
| Parameters | |
|---|---|
| Name | Description |
index |
int |
value |
PluginInstanceAction |
| Returns | |
|---|---|
| Type | Description |
PluginInstance.Builder |
|
setActions(int index, PluginInstanceAction.Builder builderForValue)
public PluginInstance.Builder setActions(int index, PluginInstanceAction.Builder builderForValue)Required. The action status for the plugin instance.
repeated .google.cloud.apihub.v1.PluginInstanceAction actions = 7 [(.google.api.field_behavior) = REQUIRED];
| Parameters | |
|---|---|
| Name | Description |
index |
int |
builderForValue |
PluginInstanceAction.Builder |
| Returns | |
|---|---|
| Type | Description |
PluginInstance.Builder |
|
setAuthConfig(AuthConfig value)
public PluginInstance.Builder setAuthConfig(AuthConfig value)Optional. The authentication information for this plugin instance.
.google.cloud.apihub.v1.AuthConfig auth_config = 3 [(.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description |
value |
AuthConfig |
| Returns | |
|---|---|
| Type | Description |
PluginInstance.Builder |
|
setAuthConfig(AuthConfig.Builder builderForValue)
public PluginInstance.Builder setAuthConfig(AuthConfig.Builder builderForValue)Optional. The authentication information for this plugin instance.
.google.cloud.apihub.v1.AuthConfig auth_config = 3 [(.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description |
builderForValue |
AuthConfig.Builder |
| Returns | |
|---|---|
| Type | Description |
PluginInstance.Builder |
|
setCreateTime(Timestamp value)
public PluginInstance.Builder setCreateTime(Timestamp value)Output only. Timestamp indicating when the plugin instance was created.
.google.protobuf.Timestamp create_time = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Parameter | |
|---|---|
| Name | Description |
value |
Timestamp |
| Returns | |
|---|---|
| Type | Description |
PluginInstance.Builder |
|
setCreateTime(Timestamp.Builder builderForValue)
public PluginInstance.Builder setCreateTime(Timestamp.Builder builderForValue)Output only. Timestamp indicating when the plugin instance was created.
.google.protobuf.Timestamp create_time = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Parameter | |
|---|---|
| Name | Description |
builderForValue |
Builder |
| Returns | |
|---|---|
| Type | Description |
PluginInstance.Builder |
|
setDisplayName(String value)
public PluginInstance.Builder setDisplayName(String value)Required. The display name for this plugin instance. Max length is 255 characters.
string display_name = 2 [(.google.api.field_behavior) = REQUIRED];
| Parameter | |
|---|---|
| Name | Description |
value |
StringThe displayName to set. |
| Returns | |
|---|---|
| Type | Description |
PluginInstance.Builder |
This builder for chaining. |
setDisplayNameBytes(ByteString value)
public PluginInstance.Builder setDisplayNameBytes(ByteString value)Required. The display name for this plugin instance. Max length is 255 characters.
string display_name = 2 [(.google.api.field_behavior) = REQUIRED];
| Parameter | |
|---|---|
| Name | Description |
value |
ByteStringThe bytes for displayName to set. |
| Returns | |
|---|---|
| Type | Description |
PluginInstance.Builder |
This builder for chaining. |
setErrorMessage(String value)
public PluginInstance.Builder setErrorMessage(String value)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];
| Parameter | |
|---|---|
| Name | Description |
value |
StringThe errorMessage to set. |
| Returns | |
|---|---|
| Type | Description |
PluginInstance.Builder |
This builder for chaining. |
setErrorMessageBytes(ByteString value)
public PluginInstance.Builder setErrorMessageBytes(ByteString value)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];
| Parameter | |
|---|---|
| Name | Description |
value |
ByteStringThe bytes for errorMessage to set. |
| Returns | |
|---|---|
| Type | Description |
PluginInstance.Builder |
This builder for chaining. |
setField(Descriptors.FieldDescriptor field, Object value)
public PluginInstance.Builder setField(Descriptors.FieldDescriptor field, Object value)| Parameters | |
|---|---|
| Name | Description |
field |
FieldDescriptor |
value |
Object |
| Returns | |
|---|---|
| Type | Description |
PluginInstance.Builder |
|
setName(String value)
public PluginInstance.Builder setName(String value) 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];
| Parameter | |
|---|---|
| Name | Description |
value |
StringThe name to set. |
| Returns | |
|---|---|
| Type | Description |
PluginInstance.Builder |
This builder for chaining. |
setNameBytes(ByteString value)
public PluginInstance.Builder setNameBytes(ByteString value) 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];
| Parameter | |
|---|---|
| Name | Description |
value |
ByteStringThe bytes for name to set. |
| Returns | |
|---|---|
| Type | Description |
PluginInstance.Builder |
This builder for chaining. |
setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
public PluginInstance.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)| Parameters | |
|---|---|
| Name | Description |
field |
FieldDescriptor |
index |
int |
value |
Object |
| Returns | |
|---|---|
| Type | Description |
PluginInstance.Builder |
|
setSourceProjectId(String value)
public PluginInstance.Builder setSourceProjectId(String value)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];
| Parameter | |
|---|---|
| Name | Description |
value |
StringThe sourceProjectId to set. |
| Returns | |
|---|---|
| Type | Description |
PluginInstance.Builder |
This builder for chaining. |
setSourceProjectIdBytes(ByteString value)
public PluginInstance.Builder setSourceProjectIdBytes(ByteString value)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];
| Parameter | |
|---|---|
| Name | Description |
value |
ByteStringThe bytes for sourceProjectId to set. |
| Returns | |
|---|---|
| Type | Description |
PluginInstance.Builder |
This builder for chaining. |
setState(PluginInstance.State value)
public PluginInstance.Builder setState(PluginInstance.State value)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];
| Parameter | |
|---|---|
| Name | Description |
value |
PluginInstance.StateThe state to set. |
| Returns | |
|---|---|
| Type | Description |
PluginInstance.Builder |
This builder for chaining. |
setStateValue(int value)
public PluginInstance.Builder setStateValue(int value)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];
| Parameter | |
|---|---|
| Name | Description |
value |
intThe enum numeric value on the wire for state to set. |
| Returns | |
|---|---|
| Type | Description |
PluginInstance.Builder |
This builder for chaining. |
setUnknownFields(UnknownFieldSet unknownFields)
public final PluginInstance.Builder setUnknownFields(UnknownFieldSet unknownFields)| Parameter | |
|---|---|
| Name | Description |
unknownFields |
UnknownFieldSet |
| Returns | |
|---|---|
| Type | Description |
PluginInstance.Builder |
|
setUpdateTime(Timestamp value)
public PluginInstance.Builder setUpdateTime(Timestamp value)Output only. Timestamp indicating when the plugin instance was last updated.
.google.protobuf.Timestamp update_time = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Parameter | |
|---|---|
| Name | Description |
value |
Timestamp |
| Returns | |
|---|---|
| Type | Description |
PluginInstance.Builder |
|
setUpdateTime(Timestamp.Builder builderForValue)
public PluginInstance.Builder setUpdateTime(Timestamp.Builder builderForValue)Output only. Timestamp indicating when the plugin instance was last updated.
.google.protobuf.Timestamp update_time = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Parameter | |
|---|---|
| Name | Description |
builderForValue |
Builder |
| Returns | |
|---|---|
| Type | Description |
PluginInstance.Builder |
|