Class Plugin.Builder (0.28.0)

public static final class Plugin.Builder extends GeneratedMessageV3.Builder<Plugin.Builder> implements PluginOrBuilder

A plugin resource in the API Hub.

Protobuf type google.cloud.apihub.v1.Plugin

Implements

PluginOrBuilder

Static Methods

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
Type Description
Descriptor

Methods

addActionsConfig(PluginActionConfig value)

public Plugin.Builder addActionsConfig(PluginActionConfig value)

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
value PluginActionConfig
Returns
Type Description
Plugin.Builder

addActionsConfig(PluginActionConfig.Builder builderForValue)

public Plugin.Builder addActionsConfig(PluginActionConfig.Builder builderForValue)

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
builderForValue PluginActionConfig.Builder
Returns
Type Description
Plugin.Builder

addActionsConfig(int index, PluginActionConfig value)

public Plugin.Builder addActionsConfig(int index, PluginActionConfig value)

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

Parameters
Name Description
index int
value PluginActionConfig
Returns
Type Description
Plugin.Builder

addActionsConfig(int index, PluginActionConfig.Builder builderForValue)

public Plugin.Builder addActionsConfig(int index, PluginActionConfig.Builder builderForValue)

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

Parameters
Name Description
index int
builderForValue PluginActionConfig.Builder
Returns
Type Description
Plugin.Builder

addActionsConfigBuilder()

public PluginActionConfig.Builder addActionsConfigBuilder()

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
PluginActionConfig.Builder

addActionsConfigBuilder(int index)

