UpdateJobRequest.Builder (alibabacloud-sae20190506 2.0.37 API)

java.lang.Object
- com.aliyun.sdk.service.sae20190506.models.UpdateJobRequest.Builder

所有已实现的接口:

darabonba.core.RequestModel.Builder<UpdateJobRequest,UpdateJobRequest.Builder>

封闭类:

UpdateJobRequest
```
public static final class UpdateJobRequest.Builder
extends Object
```

方法概要

所有方法实例方法具体方法
限定符和类型	方法和说明
`UpdateJobRequest.Builder`	`acrAssumeRoleArn(String acrAssumeRoleArn)` The Alibaba Cloud Resource Name (ARN) of the RAM role that is used to pull images across accounts.
`UpdateJobRequest.Builder`	`acrInstanceId(String acrInstanceId)` The ID of Container Registry Enterprise Edition instance N.
`UpdateJobRequest.Builder`	`appId(String appId)` The ID of the application.
`UpdateJobRequest.Builder`	`backoffLimit(Long backoffLimit)` The number of times the job is retried.
`UpdateJobRequest.Builder`	`bestEffortType(String bestEffortType)` BestEffortType.
`UpdateJobRequest`	`build()`
`UpdateJobRequest.Builder`	`command(String command)` The command that is used to start the image.
`UpdateJobRequest.Builder`	`commandArgs(String commandArgs)` The parameters of the image startup command.
`UpdateJobRequest.Builder`	`concurrencyPolicy(String concurrencyPolicy)` The concurrency policy of the job.
`UpdateJobRequest.Builder`	`configMapMountDesc(String configMapMountDesc)` The description of the ConfigMap instance mounted to the application.
`UpdateJobRequest.Builder`	`customHostAlias(String customHostAlias)` The custom mappings between hostnames and IP addresses in the container.
`UpdateJobRequest.Builder`	`edasContainerVersion(String edasContainerVersion)` The version of the container, such as Ali-Tomcat, in which an application developed based on High-speed Service Framework (HSF) is deployed.
`UpdateJobRequest.Builder`	`enableImageAccl(Boolean enableImageAccl)` EnableImageAccl.
`UpdateJobRequest.Builder`	`envs(String envs)` The environment variables.
`UpdateJobRequest.Builder`	`imagePullSecrets(String imagePullSecrets)` The ID of the corresponding Secret.
`UpdateJobRequest.Builder`	`imageUrl(String imageUrl)` The URL of the image.
`UpdateJobRequest.Builder`	`jarStartArgs(String jarStartArgs)` The arguments in the JAR package.
`UpdateJobRequest.Builder`	`jarStartOptions(String jarStartOptions)` The option settings in the JAR package.
`UpdateJobRequest.Builder`	`jdk(String jdk)` The version of the Java development kit (JDK) on which the deployment package of the application depends.
`UpdateJobRequest.Builder`	`mountDesc(String mountDesc)` The configurations for mounting the NAS file system.
`UpdateJobRequest.Builder`	`mountHost(String mountHost)` The mount target of the NAS file system in the VPC where the application is deployed.
`UpdateJobRequest.Builder`	`nasConfigs(String nasConfigs)` NasConfigs.
`UpdateJobRequest.Builder`	`nasId(String nasId)` The ID of the Apsara File Storage NAS file system.
`UpdateJobRequest.Builder`	`ossAkId(String ossAkId)` The AccessKey ID that is used to read data from and write data to OSS.
`UpdateJobRequest.Builder`	`ossAkSecret(String ossAkSecret)` The AccessKey secret that is used to read data from and write data to OSS.
`UpdateJobRequest.Builder`	`ossMountDescs(String ossMountDescs)` The information about the mounted Object Storage Service (OSS) bucket.
`UpdateJobRequest.Builder`	`packageUrl(String packageUrl)` The address of the deployment package.
`UpdateJobRequest.Builder`	`packageVersion(String packageVersion)` The version of the deployment package.
`UpdateJobRequest.Builder`	`php(String php)` The ID of Container Registry Enterprise Edition instance N.
`UpdateJobRequest.Builder`	`phpConfig(String phpConfig)` The details of the PHP configuration file.
`UpdateJobRequest.Builder`	`phpConfigLocation(String phpConfigLocation)` The path on which the PHP configuration file for application startup is mounted.
`UpdateJobRequest.Builder`	`postStart(String postStart)` The script to be run after the container is started.
`UpdateJobRequest.Builder`	`preStop(String preStop)` The script that is run before the container is stopped.
`UpdateJobRequest.Builder`	`programmingLanguage(String programmingLanguage)` The programming language.
`UpdateJobRequest.Builder`	`python(String python)` The Python environment.
`UpdateJobRequest.Builder`	`pythonModules(String pythonModules)` The configurations for installing custom module dependencies.
`UpdateJobRequest.Builder`	`refAppId(String refAppId)` The ID of the job that you reference.
`UpdateJobRequest.Builder`	`replicas(String replicas)` The number of concurrent instances.
`UpdateJobRequest.Builder`	`slice(Boolean slice)` Specifies whether to enable job sharding.
`UpdateJobRequest.Builder`	`sliceEnvs(String sliceEnvs)` The parameters of job sharding.
`UpdateJobRequest.Builder`	`slsConfigs(String slsConfigs)` The configurations of Log Service.
`UpdateJobRequest.Builder`	`terminationGracePeriodSeconds(Integer terminationGracePeriodSeconds)` The timeout period for a graceful shutdown.
`UpdateJobRequest.Builder`	`timeout(Long timeout)` The timeout period.
`UpdateJobRequest.Builder`	`timezone(String timezone)` The time zone.
`UpdateJobRequest.Builder`	`tomcatConfig(String tomcatConfig)` The Tomcat configuration.
`UpdateJobRequest.Builder`	`triggerConfig(String triggerConfig)` TriggerConfig.
`UpdateJobRequest.Builder`	`warStartOptions(String warStartOptions)` The startup command of the WAR package.
`UpdateJobRequest.Builder`	`webContainer(String webContainer)` The version of the Tomcat container on which the deployment package depends.

