TicClient (tencentcloud-sdk-java 3.1.784 API)

java.lang.Object
- com.tencentcloudapi.common.AbstractClient
- - com.tencentcloudapi.tic.v20201117.TicClient

public class TicClient
extends AbstractClient

Field Summary
- Fields inherited from class com.tencentcloudapi.common.AbstractClient
  gson, HTTP_RSP_OK, SDK_VERSION

Constructor Summary

Constructors
Constructor and Description
`TicClient(Credential credential, String region)`
`TicClient(Credential credential, String region, ClientProfile profile)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`ApplyStackResponse`	`ApplyStack(ApplyStackRequest req)` 本接口（ApplyStack）用于触发资源栈下某个版本的Apply事件。 - 当版本处于PLAN_IN_PROGRESS或APPLY_IN_PROGRESS状态时，将无法再执行本操作 - 当版本处于APPLY_COMPLETED状态时，本操作无法执行
`CreateStackResponse`	`CreateStack(CreateStackRequest req)` 本接口（CreateStack）用于通过传递一个COS的terraform zip模版URL来创建一个资源栈。创建资源栈后仍需要用户调用对应的plan, apply, destory执行对应的事件。
`CreateStackVersionResponse`	`CreateStackVersion(CreateStackVersionRequest req)` 本接口（CreateStackVersion）用于给资源栈新增一个HCL模版版本，仅限COS链接，且为zip格式。
`DeleteStackResponse`	`DeleteStack(DeleteStackRequest req)` 本接口（DeleteStack）用于删除一个资源栈（配置、版本、事件信息）。但不会销毁资源管理的云资源。如果需要销毁资源栈管理的云资源，请调用 DestoryStack 接口销毁云资源。
`DeleteStackVersionResponse`	`DeleteStackVersion(DeleteStackVersionRequest req)` 本接口（DeleteStackVersion）用于删除一个版本，处于PLAN_IN_PROGRESS和APPLY_IN_PROGRESS状态中的版本无法删除。
`DescribeStackEventResponse`	`DescribeStackEvent(DescribeStackEventRequest req)` 本接口（DescribeStackEvent）用于获取单个事件详情，尤其是可以得到事件的详细控制台输出文本。
`DescribeStackEventsResponse`	`DescribeStackEvents(DescribeStackEventsRequest req)` 本接口（DescribeStackEvents）用于查看一个或多个事件详细信息。 - 可以根据事件ID过滤感兴趣的事件 - 也可以根据版本ID，资源栈ID，事件类型，事件状态过滤事件，过滤信息详细请见过滤器Filter - 如果参数为空，返回当前用户一定数量（Limit所指定的数量，默认为20）的事件
`DescribeStacksResponse`	`DescribeStacks(DescribeStacksRequest req)` 本接口（DescribeStacks）用于查询一个或多个资源栈的详细信息。 - 可以根据资源栈ID来查询感兴趣的资源栈信息 - 若参数为空，返回当前用户一定数量（Limit所指定的数量，默认为20）的资源栈
`DescribeStackVersionsResponse`	`DescribeStackVersions(DescribeStackVersionsRequest req)` 本接口（DescribeStackVersions）用于查询一个或多个版本的详细信息。 - 可以根据版本ID查询感兴趣的版本 - 可以根据版本名字和状态来过滤版本，详见过滤器Filter - 如果参数为空，返回当前用户一定数量（Limit所指定的数量，默认为20）的版本
`DestroyStackResponse`	`DestroyStack(DestroyStackRequest req)` 本接口（DestroyStack）用于删除资源栈下的某个版本所创建的资源。
`PlanStackResponse`	`PlanStack(PlanStackRequest req)` 本接口（PlanStack）用于触发资源栈下某个版本的PLAN事件。 - 当版本处于PLAN_IN_PROGRESS或APPLY_IN_PROGRESS状态时，将无法再执行本操作 - 当版本处于APPLY_COMPLETED状态时，本操作无法执行
`UpdateStackResponse`	`UpdateStack(UpdateStackRequest req)` 本接口（UpdateStack）用于更新资源栈的名称和描述。
`UpdateStackVersionResponse`	`UpdateStackVersion(UpdateStackVersionRequest req)` 本接口（UpdateStackVersion）用于更新一个版本的模版内容，名称或描述，模版仅限COS URL，且为zip格式。

Methods inherited from class com.tencentcloudapi.common.AbstractClient
call, callOctetStream, getClientProfile, getCredential, getRegion, getRegionBreaker, internalRequest, retry, setClientProfile, setCredential, setRegion, setRegionBreaker

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - TicClient
```
public TicClient(Credential credential,
                 String region)
