SendFileRequest (ecs20140526 5.4.5 API)

java.lang.Object
- com.aliyun.tea.TeaModel
- - com.aliyun.ecs20140526.models.SendFileRequest

public class SendFileRequest
extends com.aliyun.tea.TeaModel

嵌套类概要

嵌套类
限定符和类型类和说明

static class SendFileRequest.SendFileRequestTag

嵌套类
限定符和类型	类和说明
`static class`	`SendFileRequest.SendFileRequestTag`

字段概要

字段
限定符和类型	字段和说明
`String`	`content` The content of the file.
`String`	`contentType` The content type of the file.
`String`	`description` The description of the file.
`String`	`fileGroup` The group of the file.
`String`	`fileMode` The permissions on the file.
`String`	`fileOwner` The owner of the file.
`List<String>`	`instanceId` The IDs of instances to which to send the file.
`String`	`name` The name of the file.
`Boolean`	`overwrite` Specifies whether to overwrite a file in the destination directory if the file has the same name as the sent file.
`String`	`ownerAccount`
`Long`	`ownerId`
`String`	`regionId` The region ID of the instance to which to send the file.
`String`	`resourceGroupId` The ID of the resource group.
`String`	`resourceOwnerAccount`
`Long`	`resourceOwnerId`
`List<SendFileRequest.SendFileRequestTag>`	`tag` The tags to add to the file sending task.
`String`	`targetDir` The destination directory on the instance to which to send the file.
`Long`	`timeout` The timeout period for the file sending task.

构造器概要

构造器
构造器和说明

SendFileRequest()

构造器
构造器和说明
`SendFileRequest()`

方法概要

所有方法静态方法实例方法具体方法
限定符和类型	方法和说明
`static SendFileRequest`	`build(Map<String,?> map)`
`String`	`getContent()`
`String`	`getContentType()`
`String`	`getDescription()`
`String`	`getFileGroup()`
`String`	`getFileMode()`
`String`	`getFileOwner()`
`List<String>`	`getInstanceId()`
`String`	`getName()`
`Boolean`	`getOverwrite()`
`String`	`getOwnerAccount()`
`Long`	`getOwnerId()`
`String`	`getRegionId()`
`String`	`getResourceGroupId()`
`String`	`getResourceOwnerAccount()`
`Long`	`getResourceOwnerId()`
`List<SendFileRequest.SendFileRequestTag>`	`getTag()`
`String`	`getTargetDir()`
`Long`	`getTimeout()`
`SendFileRequest`	`setContent(String content)`
`SendFileRequest`	`setContentType(String contentType)`
`SendFileRequest`	`setDescription(String description)`
`SendFileRequest`	`setFileGroup(String fileGroup)`
`SendFileRequest`	`setFileMode(String fileMode)`
`SendFileRequest`	`setFileOwner(String fileOwner)`
`SendFileRequest`	`setInstanceId(List<String> instanceId)`
`SendFileRequest`	`setName(String name)`
`SendFileRequest`	`setOverwrite(Boolean overwrite)`
`SendFileRequest`	`setOwnerAccount(String ownerAccount)`
`SendFileRequest`	`setOwnerId(Long ownerId)`
`SendFileRequest`	`setRegionId(String regionId)`
`SendFileRequest`	`setResourceGroupId(String resourceGroupId)`
`SendFileRequest`	`setResourceOwnerAccount(String resourceOwnerAccount)`
`SendFileRequest`	`setResourceOwnerId(Long resourceOwnerId)`
`SendFileRequest`	`setTag(List<SendFileRequest.SendFileRequestTag> tag)`
`SendFileRequest`	`setTargetDir(String targetDir)`
`SendFileRequest`	`setTimeout(Long timeout)`

从类继承的方法 com.aliyun.tea.TeaModel
build, buildMap, confirmType, confirmType, parseObject, toMap, toMap, toModel, validate, validateParams

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

- 字段详细资料
  - content
```
@NameInMap(value="Content")
public String content
```
    The content of the file. The file must not exceed 32 KB in size after it is encoded in Base64.
    - If ContentType is set to PlainText, the value of Content is in plaintext.
    - If ContentType is set to Base64, the value of Content is Base64-encoded.
    This parameter is required.
    example:
    #!/bin/bash echo "Current User is :" echo $(ps | grep "$$" | awk \"{print $2}\") -------- oss://bucketName/objectName
  - contentType