从类继承的方法 java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- 方法详细资料
  - acrAssumeRoleArn
```
public UpdateJobRequest.Builder acrAssumeRoleArn(String acrAssumeRoleArn)
```
    The Alibaba Cloud Resource Name (ARN) of the RAM role that is used to pull images across accounts. For more information, see Grant permissions across Alibaba Cloud accounts by using a RAM role.
    example:
    acs:ram::123456789012****:role/adminrole
  - acrInstanceId
```
public UpdateJobRequest.Builder acrInstanceId(String acrInstanceId)
```
    The ID of Container Registry Enterprise Edition instance N. This parameter is required when the ImageUrl parameter is set to the URL of an image in an ACR Enterprise Edition instance.
    example:
    cri-xxxxxx
  - appId
```
public UpdateJobRequest.Builder appId(String appId)
```
    The ID of the application.
    
    This parameter is required.
    example:
    7171a6ca-d1cd-4928-8642-7d5cfe69****
  - backoffLimit
```
public UpdateJobRequest.Builder backoffLimit(Long backoffLimit)
```
    The number of times the job is retried.
    example:
    3
  - bestEffortType
```
public UpdateJobRequest.Builder bestEffortType(String bestEffortType)
```
    BestEffortType.
  - command
```
public UpdateJobRequest.Builder command(String command)
```
    The command that is used to start the image. The command must be an existing executable object in the container. Example:
```
command:
       - echo
       - abc
       - >
       - file0
 
```
    In this example, the Command parameter is set to Command="echo", CommandArgs=["abc", ">", "file0"].
    example:
    echo
  - commandArgs
```
public UpdateJobRequest.Builder commandArgs(String commandArgs)
```
    The parameters of the image startup command. The CommandArgs parameter specifies the parameters that are required for the Command parameter. The name must meet the following format requirements:
    
    ["a","b"]
    
    In the preceding example, the CommandArgs parameter is set to CommandArgs=["abc", ">", "file0"]. The data type of ["abc", ">", "file0"] must be an array of strings in the JSON format. This parameter is optional.
    example:
    ["a","b"]
  - concurrencyPolicy
```
public UpdateJobRequest.Builder concurrencyPolicy(String concurrencyPolicy)
```
    The concurrency policy of the job. Valid values:
    - Forbid: Prohibits concurrent running. If the previous job is not completed, no new job is created.
    - Allow: Allows concurrent running.
    - Replace: If the previous job is not completed when the time to create a new job is reached, the new job replaces the previous job.
    example:
    Allow
  - configMapMountDesc
```
public UpdateJobRequest.Builder configMapMountDesc(String configMapMountDesc)
```
    The description of the ConfigMap instance mounted to the application. Use configurations created on the Configuration Items page to configure containers. The following parameters are involved:
    - congfigMapId: the ID of the ConfigMap instance. You can call the ListNamespacedConfigMaps operation to obtain the ID.
    - key: the key.
    You can use the sae-sys-configmap-all key to mount all keys.
    - mountPath: the mount path.
    example:
    [{"configMapId":16,"key":"test","mountPath":"/tmp"}]
  - customHostAlias