public PluginActionConfig.Builder addActionsConfigBuilder(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.Builder

addAllActionsConfig(Iterable<? extends PluginActionConfig> values)

public Plugin.Builder addAllActionsConfig(Iterable<? extends PluginActionConfig> values)

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
values Iterable<? extends com.google.cloud.apihub.v1.PluginActionConfig>
Returns
Type Description
Plugin.Builder

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public Plugin.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
Plugin.Builder
Overrides

build()

public Plugin build()
Returns
Type Description
Plugin

buildPartial()

public Plugin buildPartial()
Returns
Type Description
Plugin

clear()

public Plugin.Builder clear()
Returns
Type Description
Plugin.Builder
Overrides

clearActionsConfig()

public Plugin.Builder clearActionsConfig()

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
Plugin.Builder

clearConfigTemplate()

public Plugin.Builder clearConfigTemplate()

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.Builder

clearCreateTime()

public Plugin.Builder clearCreateTime()

Output only. Timestamp indicating when the plugin was created.

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

Returns
Type Description
Plugin.Builder

clearDescription()

public Plugin.Builder clearDescription()

Optional. The plugin description. Max length is 2000 characters (Unicode code points).

string description = 4 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
Plugin.Builder

This builder for chaining.

clearDisplayName()

public Plugin.Builder clearDisplayName()

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
Plugin.Builder

This builder for chaining.

clearDocumentation()

public Plugin.Builder clearDocumentation()

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
Plugin.Builder

clearField(Descriptors.FieldDescriptor field)

public Plugin.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
Name Description
field FieldDescriptor
Returns
Type Description
Plugin.Builder
Overrides

clearGatewayType()

public Plugin.Builder clearGatewayType()

Optional. The type of the gateway.

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

Returns
Type Description
Plugin.Builder

This builder for chaining.

clearHostingService()

public Plugin.Builder clearHostingService()

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.Builder

clearName()

public Plugin.Builder clearName()

Identifier. The name of the plugin. Format: projects/{project}/locations/{location}/plugins/{plugin}

string name = 1 [(.google.api.field_behavior) = IDENTIFIER];

Returns
Type Description
Plugin.Builder

This builder for chaining.

clearOneof(Descriptors.OneofDescriptor oneof)

public Plugin.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
Name Description
oneof OneofDescriptor
Returns
Type Description
Plugin.Builder
Overrides

clearOwnershipType()

public Plugin.Builder clearOwnershipType()

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.Builder

This builder for chaining.

clearPluginCategory()

public Plugin.Builder clearPluginCategory()

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
Plugin.Builder

This builder for chaining.

clearState()

public Plugin.Builder clearState()

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.Builder

This builder for chaining.

clearType()

public Plugin.Builder clearType()

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
Plugin.Builder

clearUpdateTime()

public Plugin.Builder clearUpdateTime()

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
Plugin.Builder

clone()

public Plugin.Builder clone()
Returns
Type Description
Plugin.Builder
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
Returns
Type Description
PluginActionConfig

getActionsConfigBuilder(int index)

public PluginActionConfig.Builder getActionsConfigBuilder(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.Builder

getActionsConfigBuilderList()

public List<PluginActionConfig.Builder> getActionsConfigBuilderList()

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<Builder>

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

Returns
Type Description
List<PluginActionConfig>

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
Returns
Type Description
PluginActionConfigOrBuilder

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

Returns
Type Description
Plugin.ConfigTemplate

The configTemplate.

getConfigTemplateBuilder()

public Plugin.ConfigTemplate.Builder getConfigTemplateBuilder()

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.Builder

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

Returns
Type Description
Plugin.ConfigTemplateOrBuilder

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.

getCreateTimeBuilder()

public Timestamp.Builder getCreateTimeBuilder()

Output only. Timestamp indicating when the plugin was created.

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

Returns
Type Description
Builder

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

Returns
Type Description
TimestampOrBuilder

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.

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
Type Description
Descriptor
Overrides

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

Returns
Type Description
Documentation

The documentation.

getDocumentationBuilder()

public Documentation.Builder getDocumentationBuilder()

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.Builder

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

Returns
Type Description
DocumentationOrBuilder

getGatewayType()

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

Returns
Type Description
Plugin.HostingService

The hostingService.

getHostingServiceBuilder()

public Plugin.HostingService.Builder getHostingServiceBuilder()

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.Builder

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

Returns
Type Description
Plugin.HostingServiceOrBuilder

getName()

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

Returns
Type Description
Plugin.OwnershipType

The ownershipType.

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.

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

Returns
Type Description
PluginCategory

The pluginCategory.

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.

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

Returns
Type Description
Plugin.State

The state.

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

Returns
Type Description
AttributeValues

The type.

getTypeBuilder()

public AttributeValues.Builder getTypeBuilder()

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.Builder

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

Returns
Type Description
AttributeValuesOrBuilder

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.

getUpdateTimeBuilder()

public Timestamp.Builder getUpdateTimeBuilder()

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
Builder

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

Returns
Type Description
TimestampOrBuilder

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

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

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

mergeConfigTemplate(Plugin.ConfigTemplate value)

public Plugin.Builder mergeConfigTemplate(Plugin.ConfigTemplate value)

Optional. The configuration template for the plugin.

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

Parameter
Name Description
value Plugin.ConfigTemplate
Returns
Type Description
Plugin.Builder

mergeCreateTime(Timestamp value)

public Plugin.Builder mergeCreateTime(Timestamp value)

Output only. Timestamp indicating when the plugin was created.

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

Parameter
Name Description
value Timestamp
Returns
Type Description
Plugin.Builder

mergeDocumentation(Documentation value)

public Plugin.Builder mergeDocumentation(Documentation value)

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

Parameter
Name Description
value Documentation
Returns
Type Description
Plugin.Builder

mergeFrom(Plugin other)

public Plugin.Builder mergeFrom(Plugin other)
Parameter
Name Description
other Plugin
Returns
Type Description
Plugin.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public Plugin.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Plugin.Builder
Overrides
Exceptions
Type Description
IOException

mergeFrom(Message other)

public Plugin.Builder mergeFrom(Message other)
Parameter
Name Description
other Message
Returns
Type Description
Plugin.Builder
Overrides

mergeHostingService(Plugin.HostingService value)

public Plugin.Builder mergeHostingService(Plugin.HostingService value)

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

Parameter
Name Description
value Plugin.HostingService
Returns
Type Description
Plugin.Builder

mergeType(AttributeValues value)

public Plugin.Builder mergeType(AttributeValues value)

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

Parameter
Name Description
value AttributeValues
Returns
Type Description
Plugin.Builder

mergeUnknownFields(UnknownFieldSet unknownFields)

public final Plugin.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
Plugin.Builder
Overrides

mergeUpdateTime(Timestamp value)

public Plugin.Builder mergeUpdateTime(Timestamp value)

Output only. Timestamp indicating when the plugin was last updated.

.google.protobuf.Timestamp update_time = 14 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
value Timestamp
Returns
Type Description
Plugin.Builder

removeActionsConfig(int index)

public Plugin.Builder removeActionsConfig(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
Plugin.Builder

setActionsConfig(int index, PluginActionConfig value)

public Plugin.Builder setActionsConfig(int index, PluginActionConfig value)

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

Parameters
Name Description
index int
value PluginActionConfig
Returns
Type Description
Plugin.Builder

setActionsConfig(int index, PluginActionConfig.Builder builderForValue)

public Plugin.Builder setActionsConfig(int index, PluginActionConfig.Builder builderForValue)

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

Parameters
Name Description
index int
builderForValue PluginActionConfig.Builder
Returns
Type Description
Plugin.Builder

setConfigTemplate(Plugin.ConfigTemplate value)

public Plugin.Builder setConfigTemplate(Plugin.ConfigTemplate value)

Optional. The configuration template for the plugin.

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

Parameter
Name Description
value Plugin.ConfigTemplate
Returns
Type Description
Plugin.Builder

setConfigTemplate(Plugin.ConfigTemplate.Builder builderForValue)

public Plugin.Builder setConfigTemplate(Plugin.ConfigTemplate.Builder builderForValue)

Optional. The configuration template for the plugin.

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

Parameter
Name Description
builderForValue Plugin.ConfigTemplate.Builder
Returns
Type Description
Plugin.Builder

setCreateTime(Timestamp value)

public Plugin.Builder setCreateTime(Timestamp value)

Output only. Timestamp indicating when the plugin was created.

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

Parameter
Name Description
value Timestamp
Returns
Type Description
Plugin.Builder

setCreateTime(Timestamp.Builder builderForValue)

public Plugin.Builder setCreateTime(Timestamp.Builder builderForValue)

Output only. Timestamp indicating when the plugin was created.

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

Parameter
Name Description
builderForValue Builder
Returns
Type Description
Plugin.Builder

setDescription(String value)

public Plugin.Builder setDescription(String value)

Optional. The plugin description. Max length is 2000 characters (Unicode code points).

string description = 4 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value String

The description to set.

Returns
Type Description
Plugin.Builder

This builder for chaining.

setDescriptionBytes(ByteString value)

public Plugin.Builder setDescriptionBytes(ByteString value)

Optional. The plugin description. Max length is 2000 characters (Unicode code points).

string description = 4 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value ByteString

The bytes for description to set.

Returns
Type Description
Plugin.Builder

This builder for chaining.

setDisplayName(String value)

public Plugin.Builder setDisplayName(String value)

Required. The display name of the plugin. Max length is 50 characters (Unicode code points).

string display_name = 2 [(.google.api.field_behavior) = REQUIRED];

Parameter
Name Description
value String

The displayName to set.

Returns
Type Description
Plugin.Builder

This builder for chaining.

setDisplayNameBytes(ByteString value)

public Plugin.Builder setDisplayNameBytes(ByteString value)

Required. The display name of the plugin. Max length is 50 characters (Unicode code points).

string display_name = 2 [(.google.api.field_behavior) = REQUIRED];

Parameter
Name Description
value ByteString

The bytes for displayName to set.

Returns
Type Description
Plugin.Builder

This builder for chaining.

setDocumentation(Documentation value)

public Plugin.Builder setDocumentation(Documentation value)

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

Parameter
Name Description
value Documentation
Returns
Type Description
Plugin.Builder

setDocumentation(Documentation.Builder builderForValue)

public Plugin.Builder setDocumentation(Documentation.Builder builderForValue)

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

Parameter
Name Description
builderForValue Documentation.Builder
Returns
Type Description
Plugin.Builder

setField(Descriptors.FieldDescriptor field, Object value)

public Plugin.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
Plugin.Builder
Overrides

setGatewayType(GatewayType value)

public Plugin.Builder setGatewayType(GatewayType value)

Optional. The type of the gateway.

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

Parameter
Name Description
value GatewayType

The gatewayType to set.

Returns
Type Description
Plugin.Builder

This builder for chaining.

setGatewayTypeValue(int value)

public Plugin.Builder setGatewayTypeValue(int value)

Optional. The type of the gateway.

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

Parameter
Name Description
value int

The enum numeric value on the wire for gatewayType to set.

Returns
Type Description
Plugin.Builder

This builder for chaining.

setHostingService(Plugin.HostingService value)

public Plugin.Builder setHostingService(Plugin.HostingService value)

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

Parameter
Name Description
value Plugin.HostingService
Returns
Type Description
Plugin.Builder

setHostingService(Plugin.HostingService.Builder builderForValue)

public Plugin.Builder setHostingService(Plugin.HostingService.Builder builderForValue)

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

Parameter
Name Description
builderForValue Plugin.HostingService.Builder
Returns
Type Description
Plugin.Builder

setName(String value)

public Plugin.Builder setName(String value)

Identifier. The name of the plugin. Format: projects/{project}/locations/{location}/plugins/{plugin}

string name = 1 [(.google.api.field_behavior) = IDENTIFIER];

Parameter
Name Description
value String

The name to set.

Returns
Type Description
Plugin.Builder

This builder for chaining.

setNameBytes(ByteString value)

public Plugin.Builder setNameBytes(ByteString value)

Identifier. The name of the plugin. Format: projects/{project}/locations/{location}/plugins/{plugin}

string name = 1 [(.google.api.field_behavior) = IDENTIFIER];

Parameter
Name Description
value ByteString

The bytes for name to set.

Returns
Type Description
Plugin.Builder

This builder for chaining.

setOwnershipType(Plugin.OwnershipType value)

public Plugin.Builder setOwnershipType(Plugin.OwnershipType value)

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

Parameter
Name Description
value Plugin.OwnershipType

The ownershipType to set.

Returns
Type Description
Plugin.Builder

This builder for chaining.

setOwnershipTypeValue(int value)

public Plugin.Builder setOwnershipTypeValue(int value)

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

Parameter
Name Description
value int

The enum numeric value on the wire for ownershipType to set.

Returns
Type Description
Plugin.Builder

This builder for chaining.

setPluginCategory(PluginCategory value)

public Plugin.Builder setPluginCategory(PluginCategory value)

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

Parameter
Name Description
value PluginCategory

The pluginCategory to set.

Returns
Type Description
Plugin.Builder

This builder for chaining.

setPluginCategoryValue(int value)

public Plugin.Builder setPluginCategoryValue(int value)

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

Parameter
Name Description
value int

The enum numeric value on the wire for pluginCategory to set.

Returns
Type Description
Plugin.Builder

This builder for chaining.

setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

public Plugin.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Parameters
Name Description
field FieldDescriptor
index int
value Object
Returns
Type Description
Plugin.Builder
Overrides

setState(Plugin.State value)

public Plugin.Builder setState(Plugin.State value)

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

Parameter
Name Description
value Plugin.State

The state to set.

Returns
Type Description
Plugin.Builder

This builder for chaining.

setStateValue(int value)

public Plugin.Builder setStateValue(int value)

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

Parameter
Name Description
value int

The enum numeric value on the wire for state to set.

Returns
Type Description
Plugin.Builder

This builder for chaining.

setType(AttributeValues value)

public Plugin.Builder setType(AttributeValues value)

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

Parameter
Name Description
value AttributeValues
Returns
Type Description
Plugin.Builder

setType(AttributeValues.Builder builderForValue)

public Plugin.Builder setType(AttributeValues.Builder builderForValue)

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

Parameter
Name Description
builderForValue AttributeValues.Builder
Returns
Type Description
Plugin.Builder

setUnknownFields(UnknownFieldSet unknownFields)

public final Plugin.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
Plugin.Builder
Overrides

setUpdateTime(Timestamp value)

public Plugin.Builder setUpdateTime(Timestamp value)

Output only. Timestamp indicating when the plugin was last updated.

.google.protobuf.Timestamp update_time = 14 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
value Timestamp
Returns
Type Description
Plugin.Builder

setUpdateTime(Timestamp.Builder builderForValue)

public Plugin.Builder setUpdateTime(Timestamp.Builder builderForValue)

Output only. Timestamp indicating when the plugin was last updated.

.google.protobuf.Timestamp update_time = 14 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
builderForValue Builder
Returns
Type Description
Plugin.Builder