public final class Plugin extends GeneratedMessageV3 implements PluginOrBuilder
A plugin resource in the API Hub.
Protobuf type google.cloud.apihub.v1.Plugin
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_CONFIG_FIELD_NUMBER
public static final int ACTIONS_CONFIG_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
CONFIG_TEMPLATE_FIELD_NUMBER
public static final int CONFIG_TEMPLATE_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
CREATE_TIME_FIELD_NUMBER
public static final int CREATE_TIME_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
DESCRIPTION_FIELD_NUMBER
public static final int DESCRIPTION_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
DISPLAY_NAME_FIELD_NUMBER
public static final int DISPLAY_NAME_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
DOCUMENTATION_FIELD_NUMBER
public static final int DOCUMENTATION_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
GATEWAY_TYPE_FIELD_NUMBER
public static final int GATEWAY_TYPE_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
HOSTING_SERVICE_FIELD_NUMBER
public static final int HOSTING_SERVICE_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
NAME_FIELD_NUMBER
public static final int NAME_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
OWNERSHIP_TYPE_FIELD_NUMBER
public static final int OWNERSHIP_TYPE_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
PLUGIN_CATEGORY_FIELD_NUMBER
public static final int PLUGIN_CATEGORY_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
STATE_FIELD_NUMBER
public static final int STATE_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
TYPE_FIELD_NUMBER
public static final int TYPE_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 Plugin getDefaultInstance()
| Returns |
| Type |
Description |
Plugin |
|
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()
newBuilder()
public static Plugin.Builder newBuilder()
newBuilder(Plugin prototype)
public static Plugin.Builder newBuilder(Plugin prototype)
| Parameter |
| Name |
Description |
prototype |
Plugin
|
public static Plugin parseDelimitedFrom(InputStream input)
| Returns |
| Type |
Description |
Plugin |
|
public static Plugin parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
| Returns |
| Type |
Description |
Plugin |
|
parseFrom(byte[] data)
public static Plugin parseFrom(byte[] data)
| Parameter |
| Name |
Description |
data |
byte[]
|
| Returns |
| Type |
Description |
Plugin |
|
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static Plugin parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
| Returns |
| Type |
Description |
Plugin |
|
parseFrom(ByteString data)
public static Plugin parseFrom(ByteString data)
| Returns |
| Type |
Description |
Plugin |
|
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static Plugin parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
| Returns |
| Type |
Description |
Plugin |
|
public static Plugin parseFrom(CodedInputStream input)
| Returns |
| Type |
Description |
Plugin |
|
public static Plugin parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
| Returns |
| Type |
Description |
Plugin |
|
public static Plugin parseFrom(InputStream input)
| Returns |
| Type |
Description |
Plugin |
|
public static Plugin parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
| Returns |
| Type |
Description |
Plugin |
|
parseFrom(ByteBuffer data)
public static Plugin parseFrom(ByteBuffer data)
| Returns |
| Type |
Description |
Plugin |
|
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static Plugin parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
| Returns |
| Type |
Description |
Plugin |
|
parser()
public static Parser<Plugin> parser()
Methods
equals(Object obj)
public boolean equals(Object obj)
| Parameter |
| Name |
Description |
obj |
Object
|
Overrides
getActionsConfig(int index)
public PluginActionConfig getActionsConfig(int index)
Optional. The configuration of actions supported by the plugin.
REQUIRED: This field must be provided when creating or updating a
Plugin. The server will reject requests if this field is missing.
repeated .google.cloud.apihub.v1.PluginActionConfig actions_config = 8 [(.google.api.field_behavior) = OPTIONAL];
| Parameter |
| Name |
Description |
index |
int
|
getActionsConfigCount()
public int getActionsConfigCount()
Optional. The configuration of actions supported by the plugin.
REQUIRED: This field must be provided when creating or updating a
Plugin. The server will reject requests if this field is missing.
repeated .google.cloud.apihub.v1.PluginActionConfig actions_config = 8 [(.google.api.field_behavior) = OPTIONAL];
| Returns |
| Type |
Description |
int |
|
getActionsConfigList()
public List<PluginActionConfig> getActionsConfigList()
Optional. The configuration of actions supported by the plugin.
REQUIRED: This field must be provided when creating or updating a
Plugin. The server will reject requests if this field is missing.
repeated .google.cloud.apihub.v1.PluginActionConfig actions_config = 8 [(.google.api.field_behavior) = OPTIONAL];
getActionsConfigOrBuilder(int index)
public PluginActionConfigOrBuilder getActionsConfigOrBuilder(int index)
Optional. The configuration of actions supported by the plugin.
REQUIRED: This field must be provided when creating or updating a
Plugin. The server will reject requests if this field is missing.
repeated .google.cloud.apihub.v1.PluginActionConfig actions_config = 8 [(.google.api.field_behavior) = OPTIONAL];
| Parameter |
| Name |
Description |
index |
int
|
getActionsConfigOrBuilderList()
public List<? extends PluginActionConfigOrBuilder> getActionsConfigOrBuilderList()
Optional. The configuration of actions supported by the plugin.
REQUIRED: This field must be provided when creating or updating a
Plugin. The server will reject requests if this field is missing.
repeated .google.cloud.apihub.v1.PluginActionConfig actions_config = 8 [(.google.api.field_behavior) = OPTIONAL];
| Returns |
| Type |
Description |
List<? extends com.google.cloud.apihub.v1.PluginActionConfigOrBuilder> |
|
getConfigTemplate()
public Plugin.ConfigTemplate getConfigTemplate()
Optional. The configuration template for the plugin.
.google.cloud.apihub.v1.Plugin.ConfigTemplate config_template = 12 [(.google.api.field_behavior) = OPTIONAL];
getConfigTemplateOrBuilder()
public Plugin.ConfigTemplateOrBuilder getConfigTemplateOrBuilder()
Optional. The configuration template for the plugin.
.google.cloud.apihub.v1.Plugin.ConfigTemplate config_template = 12 [(.google.api.field_behavior) = OPTIONAL];
getCreateTime()
public Timestamp getCreateTime()
Output only. Timestamp indicating when the plugin was created.
.google.protobuf.Timestamp create_time = 13 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns |
| Type |
Description |
Timestamp |
The createTime.
|
getCreateTimeOrBuilder()
public TimestampOrBuilder getCreateTimeOrBuilder()
Output only. Timestamp indicating when the plugin was created.
.google.protobuf.Timestamp create_time = 13 [(.google.api.field_behavior) = OUTPUT_ONLY];
getDefaultInstanceForType()
public Plugin getDefaultInstanceForType()
| Returns |
| Type |
Description |
Plugin |
|
getDescription()
public String getDescription()
Optional. The plugin description. Max length is 2000 characters (Unicode
code points).
string description = 4 [(.google.api.field_behavior) = OPTIONAL];
| Returns |
| Type |
Description |
String |
The description.
|
getDescriptionBytes()
public ByteString getDescriptionBytes()
Optional. The plugin description. Max length is 2000 characters (Unicode
code points).
string description = 4 [(.google.api.field_behavior) = OPTIONAL];
| Returns |
| Type |
Description |
ByteString |
The bytes for description.
|
getDisplayName()
public String getDisplayName()
Required. The display name of the plugin. Max length is 50 characters
(Unicode code points).
string display_name = 2 [(.google.api.field_behavior) = REQUIRED];
| Returns |
| Type |
Description |
String |
The displayName.
|
getDisplayNameBytes()
public ByteString getDisplayNameBytes()
Required. The display name of the plugin. Max length is 50 characters
(Unicode code points).
string display_name = 2 [(.google.api.field_behavior) = REQUIRED];
| Returns |
| Type |
Description |
ByteString |
The bytes for displayName.
|
getDocumentation()
public Documentation getDocumentation()
Optional. The documentation of the plugin, that explains how to set up and
use the plugin.
.google.cloud.apihub.v1.Documentation documentation = 9 [(.google.api.field_behavior) = OPTIONAL];
getDocumentationOrBuilder()
public DocumentationOrBuilder getDocumentationOrBuilder()
Optional. The documentation of the plugin, that explains how to set up and
use the plugin.
.google.cloud.apihub.v1.Documentation documentation = 9 [(.google.api.field_behavior) = OPTIONAL];
getGatewayType()
public GatewayType getGatewayType()
Optional. The type of the gateway.
.google.cloud.apihub.v1.GatewayType gateway_type = 15 [(.google.api.field_behavior) = OPTIONAL];
getGatewayTypeValue()
public int getGatewayTypeValue()
Optional. The type of the gateway.
.google.cloud.apihub.v1.GatewayType gateway_type = 15 [(.google.api.field_behavior) = OPTIONAL];
| Returns |
| Type |
Description |
int |
The enum numeric value on the wire for gatewayType.
|
getHostingService()
public Plugin.HostingService getHostingService()
Optional. This field is optional. It is used to notify the plugin hosting
service for any lifecycle changes of the plugin instance and trigger
execution of plugin instance actions in case of API hub managed actions.
This field should be provided if the plugin instance lifecycle of the
developed plugin needs to be managed from API hub. Also, in this case the
plugin hosting service interface needs to be implemented.
This field should not be provided if the plugin wants to manage plugin
instance lifecycle events outside of hub interface and use plugin framework
for only registering of plugin and plugin instances to capture the source
of data into hub. Note, in this case the plugin hosting service interface
is not required to be implemented. Also, the plugin instance lifecycle
actions will be disabled from API hub's UI.
.google.cloud.apihub.v1.Plugin.HostingService hosting_service = 7 [(.google.api.field_behavior) = OPTIONAL];
getHostingServiceOrBuilder()
public Plugin.HostingServiceOrBuilder getHostingServiceOrBuilder()
Optional. This field is optional. It is used to notify the plugin hosting
service for any lifecycle changes of the plugin instance and trigger
execution of plugin instance actions in case of API hub managed actions.
This field should be provided if the plugin instance lifecycle of the
developed plugin needs to be managed from API hub. Also, in this case the
plugin hosting service interface needs to be implemented.
This field should not be provided if the plugin wants to manage plugin
instance lifecycle events outside of hub interface and use plugin framework
for only registering of plugin and plugin instances to capture the source
of data into hub. Note, in this case the plugin hosting service interface
is not required to be implemented. Also, the plugin instance lifecycle
actions will be disabled from API hub's UI.
.google.cloud.apihub.v1.Plugin.HostingService hosting_service = 7 [(.google.api.field_behavior) = OPTIONAL];
getName()
Identifier. The name of the plugin.
Format: projects/{project}/locations/{location}/plugins/{plugin}
string name = 1 [(.google.api.field_behavior) = IDENTIFIER];
| Returns |
| Type |
Description |
String |
The name.
|
getNameBytes()
public ByteString getNameBytes()
Identifier. The name of the plugin.
Format: projects/{project}/locations/{location}/plugins/{plugin}
string name = 1 [(.google.api.field_behavior) = IDENTIFIER];
| Returns |
| Type |
Description |
ByteString |
The bytes for name.
|
getOwnershipType()
public Plugin.OwnershipType getOwnershipType()
Output only. The type of the plugin, indicating whether it is
'SYSTEM_OWNED' or 'USER_OWNED'.
.google.cloud.apihub.v1.Plugin.OwnershipType ownership_type = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];
getOwnershipTypeValue()
public int getOwnershipTypeValue()
Output only. The type of the plugin, indicating whether it is
'SYSTEM_OWNED' or 'USER_OWNED'.
.google.cloud.apihub.v1.Plugin.OwnershipType ownership_type = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns |
| Type |
Description |
int |
The enum numeric value on the wire for ownershipType.
|
getParserForType()
public Parser<Plugin> getParserForType()
Overrides
getPluginCategory()
public PluginCategory getPluginCategory()
Optional. The category of the plugin, identifying its primary category or
purpose. This field is required for all plugins.
.google.cloud.apihub.v1.PluginCategory plugin_category = 11 [(.google.api.field_behavior) = OPTIONAL];
getPluginCategoryValue()
public int getPluginCategoryValue()
Optional. The category of the plugin, identifying its primary category or
purpose. This field is required for all plugins.
.google.cloud.apihub.v1.PluginCategory plugin_category = 11 [(.google.api.field_behavior) = OPTIONAL];
| Returns |
| Type |
Description |
int |
The enum numeric value on the wire for pluginCategory.
|
getSerializedSize()
public int getSerializedSize()
| Returns |
| Type |
Description |
int |
|
Overrides
getState()
public Plugin.State getState()
Output only. Represents the state of the plugin.
Note this field will not be set for plugins developed via plugin
framework as the state will be managed at plugin instance level.
.google.cloud.apihub.v1.Plugin.State state = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];
getStateValue()
public int getStateValue()
Output only. Represents the state of the plugin.
Note this field will not be set for plugins developed via plugin
framework as the state will be managed at plugin instance level.
.google.cloud.apihub.v1.Plugin.State state = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns |
| Type |
Description |
int |
The enum numeric value on the wire for state.
|
getType()
public AttributeValues getType()
Optional. The type of the API.
This maps to the following system defined attribute:
projects/{project}/locations/{location}/attributes/system-plugin-type
attribute.
The number of allowed values for this attribute will be based on the
cardinality of the attribute. The same can be retrieved via GetAttribute
API. All values should be from the list of allowed values defined for the
attribute.
Note this field is not required for plugins developed via plugin framework.
.google.cloud.apihub.v1.AttributeValues type = 3 [(.google.api.field_behavior) = OPTIONAL];
getTypeOrBuilder()
public AttributeValuesOrBuilder getTypeOrBuilder()
Optional. The type of the API.
This maps to the following system defined attribute:
projects/{project}/locations/{location}/attributes/system-plugin-type
attribute.
The number of allowed values for this attribute will be based on the
cardinality of the attribute. The same can be retrieved via GetAttribute
API. All values should be from the list of allowed values defined for the
attribute.
Note this field is not required for plugins developed via plugin framework.
.google.cloud.apihub.v1.AttributeValues type = 3 [(.google.api.field_behavior) = OPTIONAL];
getUpdateTime()
public Timestamp getUpdateTime()
Output only. Timestamp indicating when the plugin was last updated.
.google.protobuf.Timestamp update_time = 14 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns |
| Type |
Description |
Timestamp |
The updateTime.
|
getUpdateTimeOrBuilder()
public TimestampOrBuilder getUpdateTimeOrBuilder()
Output only. Timestamp indicating when the plugin was last updated.
.google.protobuf.Timestamp update_time = 14 [(.google.api.field_behavior) = OUTPUT_ONLY];
hasConfigTemplate()
public boolean hasConfigTemplate()
Optional. The configuration template for the plugin.
.google.cloud.apihub.v1.Plugin.ConfigTemplate config_template = 12 [(.google.api.field_behavior) = OPTIONAL];
| Returns |
| Type |
Description |
boolean |
Whether the configTemplate field is set.
|
hasCreateTime()
public boolean hasCreateTime()
Output only. Timestamp indicating when the plugin was created.
.google.protobuf.Timestamp create_time = 13 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns |
| Type |
Description |
boolean |
Whether the createTime field is set.
|
hasDocumentation()
public boolean hasDocumentation()
Optional. The documentation of the plugin, that explains how to set up and
use the plugin.
.google.cloud.apihub.v1.Documentation documentation = 9 [(.google.api.field_behavior) = OPTIONAL];
| Returns |
| Type |
Description |
boolean |
Whether the documentation field is set.
|
hasHostingService()
public boolean hasHostingService()
Optional. This field is optional. It is used to notify the plugin hosting
service for any lifecycle changes of the plugin instance and trigger
execution of plugin instance actions in case of API hub managed actions.
This field should be provided if the plugin instance lifecycle of the
developed plugin needs to be managed from API hub. Also, in this case the
plugin hosting service interface needs to be implemented.
This field should not be provided if the plugin wants to manage plugin
instance lifecycle events outside of hub interface and use plugin framework
for only registering of plugin and plugin instances to capture the source
of data into hub. Note, in this case the plugin hosting service interface
is not required to be implemented. Also, the plugin instance lifecycle
actions will be disabled from API hub's UI.
.google.cloud.apihub.v1.Plugin.HostingService hosting_service = 7 [(.google.api.field_behavior) = OPTIONAL];
| Returns |
| Type |
Description |
boolean |
Whether the hostingService field is set.
|
hasType()
Optional. The type of the API.
This maps to the following system defined attribute:
projects/{project}/locations/{location}/attributes/system-plugin-type
attribute.
The number of allowed values for this attribute will be based on the
cardinality of the attribute. The same can be retrieved via GetAttribute
API. All values should be from the list of allowed values defined for the
attribute.
Note this field is not required for plugins developed via plugin framework.
.google.cloud.apihub.v1.AttributeValues type = 3 [(.google.api.field_behavior) = OPTIONAL];
| Returns |
| Type |
Description |
boolean |
Whether the type field is set.
|
hasUpdateTime()
public boolean hasUpdateTime()
Output only. Timestamp indicating when the plugin was last updated.
.google.protobuf.Timestamp update_time = 14 [(.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
isInitialized()
public final boolean isInitialized()
Overrides
newBuilderForType()
public Plugin.Builder newBuilderForType()
newBuilderForType(GeneratedMessageV3.BuilderParent parent)
protected Plugin.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Overrides
newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
| Returns |
| Type |
Description |
Object |
|
Overrides
toBuilder()
public Plugin.Builder toBuilder()
writeTo(CodedOutputStream output)
public void writeTo(CodedOutputStream output)
Overrides