```
public UpdateJobRequest.Builder customHostAlias(String customHostAlias)
```
    The custom mappings between hostnames and IP addresses in the container. Valid values:
    - hostName: the domain name or hostname.
    - ip: the IP address.
    example:
    [{"hostName":"samplehost","ip":"127.0.0.1"}]
  - edasContainerVersion
```
public UpdateJobRequest.Builder edasContainerVersion(String edasContainerVersion)
```
    The version of the container, such as Ali-Tomcat, in which an application developed based on High-speed Service Framework (HSF) is deployed.
    example:
    3.5.3
  - enableImageAccl
```
public UpdateJobRequest.Builder enableImageAccl(Boolean enableImageAccl)
```
    EnableImageAccl.
  - envs
```
public UpdateJobRequest.Builder envs(String envs)
```
    The environment variables. You can configure custom environment variables or reference a ConfigMap. If you want to reference a ConfigMap, you must first create a ConfigMap. For more information, see CreateConfigMap. Valid values:
    - Configure custom environment variables
      
      name: the name of the environment variable.
      
      value: the value of the environment variable.
    - Reference ConfigMap
      
      name: the name of the environment variable. You can reference one or all keys. If you want to reference all keys, specify sae-sys-configmap-all-<ConfigMap name>. Example: sae-sys-configmap-all-test1.
      
      valueFrom: the reference of the environment variable. Set the value to configMapRef.
      
      configMapId: the ConfigMap ID.
      
      key: the key. If you want to reference all keys, do not configure this parameter.
    example:
    [{"name":"envtmp","value":"0"}]
  - imagePullSecrets
```
public UpdateJobRequest.Builder imagePullSecrets(String imagePullSecrets)
```
    The ID of the corresponding Secret.
    example:
    10
  - imageUrl
```
public UpdateJobRequest.Builder imageUrl(String imageUrl)
```
    The URL of the image. This parameter is returned only if the PackageType parameter is set to Image.
    example:
    registry.cn-hangzhou.aliyuncs.com/sae_test/ali_sae_test:0.0.1
  - jarStartArgs
```
public UpdateJobRequest.Builder jarStartArgs(String jarStartArgs)
```
    The arguments in the JAR package. The arguments are used to start the application container. The default startup command is $JAVA_HOME/bin/java $JarStartOptions -jar $CATALINA_OPTS "$package_path" $JarStartArgs.
    example:
    -Xms4G -Xmx4G
  - jarStartOptions
```
public UpdateJobRequest.Builder jarStartOptions(String jarStartOptions)
```
    The option settings in the JAR package. The settings are used to start the application container. The default startup command for application deployment is $JAVA_HOME/bin/java $JarStartOptions -jar $CATALINA_OPTS "$package_path" $JarStartArgs.
    example:
    custom-option
  - jdk
```
public UpdateJobRequest.Builder jdk(String jdk)
```
    The version of the Java development kit (JDK) on which the deployment package of the application depends. The following versions are supported:
    - Open JDK 8
    - Open JDK 7
    - Dragonwell 11
    - Dragonwell 8
    - openjdk-8u191-jdk-alpine3.9
    - openjdk-7u201-jdk-alpine3.9
    This parameter is not returned if the PackageType parameter is set to Image.
    example:
    Open JDK 8
  - mountDesc
```
public UpdateJobRequest.Builder mountDesc(String mountDesc)
```
    The configurations for mounting the NAS file system. If you do not need to modify the NAS configurations when you deploy the application, configure MountDesc only in the first request. If you no longer need to use NAS, leave MountDesc empty in the request.
    example:
    [{mountPath: "/tmp", nasPath: "/"}]
  - mountHost
```
public UpdateJobRequest.Builder mountHost(String mountHost)
```
    The mount target of the NAS file system in the VPC where the application is deployed. If you do not need to modify this configuration during the deployment, configure the MountHost parameter only in the first request. You do not need to include this parameter in subsequent requests. If you need to remove this configuration, leave the MountHost parameter empty in the request.
    example:
    10d3b4bc9****.com
  - nasConfigs
```
public UpdateJobRequest.Builder nasConfigs(String nasConfigs)
```
    NasConfigs.
  - nasId
```
public UpdateJobRequest.Builder nasId(String nasId)
```
    The ID of the Apsara File Storage NAS file system. If you do not need to modify the NAS configurations when you deploy the application, configure NasId only in the first request. If you no longer need to use NAS, leave NasId empty in the request.
    example:
    10d3b4****
  - ossAkId