```
  - TicClient
```
public TicClient(Credential credential,
                 String region,
                 ClientProfile profile)
```
- Method Detail
  - ApplyStack
```
public ApplyStackResponse ApplyStack(ApplyStackRequest req)
                              throws TencentCloudSDKException
```
    本接口（ApplyStack）用于触发资源栈下某个版本的Apply事件。 - 当版本处于PLAN_IN_PROGRESS或APPLY_IN_PROGRESS状态时，将无法再执行本操作 - 当版本处于APPLY_COMPLETED状态时，本操作无法执行
    
    Parameters:
    
    req - ApplyStackRequest
    
    Returns:
    
    ApplyStackResponse
    
    Throws:
    
    TencentCloudSDKException
  - CreateStack
```
public CreateStackResponse CreateStack(CreateStackRequest req)
                                throws TencentCloudSDKException
```
    本接口（CreateStack）用于通过传递一个COS的terraform zip模版URL来创建一个资源栈。创建资源栈后仍需要用户调用对应的plan, apply, destory执行对应的事件。
    
    Parameters:
    
    req - CreateStackRequest
    
    Returns:
    
    CreateStackResponse
    
    Throws:
    
    TencentCloudSDKException
  - CreateStackVersion
```
public CreateStackVersionResponse CreateStackVersion(CreateStackVersionRequest req)
                                              throws TencentCloudSDKException
```
    本接口（CreateStackVersion）用于给资源栈新增一个HCL模版版本，仅限COS链接，且为zip格式。
    
    Parameters:
    
    req - CreateStackVersionRequest
    
    Returns:
    
    CreateStackVersionResponse
    
    Throws:
    
    TencentCloudSDKException
  - DeleteStack
```
public DeleteStackResponse DeleteStack(DeleteStackRequest req)
                                throws TencentCloudSDKException
```
    本接口（DeleteStack）用于删除一个资源栈（配置、版本、事件信息）。但不会销毁资源管理的云资源。如果需要销毁资源栈管理的云资源，请调用 DestoryStack 接口销毁云资源。
    
    Parameters:
    
    req - DeleteStackRequest
    
    Returns:
    
    DeleteStackResponse
    
    Throws:
    
    TencentCloudSDKException
  - DeleteStackVersion
```
public DeleteStackVersionResponse DeleteStackVersion(DeleteStackVersionRequest req)
                                              throws TencentCloudSDKException
```
    本接口（DeleteStackVersion）用于删除一个版本，处于PLAN_IN_PROGRESS和APPLY_IN_PROGRESS状态中的版本无法删除。
    
    Parameters:
    
    req - DeleteStackVersionRequest
    
    Returns:
    
    DeleteStackVersionResponse
    
    Throws:
    
    TencentCloudSDKException
  - DescribeStackEvent
```
public DescribeStackEventResponse DescribeStackEvent(DescribeStackEventRequest req)
                                              throws TencentCloudSDKException
```
    本接口（DescribeStackEvent）用于获取单个事件详情，尤其是可以得到事件的详细控制台输出文本。
    
    Parameters:
    
    req - DescribeStackEventRequest
    
    Returns:
    
    DescribeStackEventResponse
    
    Throws:
    
    TencentCloudSDKException
  - DescribeStackEvents
```
public DescribeStackEventsResponse DescribeStackEvents(DescribeStackEventsRequest req)
                                                throws TencentCloudSDKException
