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 PluginOrBuilder (0.28.0)

public interface PluginOrBuilder extends MessageOrBuilder

Implements

MessageOrBuilder

Methods

getActionsConfig(int index)

public abstract 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`

Returns
Type	Description
`PluginActionConfig`

getActionsConfigCount()

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

Returns
Type	Description
`List<PluginActionConfig>`

getActionsConfigOrBuilder(int index)

public abstract 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`

Returns
Type	Description
`PluginActionConfigOrBuilder`

getActionsConfigOrBuilderList()

public abstract 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 abstract Plugin.ConfigTemplate getConfigTemplate()

Optional. The configuration template for the plugin.

.google.cloud.apihub.v1.Plugin.ConfigTemplate config_template = 12 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
`Plugin.ConfigTemplate`	The configTemplate.

getConfigTemplateOrBuilder()

public abstract Plugin.ConfigTemplateOrBuilder getConfigTemplateOrBuilder()

Optional. The configuration template for the plugin.

.google.cloud.apihub.v1.Plugin.ConfigTemplate config_template = 12 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
`Plugin.ConfigTemplateOrBuilder`

getCreateTime()

public abstract 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 abstract TimestampOrBuilder getCreateTimeOrBuilder()

Output only. Timestamp indicating when the plugin was created.

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

Returns
Type	Description
`TimestampOrBuilder`

getDescription()

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

Returns
Type	Description
`Documentation`	The documentation.

getDocumentationOrBuilder()

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

Returns
Type	Description
`DocumentationOrBuilder`

getGatewayType()

public abstract GatewayType getGatewayType()

Optional. The type of the gateway.

.google.cloud.apihub.v1.GatewayType gateway_type = 15 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
`GatewayType`	The gatewayType.

getGatewayTypeValue()

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

Returns
Type	Description
`Plugin.HostingService`	The hostingService.

getHostingServiceOrBuilder()

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

Returns
Type	Description
`Plugin.HostingServiceOrBuilder`

getName()

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

Returns
Type	Description
`Plugin.OwnershipType`	The ownershipType.

getOwnershipTypeValue()

public abstract 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.

getPluginCategory()

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

Returns
Type	Description
`PluginCategory`	The pluginCategory.

getPluginCategoryValue()

public abstract 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.

getState()

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

Returns
Type	Description
`Plugin.State`	The state.

getStateValue()

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

Returns
Type	Description
`AttributeValues`	The type.

getTypeOrBuilder()

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

Returns
Type	Description
`AttributeValuesOrBuilder`

getUpdateTime()

public abstract 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 abstract TimestampOrBuilder getUpdateTimeOrBuilder()

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
`TimestampOrBuilder`

hasConfigTemplate()

public abstract 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 abstract 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 abstract 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 abstract 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()

public abstract boolean 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 abstract 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.

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.