Class: TencentCloud::Apigateway::V20180808::APIDocInfo

Inherits:
Common::AbstractModel
  • Object
show all
Defined in:
lib/v20180808/models.rb

Overview

API文档详细信息

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(apidocid = nil, apidocname = nil, apidocstatus = nil, apicount = nil, viewcount = nil, releasecount = nil, apidocuri = nil, sharepassword = nil, updatedtime = nil, serviceid = nil, environment = nil, apiids = nil, servicename = nil, apinames = nil, tags = nil) ⇒ APIDocInfo

Returns a new instance of APIDocInfo.



92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
 
# File 'lib/v20180808/models.rb', line 92

def initialize(apidocid=nil, apidocname=nil, apidocstatus=nil, apicount=nil, viewcount=nil, releasecount=nil, apidocuri=nil, sharepassword=nil, updatedtime=nil, serviceid=nil, environment=nil, apiids=nil, servicename=nil, apinames=nil, tags=nil)
  @ApiDocId = apidocid
  @ApiDocName = apidocname
  @ApiDocStatus = apidocstatus
  @ApiCount = apicount
  @ViewCount = viewcount
  @ReleaseCount = releasecount
  @ApiDocUri = apidocuri
  @SharePassword = sharepassword
  @UpdatedTime = updatedtime
  @ServiceId = serviceid
  @Environment = environment
  @ApiIds = apiids
  @ServiceName = servicename
  @ApiNames = apinames
  @Tags = tags
end

Instance Attribute Details

#ApiCount ⇒ Object

注意：此字段可能返回 null，表示取不到有效值。

Parameters:

  • ApiDocId: —

    API文档ID

  • ApiDocName: —

    API文档名称

  • ApiDocStatus: —

    API文档构建状态

  • ApiCount: —

    API文档API数量

  • ViewCount: —

    API文档查看次数

  • ReleaseCount: —

    API文档发布次数

  • ApiDocUri: —

    API文档访问URI

  • SharePassword: —

    API文档分享密码

  • UpdatedTime: —

    API文档更新时间

  • ServiceId: —

    服务ID

  • Environment: —

    环境信息

  • ApiIds: —

    生成API文档的API ID

  • ServiceName: —

    服务名称

  • ApiNames: —

    生成API文档的API名称

  • Tags: —

    标签



90
91
92
 
# File 'lib/v20180808/models.rb', line 90

def ApiCount
  @ApiCount
end

#ApiDocId ⇒ Object

注意：此字段可能返回 null，表示取不到有效值。

Parameters:

  • ApiDocId: —

    API文档ID

  • ApiDocName: —

    API文档名称

  • ApiDocStatus: —

    API文档构建状态

  • ApiCount: —

    API文档API数量

  • ViewCount: —

    API文档查看次数

  • ReleaseCount: —

    API文档发布次数

  • ApiDocUri: —

    API文档访问URI

  • SharePassword: —

    API文档分享密码

  • UpdatedTime: —

    API文档更新时间

  • ServiceId: —

    服务ID

  • Environment: —

    环境信息

  • ApiIds: —

    生成API文档的API ID

  • ServiceName: —

    服务名称

  • ApiNames: —

    生成API文档的API名称

  • Tags: —

    标签



90
91
92
 
# File 'lib/v20180808/models.rb', line 90

def ApiDocId
  @ApiDocId
end

#ApiDocName ⇒ Object

注意：此字段可能返回 null，表示取不到有效值。

Parameters:

  • ApiDocId: —

    API文档ID

  • ApiDocName: —

    API文档名称

  • ApiDocStatus: —

    API文档构建状态

  • ApiCount: —

    API文档API数量

  • ViewCount: —

    API文档查看次数

  • ReleaseCount: —

    API文档发布次数

  • ApiDocUri: —

    API文档访问URI

  • SharePassword: —

    API文档分享密码

  • UpdatedTime: —

    API文档更新时间

  • ServiceId: —

    服务ID

  • Environment: —

    环境信息

  • ApiIds: —

    生成API文档的API ID

  • ServiceName: —

    服务名称

  • ApiNames: —

    生成API文档的API名称

  • Tags: —

    标签