```
    本接口（DescribeStackEvents）用于查看一个或多个事件详细信息。 - 可以根据事件ID过滤感兴趣的事件 - 也可以根据版本ID，资源栈ID，事件类型，事件状态过滤事件，过滤信息详细请见过滤器Filter - 如果参数为空，返回当前用户一定数量（Limit所指定的数量，默认为20）的事件
    
    Parameters:
    
    req - DescribeStackEventsRequest
    
    Returns:
    
    DescribeStackEventsResponse
    
    Throws:
    
    TencentCloudSDKException
  - DescribeStackVersions
```
public DescribeStackVersionsResponse DescribeStackVersions(DescribeStackVersionsRequest req)
                                                    throws TencentCloudSDKException
```
    本接口（DescribeStackVersions）用于查询一个或多个版本的详细信息。 - 可以根据版本ID查询感兴趣的版本 - 可以根据版本名字和状态来过滤版本，详见过滤器Filter - 如果参数为空，返回当前用户一定数量（Limit所指定的数量，默认为20）的版本
    
    Parameters:
    
    req - DescribeStackVersionsRequest
    
    Returns:
    
    DescribeStackVersionsResponse
    
    Throws:
    
    TencentCloudSDKException
  - DescribeStacks
```
public DescribeStacksResponse DescribeStacks(DescribeStacksRequest req)
                                      throws TencentCloudSDKException
```
    本接口（DescribeStacks）用于查询一个或多个资源栈的详细信息。 - 可以根据资源栈ID来查询感兴趣的资源栈信息 - 若参数为空，返回当前用户一定数量（Limit所指定的数量，默认为20）的资源栈
    
    Parameters:
    
    req - DescribeStacksRequest
    
    Returns:
    
    DescribeStacksResponse
    
    Throws:
    
    TencentCloudSDKException
  - DestroyStack
```
public DestroyStackResponse DestroyStack(DestroyStackRequest req)
                                  throws TencentCloudSDKException
```
    本接口（DestroyStack）用于删除资源栈下的某个版本所创建的资源。
    
    Parameters:
    
    req - DestroyStackRequest
    
    Returns:
    
    DestroyStackResponse
    
    Throws:
    
    TencentCloudSDKException
  - PlanStack
```
public PlanStackResponse PlanStack(PlanStackRequest req)
                            throws TencentCloudSDKException
```
    本接口（PlanStack）用于触发资源栈下某个版本的PLAN事件。 - 当版本处于PLAN_IN_PROGRESS或APPLY_IN_PROGRESS状态时，将无法再执行本操作 - 当版本处于APPLY_COMPLETED状态时，本操作无法执行
    
    Parameters:
    
    req - PlanStackRequest
    
    Returns:
    
    PlanStackResponse
    
    Throws:
    
    TencentCloudSDKException
  - UpdateStack
```
public UpdateStackResponse UpdateStack(UpdateStackRequest req)
                                throws TencentCloudSDKException
```
    本接口（UpdateStack）用于更新资源栈的名称和描述。
    
    Parameters:
    
    req - UpdateStackRequest
    
    Returns:
    
    UpdateStackResponse
    
    Throws:
    
    TencentCloudSDKException
  - UpdateStackVersion
```
public UpdateStackVersionResponse UpdateStackVersion(UpdateStackVersionRequest req)
                                              throws TencentCloudSDKException
```
    本接口（UpdateStackVersion）用于更新一个版本的模版内容，名称或描述，模版仅限COS URL，且为zip格式。
    
    Parameters:
    
    req - UpdateStackVersionRequest
    
    Returns:
    
    UpdateStackVersionResponse
    
    Throws:
    
    TencentCloudSDKException

Class TicClient

Field Summary

Fields inherited from class com.tencentcloudapi.common.AbstractClient

Constructor Summary

Method Summary

Methods inherited from class com.tencentcloudapi.common.AbstractClient

Methods inherited from class java.lang.Object

Constructor Detail

TicClient

TicClient

Method Detail

ApplyStack

CreateStack

CreateStackVersion

DeleteStack

DeleteStackVersion

DescribeStackEvent

DescribeStackEvents

DescribeStackVersions

DescribeStacks

DestroyStack

PlanStack

UpdateStack

UpdateStackVersion