```
public UpdateJobRequest.Builder ossAkId(String ossAkId)
```
    The AccessKey ID that is used to read data from and write data to OSS.
    example:
    xxxxxx
  - ossAkSecret
```
public UpdateJobRequest.Builder ossAkSecret(String ossAkSecret)
```
    The AccessKey secret that is used to read data from and write data to OSS.
    example:
    xxxxxx
  - ossMountDescs
```
public UpdateJobRequest.Builder ossMountDescs(String ossMountDescs)
```
    The information about the mounted Object Storage Service (OSS) bucket. The following parameters are involved:
    - bucketName: the name of the OSS bucket.
    - bucketPath: the directory or object in OSS. If the specified directory or object does not exist, an error is returned.
    - mountPath: the directory of the container in SAE. If the path already exists, the newly specified path overwrites the previous one. If the path does not exist, it is created.
    - readOnly: specifies whether to only allow the container path to read data from the OSS directory. Valid values:
      
      true: The container path only has read permission on the OSS directory.
      
      false: The application has read and write permissions.
    example:
    [{"bucketName": "oss-bucket", "bucketPath": "data/user.data", "mountPath": "/usr/data/user.data", "readOnly": true}]
  - packageUrl
```
public UpdateJobRequest.Builder packageUrl(String packageUrl)
```
    The address of the deployment package. This parameter is required if you set PackageType to FatJar, War, or PythonZip.
    example:
    http://myoss.oss-cn-hangzhou.aliyuncs.com/my-buc/2019-06-30/****.jar
  - packageVersion
```
public UpdateJobRequest.Builder packageVersion(String packageVersion)
```
    The version of the deployment package. This parameter is required if you set PackageType to FatJar, War, or PythonZip.
    example:
    1.0.1
  - php
```
public UpdateJobRequest.Builder php(String php)
```
    The ID of Container Registry Enterprise Edition instance N.
    example:
    cri-xxxxxx
  - phpConfig
```
public UpdateJobRequest.Builder phpConfig(String phpConfig)
```
    The details of the PHP configuration file.
    example:
    k1=v1
  - phpConfigLocation
```
public UpdateJobRequest.Builder phpConfigLocation(String phpConfigLocation)
```
    The path on which the PHP configuration file for application startup is mounted. Make sure that the PHP server uses this configuration file during the startup.
    example:
    /usr/local/etc/php/php.ini
  - postStart
```
public UpdateJobRequest.Builder postStart(String postStart)
```
    The script to be run after the container is started. Example: {"exec":{"command":["sh","-c","echo hello"\]}}
    example:
    {"exec":{"command":["sh","-c","echo hello"]}}
  - preStop
```
public UpdateJobRequest.Builder preStop(String preStop)
```
    The script that is run before the container is stopped. Example: {"exec":{"command":["sh","-c","echo hello"\]}}
    example:
    {"exec":{"command":["sh","-c","echo hello"]}}
  - programmingLanguage
```
public UpdateJobRequest.Builder programmingLanguage(String programmingLanguage)
```
    The programming language. Valid values: java, php, python, and shell.
    example:
    java
  - python
```
public UpdateJobRequest.Builder python(String python)
```
    The Python environment. Set the value to PYTHON 3.9.15.
    example:
    PYTHON 3.9.15
  - pythonModules
```
public UpdateJobRequest.Builder pythonModules(String pythonModules)
```
    The configurations for installing custom module dependencies. By default, the dependencies defined by the requirements.txt file in the root directory are installed. If the package does not contain this file and you do not configure custom dependencies in the package, specify the dependencies that you want to install in the text box.
    example:
    Flask==2.0
  - refAppId
```
public UpdateJobRequest.Builder refAppId(String refAppId)
```
    The ID of the job that you reference.
    example:
    7171a6ca-d1cd-4928-8642-7d5cfe69****
  - replicas
```
public UpdateJobRequest.Builder replicas(String replicas)
```
    The number of concurrent instances.
    example:
    3
  - slice
```
public UpdateJobRequest.Builder slice(Boolean slice)
```
    Specifies whether to enable job sharding.
    example:
    true
  - sliceEnvs
```
public UpdateJobRequest.Builder sliceEnvs(String sliceEnvs)
```
    The parameters of job sharding.
    example:
    [0,1,2]
  - slsConfigs