90
91
92
 
# File 'lib/v20180808/models.rb', line 90

def ApiDocName
  @ApiDocName
end

#ApiDocStatus ⇒ Object

注意：此字段可能返回 null，表示取不到有效值。

Parameters:

  • ApiDocId: —

    API文档ID

  • ApiDocName: —

    API文档名称

  • ApiDocStatus: —

    API文档构建状态

  • ApiCount: —

    API文档API数量

  • ViewCount: —

    API文档查看次数

  • ReleaseCount: —

    API文档发布次数

  • ApiDocUri: —

    API文档访问URI

  • SharePassword: —

    API文档分享密码

  • UpdatedTime: —

    API文档更新时间

  • ServiceId: —

    服务ID

  • Environment: —

    环境信息

  • ApiIds: —

    生成API文档的API ID

  • ServiceName: —

    服务名称

  • ApiNames: —

    生成API文档的API名称

  • Tags: —

    标签



90
91
92
 
# File 'lib/v20180808/models.rb', line 90

def ApiDocStatus
  @ApiDocStatus
end

#ApiDocUri ⇒ Object

注意：此字段可能返回 null，表示取不到有效值。

Parameters:

  • ApiDocId: —

    API文档ID

  • ApiDocName: —

    API文档名称

  • ApiDocStatus: —

    API文档构建状态

  • ApiCount: —

    API文档API数量

  • ViewCount: —

    API文档查看次数

  • ReleaseCount: —

    API文档发布次数

  • ApiDocUri: —

    API文档访问URI

  • SharePassword: —

    API文档分享密码

  • UpdatedTime: —

    API文档更新时间

  • ServiceId: —

    服务ID

  • Environment: —

    环境信息

  • ApiIds: —

    生成API文档的API ID

  • ServiceName: —

    服务名称

  • ApiNames: —

    生成API文档的API名称

  • Tags: —

    标签



90
91
92
 
# File 'lib/v20180808/models.rb', line 90

def ApiDocUri
  @ApiDocUri
end

#ApiIds ⇒ Object

注意：此字段可能返回 null，表示取不到有效值。

Parameters:

  • ApiDocId: —

    API文档ID

  • ApiDocName: —

    API文档名称

  • ApiDocStatus: —

    API文档构建状态

  • ApiCount: —

    API文档API数量

  • ViewCount: —

    API文档查看次数

  • ReleaseCount: —

    API文档发布次数

  • ApiDocUri: —

    API文档访问URI

  • SharePassword: —

    API文档分享密码

  • UpdatedTime: —

    API文档更新时间

  • ServiceId: —

    服务ID

  • Environment: —

    环境信息

  • ApiIds: —

    生成API文档的API ID

  • ServiceName: —

    服务名称

  • ApiNames: —

    生成API文档的API名称

  • Tags: —

    标签



90
91
92
 
# File 'lib/v20180808/models.rb', line 90

def ApiIds
  @ApiIds
end

#ApiNames ⇒ Object

注意：此字段可能返回 null，表示取不到有效值。

Parameters:

  • ApiDocId: —

    API文档ID

  • ApiDocName: —

    API文档名称

  • ApiDocStatus: —

    API文档构建状态

  • ApiCount: —

    API文档API数量

  • ViewCount: —

    API文档查看次数

  • ReleaseCount: —

    API文档发布次数

  • ApiDocUri: —

    API文档访问URI

  • SharePassword: —

    API文档分享密码

  • UpdatedTime: —

    API文档更新时间

  • ServiceId: —

    服务ID

  • Environment: —

    环境信息

  • ApiIds: —

    生成API文档的API ID

  • ServiceName: —

    服务名称

  • ApiNames: —

    生成API文档的API名称

  • Tags: —

    标签



90
91
92
 
# File 'lib/v20180808/models.rb', line 90

def ApiNames
  @ApiNames
end

#Environment ⇒ Object

注意：此字段可能返回 null，表示取不到有效值。