```
@NameInMap(value="ContentType")
public String contentType
```
    The content type of the file. Valid values:
    - PlainText: The file content is not encoded.
    - Base64: The file content is encoded in Base64.
    Default value: PlainText.
    example:
    PlainText
  - description
```
@NameInMap(value="Description")
public String description
```
    The description of the file. The description can be up to 512 characters in length and can contain any characters.
    example:
    This is a test file.
  - fileGroup
```
@NameInMap(value="FileGroup")
public String fileGroup
```
    The group of the file. This parameter takes effect only on Linux instances. Default value: root. The value can be up to 64 characters in length.
    
    If you want to use a non-root user group, make sure that the user group exists in the instances.
    
    example:
    test
  - fileMode
```
@NameInMap(value="FileMode")
public String fileMode
```
    The permissions on the file. This parameter takes effect only on Linux instances. You can configure this parameter in the same way as you configure the chmod command.
    
    Default value: 0644, which indicates that the owner of the file has the read and write permissions on the file and that the user group of the file and other users have the read-only permissions on the file.
    example:
    0644
  - fileOwner
```
@NameInMap(value="FileOwner")
public String fileOwner
```
    The owner of the file. This parameter takes effect only on Linux instances. Default value: root. The value can be up to 64 characters in length.
    
    If you want to use a non-root user, make sure that the user exists in the instances.
    
    example:
    test
  - instanceId
```
@NameInMap(value="InstanceId")
public List<String> instanceId
```
    The IDs of instances to which to send the file. You can specify up to 50 instance IDs in each request. Valid values of N: 1 to 50.
    
    This parameter is required.
    example:
    i-bp185dy2o3o6n****
  - name
```
@NameInMap(value="Name")
public String name
```
    The name of the file. The name can be up to 255 characters in length and can contain any characters.
    
    This parameter is required.
    example:
    file.txt
  - overwrite
```
@NameInMap(value="Overwrite")
public Boolean overwrite
```
    Specifies whether to overwrite a file in the destination directory if the file has the same name as the sent file.
    - true
    - false
    Default value: false.
    example:
    true
  - ownerAccount
```
@NameInMap(value="OwnerAccount")
public String ownerAccount
```
  - ownerId
```
@NameInMap(value="OwnerId")
public Long ownerId
```
  - regionId
```
@NameInMap(value="RegionId")
public String regionId
```
    The region ID of the instance to which to send the file. You can call the DescribeRegions operation to query the most recent region list.
    
    This parameter is required.
    example:
    cn-hangzhou
  - resourceGroupId
```
@NameInMap(value="ResourceGroupId")
public String resourceGroupId
```
    The ID of the resource group. When you specify this parameter, take note of the following items:
    - The instance specified by the InstanceId parameter must belong to the specified resource group.
    - If you specify this parameter, you can call the DescribeSendFileResults operation to query file sending results in the specified resource group.
    example:
    rg-bp67acfmxazb4p****
  - resourceOwnerAccount
```
@NameInMap(value="ResourceOwnerAccount")
public String resourceOwnerAccount
```
  - resourceOwnerId
```
@NameInMap(value="ResourceOwnerId")
public Long resourceOwnerId
```
  - tag
```
@NameInMap(value="Tag")
public List<SendFileRequest.SendFileRequestTag> tag
```
    The tags to add to the file sending task.
  - targetDir
```
@NameInMap(value="TargetDir")
public String targetDir
```
    The destination directory on the instance to which to send the file. If the specified directory does not exist, the system creates the directory on the instance. The value cannot exceed 255 characters in length.
    
    This parameter is required.
    example:
    /home
  - timeout
```
@NameInMap(value="Timeout")
public Long timeout
```
    The timeout period for the file sending task. Unit: seconds.
    - A timeout error occurs when a file cannot be sent because the process slows down or because a specific module or Cloud Assistant Agent does not exist.
    - If the specified timeout period is less than 10 seconds, the system sets the timeout period to 10 seconds to ensure that the file can be sent to the instances.
    Default value: 60.
    example:
    60
