All Downloads are FREE. Search and download functionalities are using the official Maven repository.

com.ibm.optim.oaas.client.job.model.JobCreationData.html Maven / Gradle / Ivy

The newest version!






JobCreationData (Java Client for DOcplexcloud 1.0 API)











com.ibm.optim.oaas.client.job.model

Interface JobCreationData



  • public interface JobCreationData
    Job creation data used to initialize a new job associated with an application.
    • Method Detail

      • getApplicationId

        String getApplicationId()
        Gets the ID of the application.
        Returns:
        The application ID.
      • setApplicationId

        void setApplicationId(String applicationId)
        Sets the application ID.
        Parameters:
        applicationId - The application ID.
      • getApplicationVersion

        String getApplicationVersion()
        Gets version of the application. Reserved for future use.
        Returns:
        The version of the application.
      • setApplicationVersion

        void setApplicationVersion(String applicationVersion)
        Sets the version of the application. Reserved for future use.
        Parameters:
        applicationVersion - Version of the application.
      • getParameters

        JobParameters getParameters()
        Gets the parameters associated with the job. A list of parameters can be specified, and the system parameters have a prefix of 'oaas', but any custom parameters or attributes can be specified so that the client can store and track custom context of the job.
        Returns:
        A map of parameters and values.
      • setClientName

        void setClientName(String name)
        Sets the client name used to identify the client submitting this job. The client name may be used to distinguish between different clients using the same subscription.
        Parameters:
        name - The client name.
      • getClientName

        String getClientName()
        Returns the client name used to identify the client submitting this job.
        Returns:
        the client name
      • setClientEmail

        void setClientEmail(String email)
        Sets the client email address used for notification.
        Parameters:
        email - The client email.
      • getClientEmail

        String getClientEmail()
        Returns the client email used to for notification.
        Returns:
        the client email
      • addJobAttachment

        JobAttachmentCreationData addJobAttachment(String name)
        Adds an input job attachment with a given name.
        Parameters:
        name - The attachment name.
        Returns:
        The created attachment.
      • getAttachment

        JobAttachment getAttachment(String name)
        Gets an attachment to the job.
        Parameters:
        name - Name of attachment.
        Returns:
        The job attachment with the given name.

Copyright © 2015–2017 IBM Corporation. Licensed under the Apache License, Version 2.0.





© 2015 - 2025 Weber Informatics LLC | Privacy Policy