Parameters:

  • ApiDocId: —

    API文档ID

  • ApiDocName: —

    API文档名称

  • ApiDocStatus: —

    API文档构建状态

  • ApiCount: —

    API文档API数量

  • ViewCount: —

    API文档查看次数

  • ReleaseCount: —

    API文档发布次数

  • ApiDocUri: —

    API文档访问URI

  • SharePassword: —

    API文档分享密码

  • UpdatedTime: —

    API文档更新时间

  • ServiceId: —

    服务ID

  • Environment: —

    环境信息

  • ApiIds: —

    生成API文档的API ID

  • ServiceName: —

    服务名称

  • ApiNames: —

    生成API文档的API名称

  • Tags: —

    标签



90
91
92
 
# File 'lib/v20180808/models.rb', line 90

def Environment
  @Environment
end

#ReleaseCount ⇒ Object

注意：此字段可能返回 null，表示取不到有效值。

Parameters:

  • ApiDocId: —

    API文档ID

  • ApiDocName: —

    API文档名称

  • ApiDocStatus: —

    API文档构建状态

  • ApiCount: —

    API文档API数量

  • ViewCount: —

    API文档查看次数

  • ReleaseCount: —

    API文档发布次数

  • ApiDocUri: —

    API文档访问URI

  • SharePassword: —

    API文档分享密码

  • UpdatedTime: —

    API文档更新时间

  • ServiceId: —

    服务ID

  • Environment: —

    环境信息

  • ApiIds: —

    生成API文档的API ID

  • ServiceName: —

    服务名称

  • ApiNames: —

    生成API文档的API名称

  • Tags: —

    标签



90
91
92
 
# File 'lib/v20180808/models.rb', line 90

def ReleaseCount
  @ReleaseCount
end

#ServiceId ⇒ Object

注意：此字段可能返回 null，表示取不到有效值。

Parameters:

  • ApiDocId: —

    API文档ID

  • ApiDocName: —

    API文档名称

  • ApiDocStatus: —

    API文档构建状态

  • ApiCount: —

    API文档API数量

  • ViewCount: —

    API文档查看次数

  • ReleaseCount: —

    API文档发布次数

  • ApiDocUri: —

    API文档访问URI

  • SharePassword: —

    API文档分享密码

  • UpdatedTime: —

    API文档更新时间

  • ServiceId: —

    服务ID

  • Environment: —

    环境信息

  • ApiIds: —

    生成API文档的API ID

  • ServiceName: —

    服务名称

  • ApiNames: —

    生成API文档的API名称

  • Tags: —

    标签



90
91
92
 
# File 'lib/v20180808/models.rb', line 90

def ServiceId
  @ServiceId
end

#ServiceName ⇒ Object

注意：此字段可能返回 null，表示取不到有效值。

Parameters:

  • ApiDocId: —

    API文档ID

  • ApiDocName: —

    API文档名称

  • ApiDocStatus: —

    API文档构建状态

  • ApiCount: —

    API文档API数量

  • ViewCount: —

    API文档查看次数

  • ReleaseCount: —

    API文档发布次数

  • ApiDocUri: —

    API文档访问URI

  • SharePassword: —

    API文档分享密码

  • UpdatedTime: —

    API文档更新时间

  • ServiceId: —

    服务ID

  • Environment: —

    环境信息

  • ApiIds: —

    生成API文档的API ID

  • ServiceName: —

    服务名称

  • ApiNames: —

    生成API文档的API名称

  • Tags: —

    标签



90
91
92
 
# File 'lib/v20180808/models.rb', line 90

def ServiceName
  @ServiceName
end

#SharePassword ⇒ Object

注意：此字段可能返回 null，表示取不到有效值。

Parameters:

  • ApiDocId: —

    API文档ID

  • ApiDocName: —

    API文档名称

  • ApiDocStatus: —

    API文档构建状态

  • ApiCount: —

    API文档API数量

  • ViewCount: —

    API文档查看次数

  • ReleaseCount: —

    API文档发布次数

  • ApiDocUri: —

    API文档访问URI

  • SharePassword: —

    API文档分享密码

  • UpdatedTime: —

    API文档更新时间

  • ServiceId: —

    服务ID

  • Environment: —

    环境信息

  • ApiIds: —

    生成API文档的API ID

  • ServiceName: —

    服务名称

  • ApiNames: —

    生成API文档的API名称

  • Tags: —

    标签



