public interface RuntimeToolingService
| Modifier and Type | Method and Description |
|---|---|
List<AgentTrackingNotificationResponse> |
consumeMessageHistoryNotifications(String applicationName,
int chunkSize)
Consumes the message history notifications buffered by Mule Runtime for the given application.
|
String |
createDeclarationSession(DeclarationSessionCreationRequest declarationSessionCreationRequest)
Creates a new
org.mule.tooling.client.api.declaration.session.DeclarationSession to perform design time operations |
default String |
deployApplication(String id,
File appLocation,
Map<String,String> deploymentProperties)
Deploys an application to the Mule Runtime from the given
appLocation that points to the exploded application
content. |
String |
deployApplication(String id,
File appLocation,
String domainName,
Map<String,String> deploymentProperties)
Deploys an application to the Mule Runtime from the given
appLocation that points to the exploded application
content. |
String |
deployApplication(String id,
InputStream inputStream,
Map<String,String> deploymentProperties)
Deploys an application to the Mule Runtime with the content of the application jar from the
inputStream. |
String |
deployApplication(String id,
InputStream inputStream,
String domainName,
Map<String,String> deploymentProperties)
Deploys an application to the Mule Runtime with the content of the application jar from the
inputStream. |
String |
deployDomain(String id,
File domainLocation,
Map<String,String> deploymentProperties)
Deploys a domain to the Mule Runtime from the given
domainLocation that points to the exploded domain content. |
String |
deployDomain(String id,
InputStream inputStream,
Map<String,String> deploymentProperties)
Deploys a domain to the Mule Runtime with the content of the application jar from the
inputStream. |
void |
disableMessageHistory(String applicationName)
Disables message history for the given application.
|
void |
disposeApplication(String applicationId)
Disposes the application for the given
applicationId. |
void |
disposeApplicationMetadataCache(String applicationId,
String hashKey)
Disposes the metadata associated with the hashKey in the Metadata cache on Mule Runtime side.
|
void |
disposeDeclarationSession(String id)
Dispose the
org.mule.tooling.client.api.declaration.session.DeclarationSession with the given id if it exists |
void |
disposeDomain(String domainId)
Disposes the domain for the given
domainId. |
void |
disposeDomainMetadataCache(String domainId,
String hashKey)
Disposes the metadata associated with the hashKey in the Metadata cache on Mule Runtime side.
|
void |
enableMessageHistory(String applicationName)
Enables an application for message history.
|
org.mule.runtime.api.metadata.resolving.MetadataResult<org.mule.runtime.api.metadata.descriptor.ComponentMetadataTypesDescriptor> |
getComponentMetadata(String sessionId,
org.mule.runtime.app.declaration.api.ComponentElementDeclaration componentElementDeclaration,
boolean ignoreCache)
Resolves metadata for input, output and attributes within the context of the
ComponentElementDeclaration and the *
org.mule.tooling.client.api.declaration.session.DeclarationSession with the given sessionId. |
org.mule.runtime.api.metadata.resolving.MetadataResult<org.mule.runtime.api.metadata.MetadataKeysContainer> |
getComponentMetadataKeys(String sessionId,
org.mule.runtime.app.declaration.api.ComponentElementDeclaration componentElementDeclaration,
boolean ignoreCache)
Obtain metadata keys for the given parameter within the context of the
ComponentElementDeclaration and the
org.mule.tooling.client.api.declaration.session.DeclarationSession with the given sessionId. |
org.mule.runtime.api.value.ValueResult |
getFieldValues(String sessionId,
org.mule.runtime.app.declaration.api.ParameterizedElementDeclaration parameterizedElementDeclaration,
String providerName,
String targetSelector)
Obtain possible values for a field within the given parameter in the context of the
ComponentElementDeclaration and
the org.mule.tooling.client.api.declaration.session.DeclarationSession with the given sessionId. |
org.mule.runtime.api.metadata.resolving.MetadataResult<org.mule.runtime.api.metadata.MetadataKeysContainer> |
getMetadataKeysApplication(String applicationId,
String componentLocation,
long readTimeout)
Returns a
MetadataResult of MetadataKey described by
MetadataKeyProvider.getMetadataKeys() of the associated
MetadataKeyProvider component identified by the given applicationId and
componentLocation. |
org.mule.runtime.api.metadata.resolving.MetadataResult<org.mule.runtime.api.metadata.MetadataKeysContainer> |
getMetadataKeysDomain(String domainId,
String componentLocation,
long readTimeout)
Returns a
MetadataResult of MetadataKey described by
MetadataKeyProvider.getMetadataKeys() of the associated
MetadataKeyProvider component identified by the given domainId and componentLocation. |
org.mule.runtime.api.metadata.resolving.MetadataResult<org.mule.runtime.api.metadata.descriptor.ComponentMetadataDescriptor<org.mule.runtime.api.meta.model.operation.OperationModel>> |
getOperationMetadata(String applicationId,
String componentLocation,
long readTimeout)
Resolves the Metadata description for the operation message processor component identified by the given applicationId and
componentLocaton.
|
SampleDataMessageModelResult |
getSampleData(String sessionId,
org.mule.runtime.app.declaration.api.ComponentElementDeclaration componentElementDeclaration)
Obtain sample data within the context of the
ComponentElementDeclaration and the
org.mule.tooling.client.api.declaration.session.DeclarationSession with the given sessionId. |
SampleDataMessageModelResult |
getSampleDataApplication(String applicationId,
String componentLocation,
long readTimeout)
Resolves the Sample Data for the component of the given applicationId and componentLocation.
|
org.mule.runtime.api.metadata.resolving.MetadataResult<org.mule.runtime.api.metadata.descriptor.ComponentMetadataDescriptor<org.mule.runtime.api.meta.model.source.SourceModel>> |
getSourceMetadata(String applicationId,
String componentLocation,
long readTimeout)
Resolves the Metadata description for the source component of the given applicationId and componentLocation.
|
org.mule.runtime.api.value.ValueResult |
getValues(String sessionId,
org.mule.runtime.app.declaration.api.ParameterizedElementDeclaration parameterizedElementDeclaration,
String providerName)
Obtain possible values for the given parameter within the context of the
ComponentElementDeclaration and the
org.mule.tooling.client.api.declaration.session.DeclarationSession with the given sessionId. |
org.mule.runtime.api.value.ValueResult |
getValuesApplication(String applicationId,
String location,
String providerName)
Resolves the
values for a component's value provider located in the given Location. |
org.mule.runtime.api.value.ValueResult |
getValuesDomain(String domainId,
String location,
String providerName)
Resolves the
values for a component's value provider located in the given Location. |
boolean |
isOperational() |
com.mulesoft.agent.domain.tooling.dataweave.model.PreviewResponse |
runDataWeaveApplication(String applicationId,
com.mulesoft.agent.domain.tooling.dataweave.model.PreviewRequest request)
Execute a dataWeave script in the context of an application.
|
com.mulesoft.agent.domain.tooling.dataweave.model.PreviewResponse |
runDataWeaveDomain(String applicationId,
com.mulesoft.agent.domain.tooling.dataweave.model.PreviewRequest request)
Execute a dataWeave script in the context of an application.
|
void |
setMuleVersion(String muleVersion) |
void |
setToolingApiUrl(URL url,
long defaultConnectTimeout,
long defaultReadTimeout,
Optional<org.mule.tooling.client.api.configuration.ssl.SslConfiguration> sslConfiguration,
Optional<org.mule.tooling.client.api.configuration.agent.proxy.ProxyConfig> proxyConfig,
String authorizationToken)
Sets
URL for the Remote Mule Runtime Agent Tooling API to configure the client. |
org.mule.tooling.client.api.connectivity.ConnectionValidationResult |
testConnection(List<com.mulesoft.agent.domain.tooling.BundleDescriptor> dependencies,
org.mule.runtime.app.declaration.api.ArtifactDeclaration artifactDeclaration,
String componentId,
long readTimeout)
Does connection testing from a temporary application with the given configuration and extensions for the componentId.
|
org.mule.tooling.client.api.connectivity.ConnectionValidationResult |
testConnection(String sessionId,
String configName)
Test a connection defined in the given
org.mule.tooling.client.api.declaration.session.DeclarationSession. |
org.mule.tooling.client.api.connectivity.ConnectionValidationResult |
testConnectionApplication(String applicationId,
String componentId,
long readTimeout)
Does connection testing over the
componentId given for the application with the applicationId identifier. |
org.mule.tooling.client.api.connectivity.ConnectionValidationResult |
testConnectionDomain(String domainId,
String componentId,
long readTimeout)
Does connection testing over the
componentId given for the domain with the domainId identifier. |
void setToolingApiUrl(URL url, long defaultConnectTimeout, long defaultReadTimeout, Optional<org.mule.tooling.client.api.configuration.ssl.SslConfiguration> sslConfiguration, Optional<org.mule.tooling.client.api.configuration.agent.proxy.ProxyConfig> proxyConfig, String authorizationToken)
URL for the Remote Mule Runtime Agent Tooling API to configure the client.url - URL to the base URL for the Mule Runtime Agent.defaultConnectTimeout - default connection timeout for REST client.defaultReadTimeout - default read timeout for REST client.sslConfiguration - Optional SslConfiguration for the Mule Runtime Agent.proxyConfig - Optional ProxyConfig for the Mule Runtime Agent.authorizationToken - Token to communicate with agent securely.IllegalStateException - if a baseUrl was already set.void setMuleVersion(String muleVersion)
muleVersion - defines the API version to be called.boolean isOperational()
true if the remote tooling service is operational and ready to be used.String deployApplication(String id, File appLocation, String domainName, Map<String,String> deploymentProperties) throws org.mule.tooling.client.api.exception.DeploymentException, org.mule.tooling.client.api.exception.ServiceUnavailableException
appLocation that points to the exploded application
content.
The application content is copied from the specified location, be aware that the original files are not modified or watched later.
id - predefined identifier for the application deployment, if Runtime Agent doesn't support it an autogenerated
identifier will be returned, if not the same.appLocation - File to the application exploded content.domainName - String to the domain name to be linked to when deploying this application. Can be null.String application identifier for the application deployed.org.mule.tooling.client.api.exception.DeploymentException - if there was an error while deploying the application.org.mule.tooling.client.api.exception.ServiceUnavailableException - if a connection exception happens when trying to connect to Mule Agent REST API.default String deployApplication(String id, File appLocation, Map<String,String> deploymentProperties) throws org.mule.tooling.client.api.exception.DeploymentException, org.mule.tooling.client.api.exception.ServiceUnavailableException
appLocation that points to the exploded application
content.
The application content is copied from the specified location, be aware that the original files are not modified or watched later.
id - predefined identifier for the application deployment, if Runtime Agent doesn't support it an autogenerated
identifier will be returned, if not the same. Can be null.appLocation - File to the application exploded content.String application identifier for the application deployed.org.mule.tooling.client.api.exception.DeploymentException - if there was an error while deploying the application.org.mule.tooling.client.api.exception.ServiceUnavailableException - if a connection exception happens when trying to connect to Mule Agent REST API.String deployDomain(String id, File domainLocation, Map<String,String> deploymentProperties) throws org.mule.tooling.client.api.exception.DeploymentException, org.mule.tooling.client.api.exception.ServiceUnavailableException
domainLocation that points to the exploded domain content.
The domain content is copied from the specified location, be aware that the original files are not modified or watched later.
id - predefined identifier for the application deployment, if Runtime Agent doesn't support it an
autogenerated identifier will be returned, if not the same. Can be null.domainLocation - File to the domain exploded content.String application identifier for the domain deployed.org.mule.tooling.client.api.exception.DeploymentException - if there was an error while deploying the domain.org.mule.tooling.client.api.exception.ServiceUnavailableException - if a connection exception happens when trying to connect to Mule Agent REST API.String deployApplication(String id, InputStream inputStream, Map<String,String> deploymentProperties) throws org.mule.tooling.client.api.exception.DeploymentException, org.mule.tooling.client.api.exception.ServiceUnavailableException
inputStream.id - predefined identifier for the application deployment, if Runtime Agent doesn't support it an autogenerated
identifier will be returned, if not the same. Can be null.inputStream - InputStream with the content of the application jar file.String application identifier for the application deployed.org.mule.tooling.client.api.exception.DeploymentException - if there was an error while deploying the application.org.mule.tooling.client.api.exception.ServiceUnavailableException - if a connection exception happens when trying to connect to Mule Agent REST API.String deployApplication(String id, InputStream inputStream, String domainName, Map<String,String> deploymentProperties) throws org.mule.tooling.client.api.exception.DeploymentException, org.mule.tooling.client.api.exception.ServiceUnavailableException
inputStream.id - predefined identifier for the application deployment, if Runtime Agent doesn't support it an autogenerated
identifier will be returned, if not the same. Can be null.inputStream - InputStream with the content of the application jar file.domainName - String to the domain name to be linked to when deploying this application. Can be null.String application identifier for the application deployed.org.mule.tooling.client.api.exception.DeploymentException - if there was an error while deploying the application.org.mule.tooling.client.api.exception.ServiceUnavailableException - if a connection exception happens when trying to connect to Mule Agent REST API.String deployDomain(String id, InputStream inputStream, Map<String,String> deploymentProperties) throws org.mule.tooling.client.api.exception.DeploymentException, org.mule.tooling.client.api.exception.ServiceUnavailableException
inputStream.id - predefined identifier for the application deployment, if Runtime Agent doesn't support it an autogenerated
identifier will be returned, if not the same. Can be null.inputStream - InputStream with the content of the domain jar file.String application identifier for the domain deployed.org.mule.tooling.client.api.exception.DeploymentException - if there was an error while deploying the domain.org.mule.tooling.client.api.exception.ServiceUnavailableException - if a connection exception happens when trying to connect to Mule Agent REST API.void disposeApplication(String applicationId) throws org.mule.tooling.client.api.exception.ServiceUnavailableException
applicationId.applicationId - String identifies the application to be disposed.org.mule.tooling.client.api.exception.ServiceUnavailableException - if a connection exception happens when trying to connect to Mule Agent REST API.org.mule.tooling.client.api.exception.ToolingException - if an unexpected error happens.void disposeDomain(String domainId) throws org.mule.tooling.client.api.exception.ServiceUnavailableException
domainId.domainId - String identifies the domain to be disposed.org.mule.tooling.client.api.exception.ServiceUnavailableException - if a connection exception happens when trying to connect to Mule Agent REST API.org.mule.tooling.client.api.exception.ToolingException - if an unexpected error happens.org.mule.tooling.client.api.connectivity.ConnectionValidationResult testConnectionApplication(String applicationId, String componentId, long readTimeout) throws org.mule.tooling.client.api.exception.NoSuchApplicationException, org.mule.tooling.client.api.connectivity.UnsupportedConnectivityTestingObjectException, org.mule.tooling.client.api.connectivity.ConnectivityTestingObjectNotFoundException, org.mule.tooling.client.api.exception.ServiceUnavailableException
componentId given for the application with the applicationId identifier.applicationId - String identifies the application to be tested.componentId - String identifies the component to be tested.readTimeout - read timeout in millisecondsConnectionValidationResult with the result of the test.org.mule.tooling.client.api.exception.NoSuchApplicationException - if the application is not deployed or it was evicted by the the service
(free resources).org.mule.tooling.client.api.connectivity.UnsupportedConnectivityTestingObjectException - when it's not possible to do connectivity testing over the mule
component.org.mule.tooling.client.api.connectivity.ConnectivityTestingObjectNotFoundException - when the object to use to do connectivity does not exists.org.mule.tooling.client.api.exception.ToolingException - if an unexpected error happens.org.mule.tooling.client.api.exception.ServiceUnavailableException - if a connection exception happens when trying to connect to Mule Agent
REST API.org.mule.tooling.client.api.connectivity.ConnectionValidationResult testConnectionDomain(String domainId, String componentId, long readTimeout) throws org.mule.tooling.client.api.exception.NoSuchApplicationException, org.mule.tooling.client.api.connectivity.UnsupportedConnectivityTestingObjectException, org.mule.tooling.client.api.connectivity.ConnectivityTestingObjectNotFoundException, org.mule.tooling.client.api.exception.ServiceUnavailableException
componentId given for the domain with the domainId identifier.domainId - String identifies the domain to be tested.componentId - String identifies the component to be tested.readTimeout - read timeout in millisecondsConnectionValidationResult with the result of the test.org.mule.tooling.client.api.exception.NoSuchApplicationException - if the domain is not deployed or it was evicted by the the service
(free resources).org.mule.tooling.client.api.connectivity.UnsupportedConnectivityTestingObjectException - when it's not possible to do connectivity testing over the mule
component.org.mule.tooling.client.api.connectivity.ConnectivityTestingObjectNotFoundException - when the object to use to do connectivity does not exists.org.mule.tooling.client.api.exception.ToolingException - if an unexpected error happens.org.mule.tooling.client.api.exception.ServiceUnavailableException - if a connection exception happens when trying to connect to Mule Agent
REST API.org.mule.tooling.client.api.connectivity.ConnectionValidationResult testConnection(List<com.mulesoft.agent.domain.tooling.BundleDescriptor> dependencies, org.mule.runtime.app.declaration.api.ArtifactDeclaration artifactDeclaration, String componentId, long readTimeout) throws org.mule.tooling.client.api.connectivity.UnsupportedConnectivityTestingObjectException, org.mule.tooling.client.api.connectivity.ConnectivityTestingObjectNotFoundException, org.mule.tooling.client.api.exception.ServiceUnavailableException
dependencies - BundleDescriptor's libraries to be used by the application.artifactDeclaration - ArtifactDeclaration defines the application configuration.componentId - String identifies the component to be tested.readTimeout - read timeout in millisecondsConnectionValidationResult with the result of the test.org.mule.tooling.client.api.connectivity.UnsupportedConnectivityTestingObjectException - when it's not possible to do connectivity testing over the mule
component.ConnectivityTestingObjectNotFoundException} - when the object to use to do connectivity does not exists.org.mule.tooling.client.api.exception.ToolingException - if an unexpected error happens.org.mule.tooling.client.api.exception.ServiceUnavailableException - if a connection exception happens when trying to connect to Mule Agent
REST API.org.mule.tooling.client.api.connectivity.ConnectivityTestingObjectNotFoundExceptionorg.mule.runtime.api.metadata.resolving.MetadataResult<org.mule.runtime.api.metadata.MetadataKeysContainer> getMetadataKeysApplication(String applicationId, String componentLocation, long readTimeout) throws org.mule.tooling.client.api.exception.ServiceUnavailableException
MetadataResult of MetadataKey described by
MetadataKeyProvider.getMetadataKeys() of the associated
MetadataKeyProvider component identified by the given applicationId and
componentLocation.applicationId - String identifies the application.componentLocation - the location path of the MetadataKeyProvider component inside
the flow.readTimeout - read timeout in millisecondsMetadataResult if the keys are successfully resolved Failure. MetadataResult if there is
an error while resolving the keys.org.mule.tooling.client.api.exception.ToolingException - if an unexpected error happens.org.mule.tooling.client.api.exception.ServiceUnavailableException - if a connection exception happens when trying to connect to Mule Agent REST API.org.mule.runtime.api.metadata.resolving.MetadataResult<org.mule.runtime.api.metadata.MetadataKeysContainer> getMetadataKeysDomain(String domainId, String componentLocation, long readTimeout) throws org.mule.tooling.client.api.exception.ServiceUnavailableException
MetadataResult of MetadataKey described by
MetadataKeyProvider.getMetadataKeys() of the associated
MetadataKeyProvider component identified by the given domainId and componentLocation.domainId - String identifies the domain.componentLocation - the location path of the MetadataKeyProvider component inside
the flow.readTimeout - read timeout in millisecondsMetadataResult if the keys are successfully resolved Failure. MetadataResult if there is
an error while resolving the keys.org.mule.tooling.client.api.exception.ToolingException - if an unexpected error happens.org.mule.tooling.client.api.exception.ServiceUnavailableException - if a connection exception happens when trying to connect to Mule Agent REST API.org.mule.runtime.api.metadata.resolving.MetadataResult<org.mule.runtime.api.metadata.descriptor.ComponentMetadataDescriptor<org.mule.runtime.api.meta.model.operation.OperationModel>> getOperationMetadata(String applicationId, String componentLocation, long readTimeout) throws org.mule.tooling.client.api.exception.ServiceUnavailableException
applicationId - String identifies the application.componentLocation - the location path of the operation message processor component inside the flow.readTimeout - read timeout in millisecondsComponentMetadataDescriptor with the Metadata representation of the Component. Successful
MetadataResult if the Metadata is successfully retrieved. Failure MetadataResult when the Metadata
retrieval of any element fails for any reasonorg.mule.tooling.client.api.exception.ToolingException - if an unexpected error happens.org.mule.tooling.client.api.exception.ServiceUnavailableException - if a connection exception happens when trying to connect to Mule Agent REST API.org.mule.runtime.api.metadata.resolving.MetadataResult<org.mule.runtime.api.metadata.descriptor.ComponentMetadataDescriptor<org.mule.runtime.api.meta.model.source.SourceModel>> getSourceMetadata(String applicationId, String componentLocation, long readTimeout) throws org.mule.tooling.client.api.exception.ServiceUnavailableException
applicationId - String identifies the application.componentLocation - the location of the component to be queried as
MetadataKeyProvider component.readTimeout - read timeout in millisecondsComponentMetadataDescriptor with the Metadata representation of the Component. Successful
MetadataResult if the Metadata is successfully retrieved. Failure MetadataResult when the Metadata
retrieval of any element fails for any reasonorg.mule.tooling.client.api.exception.ToolingException - if an unexpected error happens.org.mule.tooling.client.api.exception.ServiceUnavailableException - if a connection exception happens when trying to connect to Mule Agent REST API.SampleDataMessageModelResult getSampleDataApplication(String applicationId, String componentLocation, long readTimeout) throws org.mule.tooling.client.api.exception.ServiceUnavailableException
applicationId - String identifies the application.componentLocation - the location of the component to be queried as
org.mule.sdk.api.data.sample.SampleDataProvider component.readTimeout - read timeout in millisecondsSampleDataMessageModelResult with the SampleData result of the Component. Successful
SampleDataMessageModelResult if the Sample Data is successfully retrieved. Failure
SampleDataMessageModelResult when the SampleData retrieval of any element fails for any reasonorg.mule.tooling.client.api.exception.ToolingException - if an unexpected error happens.org.mule.tooling.client.api.exception.ServiceUnavailableException - if a connection exception happens when trying to connect to Mule Agent REST API.void disposeApplicationMetadataCache(String applicationId, String hashKey)
applicationId - String identifies the application.hashKey - could be generated for a component or just for a particular component.void disposeDomainMetadataCache(String domainId, String hashKey)
domainId - String identifies the domain.hashKey - could be generated for a component or just for a particular component.void enableMessageHistory(String applicationName) throws org.mule.tooling.client.api.exception.NoSuchApplicationException
applicationName - the name of the application to be used when deploying it.org.mule.tooling.client.api.exception.NoSuchApplicationException - if the application to be enable for message history is not already deployed.void disableMessageHistory(String applicationName)
applicationName - the name of the application to be disabled.List<AgentTrackingNotificationResponse> consumeMessageHistoryNotifications(String applicationName, int chunkSize)
applicationName - the name of the application to get its message history notifications.chunkSize - the maximum number of notifications to be consumed by this request.List of AgentTrackingNotification collected by the remote service at this moment.com.mulesoft.agent.domain.tooling.dataweave.model.PreviewResponse runDataWeaveApplication(String applicationId, com.mulesoft.agent.domain.tooling.dataweave.model.PreviewRequest request)
applicationId - application that provides contextrequest - parameters for running previewcom.mulesoft.agent.domain.tooling.dataweave.model.PreviewResponse runDataWeaveDomain(String applicationId, com.mulesoft.agent.domain.tooling.dataweave.model.PreviewRequest request)
applicationId - application that provides contextrequest - parameters for running previeworg.mule.runtime.api.value.ValueResult getValuesApplication(String applicationId, String location, String providerName)
values for a component's value provider located in the given Location.location - The Location where the configuration can be found.providerName - The name of the value provider to resolve the values.result of the resolving of the values.ValueResultorg.mule.runtime.api.value.ValueResult getValuesDomain(String domainId, String location, String providerName)
values for a component's value provider located in the given Location.location - The Location where the configuration can be found.providerName - The name of the value provider to resolve the values.result of the resolving of the values.ValueResultString createDeclarationSession(DeclarationSessionCreationRequest declarationSessionCreationRequest)
org.mule.tooling.client.api.declaration.session.DeclarationSession to perform design time operationsdeclarationSessionCreationRequest - contains all the information required to create the
org.mule.tooling.client.api.declaration.session.DeclarationSessionvoid disposeDeclarationSession(String id)
org.mule.tooling.client.api.declaration.session.DeclarationSession with the given id if it existsid - the id of the org.mule.tooling.client.api.declaration.session.DeclarationSession to disposeorg.mule.runtime.api.value.ValueResult getValues(String sessionId, org.mule.runtime.app.declaration.api.ParameterizedElementDeclaration parameterizedElementDeclaration, String providerName)
ComponentElementDeclaration and the
org.mule.tooling.client.api.declaration.session.DeclarationSession with the given sessionId.sessionId - The id of the
org.mule.tooling.client.api.declaration.session.DeclarationSession used to
resolve the valuesparameterizedElementDeclaration - The ParameterizedElementDeclaration containing the parameter for which to
resolve the possible values. It should also contain all required information needed to
correctly retrieve the values, like other parameters that affect resolution or
references to config.providerName - The name of the provider defined by the parameter within the given
ComponentElementDeclaration for which to resolve possible values.ValueResult with the result of the getValues request.org.mule.runtime.api.value.ValueResult getFieldValues(String sessionId, org.mule.runtime.app.declaration.api.ParameterizedElementDeclaration parameterizedElementDeclaration, String providerName, String targetSelector)
ComponentElementDeclaration and
the org.mule.tooling.client.api.declaration.session.DeclarationSession with the given sessionId.sessionId - The id of the
org.mule.tooling.client.api.declaration.session.DeclarationSession used to
resolve the valuesparameterizedElementDeclaration - The ParameterizedElementDeclaration containing the parameter with the field
for which to resolve the possible values. It should also contain all required
information needed to correctly retrieve the values, like other parameters that affect
resolution or references to config.providerName - The name of the provider defined by the parameter within the given
ComponentElementDeclaration for which to resolve possible values.targetSelector - The path to identify the field within the parameterValueResult with the result of the getValues request.org.mule.runtime.api.metadata.resolving.MetadataResult<org.mule.runtime.api.metadata.MetadataKeysContainer> getComponentMetadataKeys(String sessionId, org.mule.runtime.app.declaration.api.ComponentElementDeclaration componentElementDeclaration, boolean ignoreCache)
ComponentElementDeclaration and the
org.mule.tooling.client.api.declaration.session.DeclarationSession with the given sessionId.sessionId - The id of the org.mule.tooling.client.api.declaration.session.DeclarationSession
used to resolve the metadata keyscomponentElementDeclaration - The ComponentElementDeclaration to resolve its metadata keys. It should also
contain all required information needed to correctly retrieve the keys, like partial key
or references to configs.ignoreCache - If true cache on Runtime side for Metadata would be disposed first and then
resolution would be made.MetadataResult with the result of the getComponentMetadataKeys request.org.mule.tooling.client.api.connectivity.ConnectionValidationResult testConnection(String sessionId, String configName)
org.mule.tooling.client.api.declaration.session.DeclarationSession.sessionId - The id of the org.mule.tooling.client.api.declaration.session.DeclarationSession that contains the
connection to test.configName - The name of the config that contains the connection to test.ConnectionValidationResult with the result of the testConnection operation.org.mule.runtime.api.metadata.resolving.MetadataResult<org.mule.runtime.api.metadata.descriptor.ComponentMetadataTypesDescriptor> getComponentMetadata(String sessionId, org.mule.runtime.app.declaration.api.ComponentElementDeclaration componentElementDeclaration, boolean ignoreCache)
ComponentElementDeclaration and the *
org.mule.tooling.client.api.declaration.session.DeclarationSession with the given sessionId.sessionId - The id of the org.mule.tooling.client.api.declaration.session.DeclarationSession
that contains the connection to test.componentElementDeclaration - The ComponentElementDeclaration containing the metadata key for which to resolve
dynamic types. It should also contain all required metadata key parts needed to correctly
or references to config to resolve metadata.ignoreCache - If true cache on Runtime side for Metadata would be disposed first and then
resolution would be made.MetadataResult with the result of the metadata resolution.SampleDataMessageModelResult getSampleData(String sessionId, org.mule.runtime.app.declaration.api.ComponentElementDeclaration componentElementDeclaration)
ComponentElementDeclaration and the
org.mule.tooling.client.api.declaration.session.DeclarationSession with the given sessionId.sessionId - The id of the org.mule.tooling.client.api.declaration.session.DeclarationSession
used to resolve the sample datacomponentElementDeclaration - The ComponentElementDeclaration with all required information needed to correctly
retrieve the sample data, like parameters, config and connection.SampleDataMessageModelResult with the result of the sample data request.Copyright © 2022 MuleSoft, Inc.. All rights reserved.