```
public UpdateJobRequest.Builder slsConfigs(String slsConfigs)
```
    The configurations of Log Service.
    - To use Log Service resources that are automatically created by SAE, set this parameter to [{"logDir":"","logType":"stdout"},{"logDir":"/tmp/a.log"}].
    - To use custom Log Service resources, set this parameter to [{"projectName":"test-sls","logType":"stdout","logDir":"","logstoreName":"sae","logtailName":""},{"projectName":"test","logDir":"/tmp/a.log","logstoreName":"sae","logtailName":""}].
    The following parameters are involved:
    - projectName: the name of the Log Service project.
    - logDir: the path in which logs are stored.
    - logType: the log type. stdout: the standard output log of the container. You can specify only one stdout value for this parameter. If you leave this parameter empty, file logs are collected.
    - logstoreName: the name of the Logstore in Log Service.
    - logtailName: the name of the Logtail configuration in Log Service. If you do not configure this parameter, a new Logtail configuration is created.
    If you do not need to modify the logging configurations when you deploy the application, configure the SlsConfigs parameter only in the first request. You do not need to include this parameter in subsequent requests. If you no longer need to use Log Service, leave the SlsConfigs parameter empty in the request.
    
    A Log Service project that is automatically created by SAE when you create an application is deleted when the application is deleted. Therefore, when you create an application, you cannot select a Log Service project that is automatically created by SAE for log collection.
    
    example:
    [{"logDir":"","logType":"stdout"},{"logDir":"/tmp/a.log"}]
  - terminationGracePeriodSeconds
```
public UpdateJobRequest.Builder terminationGracePeriodSeconds(Integer terminationGracePeriodSeconds)
```
    The timeout period for a graceful shutdown. Default value: 30. Unit: seconds. Valid values: 1 to 300.
    example:
    10
  - timeout
```
public UpdateJobRequest.Builder timeout(Long timeout)
```
    The timeout period. Unit: seconds.
    example:
    3600
  - timezone
```
public UpdateJobRequest.Builder timezone(String timezone)
```
    The time zone. Default value: Asia/Shanghai.
    example:
    Asia/Shanghai
  - tomcatConfig
```
public UpdateJobRequest.Builder tomcatConfig(String tomcatConfig)
```
    The Tomcat configuration. If you want to delete the configuration, set this parameter to {} or leave this parameter empty. Valid values:
    - port: the port number. The port number ranges from 1024 to 65535. Though the admin permissions are configured for the container, the root permissions are required to perform operations on ports whose number is smaller than 1024. Enter a value that ranges from 1025 to 65535 because the container has only the admin permissions. If you do not specify this parameter, the default port number 8080 is used.
    - contextPath: the path. Default value: /. This value indicates the root directory.
    - maxThreads: the maximum number of connections in the connection pool. Default value: 400.
    - uriEncoding: the URI encoding scheme in the Tomcat container. Valid values: UTF-8, ISO-8859-1, GBK, and GB2312. If you do not specify this parameter, the default value ISO-8859-1 is used.
    - useBodyEncoding: specifies whether to use the encoding scheme that is specified by BodyEncoding for URL. Default value: true.
    example:
    {"port":8080,"contextPath":"/","maxThreads":400,"uriEncoding":"ISO-8859-1","useBodyEncodingForUri":true}
  - triggerConfig
```
public UpdateJobRequest.Builder triggerConfig(String triggerConfig)
```
    TriggerConfig.
  - warStartOptions
```
public UpdateJobRequest.Builder warStartOptions(String warStartOptions)
```
    The startup command of the WAR package. For information about how to configure the startup command, see Configure startup commands.
    example:
    CATALINA_OPTS="$CATALINA_OPTS $Options" catalina.sh run
  - webContainer
```
public UpdateJobRequest.Builder webContainer(String webContainer)
```
    The version of the Tomcat container on which the deployment package depends. The following versions are supported:
    - apache-tomcat-7.0.91
    - apache-tomcat-8.5.42
    This parameter is not returned if the PackageType parameter is set to Image.
    example:
    apache-tomcat-7.0.91
  - build
```
public UpdateJobRequest build()
```

类 UpdateJobRequest.Builder

方法概要

从类继承的方法 java.lang.Object

方法详细资料

acrAssumeRoleArn

acrInstanceId

appId

backoffLimit

bestEffortType

command

commandArgs

concurrencyPolicy

configMapMountDesc

customHostAlias

edasContainerVersion

enableImageAccl

envs

imagePullSecrets

imageUrl

jarStartArgs

jarStartOptions

jdk

mountDesc

mountHost

nasConfigs

nasId

ossAkId

ossAkSecret

ossMountDescs

packageUrl

packageVersion

php

phpConfig

phpConfigLocation

postStart

preStop

programmingLanguage

python

pythonModules

refAppId

replicas

slice

sliceEnvs

slsConfigs

terminationGracePeriodSeconds

timeout

timezone

tomcatConfig

triggerConfig

warStartOptions

webContainer

build