90
91
92
 
# File 'lib/v20180808/models.rb', line 90

def SharePassword
  @SharePassword
end

#Tags ⇒ Object

注意：此字段可能返回 null，表示取不到有效值。

Parameters:

  • ApiDocId: —

    API文档ID

  • ApiDocName: —

    API文档名称

  • ApiDocStatus: —

    API文档构建状态

  • ApiCount: —

    API文档API数量

  • ViewCount: —

    API文档查看次数

  • ReleaseCount: —

    API文档发布次数

  • ApiDocUri: —

    API文档访问URI

  • SharePassword: —

    API文档分享密码

  • UpdatedTime: —

    API文档更新时间

  • ServiceId: —

    服务ID

  • Environment: —

    环境信息

  • ApiIds: —

    生成API文档的API ID

  • ServiceName: —

    服务名称

  • ApiNames: —

    生成API文档的API名称

  • Tags: —

    标签



90
91
92
 
# File 'lib/v20180808/models.rb', line 90

def Tags
  @Tags
end

#UpdatedTime ⇒ Object

注意：此字段可能返回 null，表示取不到有效值。

Parameters:

  • ApiDocId: —

    API文档ID

  • ApiDocName: —

    API文档名称

  • ApiDocStatus: —

    API文档构建状态

  • ApiCount: —

    API文档API数量

  • ViewCount: —

    API文档查看次数

  • ReleaseCount: —

    API文档发布次数

  • ApiDocUri: —

    API文档访问URI

  • SharePassword: —

    API文档分享密码

  • UpdatedTime: —

    API文档更新时间

  • ServiceId: —

    服务ID

  • Environment: —

    环境信息

  • ApiIds: —

    生成API文档的API ID

  • ServiceName: —

    服务名称

  • ApiNames: —

    生成API文档的API名称

  • Tags: —

    标签



90
91
92
 
# File 'lib/v20180808/models.rb', line 90

def UpdatedTime
  @UpdatedTime
end

#ViewCount ⇒ Object

注意：此字段可能返回 null，表示取不到有效值。

Parameters:

  • ApiDocId: —

    API文档ID

  • ApiDocName: —

    API文档名称

  • ApiDocStatus: —

    API文档构建状态

  • ApiCount: —

    API文档API数量

  • ViewCount: —

    API文档查看次数

  • ReleaseCount: —

    API文档发布次数

  • ApiDocUri: —

    API文档访问URI

  • SharePassword: —

    API文档分享密码

  • UpdatedTime: —

    API文档更新时间

  • ServiceId: —

    服务ID

  • Environment: —

    环境信息

  • ApiIds: —

    生成API文档的API ID

  • ServiceName: —

    服务名称

  • ApiNames: —

    生成API文档的API名称

  • Tags: —

    标签



90
91
92
 
# File 'lib/v20180808/models.rb', line 90

def ViewCount
  @ViewCount
end

Instance Method Details

#deserialize(params) ⇒ Object 



110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
 
# File 'lib/v20180808/models.rb', line 110

def deserialize(params)
  @ApiDocId = params['ApiDocId']
  @ApiDocName = params['ApiDocName']
  @ApiDocStatus = params['ApiDocStatus']
  @ApiCount = params['ApiCount']
  @ViewCount = params['ViewCount']
  @ReleaseCount = params['ReleaseCount']
  @ApiDocUri = params['ApiDocUri']
  @SharePassword = params['SharePassword']
  @UpdatedTime = params['UpdatedTime']
  @ServiceId = params['ServiceId']
  @Environment = params['Environment']
  @ApiIds = params['ApiIds']
  @ServiceName = params['ServiceName']
  @ApiNames = params['ApiNames']
  unless params['Tags'].nil?
    @Tags = []
    params['Tags'].each do |i|
      tag_tmp = Tag.new
      tag_tmp.deserialize(i)
      @Tags << tag_tmp
    end
  end
end