- 构造器详细资料
  - SendFileRequest
```
public SendFileRequest()
```
- 方法详细资料
  - build
```
public static SendFileRequest build(Map<String,?> map)
                             throws Exception
```
    抛出:
    
    Exception
  - setContent
```
public SendFileRequest setContent(String content)
```
  - getContent
```
public String getContent()
```
  - setContentType
```
public SendFileRequest setContentType(String contentType)
```
  - getContentType
```
public String getContentType()
```
  - setDescription
```
public SendFileRequest setDescription(String description)
```
  - getDescription
```
public String getDescription()
```
  - setFileGroup
```
public SendFileRequest setFileGroup(String fileGroup)
```
  - getFileGroup
```
public String getFileGroup()
```
  - setFileMode
```
public SendFileRequest setFileMode(String fileMode)
```
  - getFileMode
```
public String getFileMode()
```
  - setFileOwner
```
public SendFileRequest setFileOwner(String fileOwner)
```
  - getFileOwner
```
public String getFileOwner()
```
  - setInstanceId
```
public SendFileRequest setInstanceId(List<String> instanceId)
```
  - getInstanceId
```
public List<String> getInstanceId()
```
  - setName
```
public SendFileRequest setName(String name)
```
  - getName
```
public String getName()
```
  - setOverwrite
```
public SendFileRequest setOverwrite(Boolean overwrite)
```
  - getOverwrite
```
public Boolean getOverwrite()
```
  - setOwnerAccount
```
public SendFileRequest setOwnerAccount(String ownerAccount)
```
  - getOwnerAccount
```
public String getOwnerAccount()
```
  - setOwnerId
```
public SendFileRequest setOwnerId(Long ownerId)
```
  - getOwnerId
```
public Long getOwnerId()
```
  - setRegionId
```
public SendFileRequest setRegionId(String regionId)
```
  - getRegionId
```
public String getRegionId()
```
  - setResourceGroupId
```
public SendFileRequest setResourceGroupId(String resourceGroupId)
```
  - getResourceGroupId
```
public String getResourceGroupId()
```
  - setResourceOwnerAccount
```
public SendFileRequest setResourceOwnerAccount(String resourceOwnerAccount)
```
  - getResourceOwnerAccount
```
public String getResourceOwnerAccount()
```
  - setResourceOwnerId
```
public SendFileRequest setResourceOwnerId(Long resourceOwnerId)
```
  - getResourceOwnerId
```
public Long getResourceOwnerId()
```
  - setTag
```
public SendFileRequest setTag(List<SendFileRequest.SendFileRequestTag> tag)
```
  - getTag
```
public List<SendFileRequest.SendFileRequestTag> getTag()
```
  - setTargetDir
```
public SendFileRequest setTargetDir(String targetDir)
```
  - getTargetDir
```
public String getTargetDir()
```
  - setTimeout
```
public SendFileRequest setTimeout(Long timeout)
```
  - getTimeout
```
public Long getTimeout()
```

类 SendFileRequest

嵌套类概要

字段概要

构造器概要

方法概要

从类继承的方法 com.aliyun.tea.TeaModel

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

字段详细资料

content

contentType

description

fileGroup

fileMode

fileOwner

instanceId

name

overwrite

ownerAccount

ownerId

regionId

resourceGroupId

resourceOwnerAccount

resourceOwnerId

tag

targetDir

timeout

构造器详细资料

SendFileRequest

方法详细资料

build

setContent

getContent

setContentType

getContentType

setDescription

getDescription

setFileGroup

getFileGroup

setFileMode

getFileMode

setFileOwner

getFileOwner

setInstanceId

getInstanceId

setName

getName

setOverwrite

getOverwrite

setOwnerAccount

getOwnerAccount

setOwnerId

getOwnerId

setRegionId

getRegionId

setResourceGroupId

getResourceGroupId

setResourceOwnerAccount

getResourceOwnerAccount

setResourceOwnerId

getResourceOwnerId

setTag

getTag

setTargetDir

getTargetDir

setTimeout

getTimeout