ComplianceClient

サブモジュール

• xdk.compliance.client モジュール
  • ComplianceClient
    • ComplianceClient.__init__()
    • ComplianceClient.create_jobs()
    • ComplianceClient.get_jobs()
    • ComplianceClient.get_jobs_by_id()
• xdk.compliance.models モジュール
  • CreateJobsRequest
    • CreateJobsRequest.model_config
  • CreateJobsResponse
    • CreateJobsResponse.model_config
  • GetJobsByIdResponse
    • GetJobsByIdResponse.model_config
  • GetJobsResponse
    • GetJobsResponse.model_config

モジュールの内容

このモジュールは、X API のコンプライアンス用エンドポイントへのアクセスを提供し、 コンプライアンス関連のすべての機能へのメインエントリポイントとして機能します。

class xdk.compliance.ComplianceClient

コンプライアンス関連の操作を行う Client

パラメータ

path.client · Client

__init__

パラメーター

path.client · Client

create_jobs

コンプライアンスジョブの作成 指定されたジョブ type の新しいコンプライアンスジョブを作成します。 body: リクエストボディ :returns: レスポンスデータ :rtype: CreateJobsResponse

パラメータ

body.body · CreateJobsRequest

get_jobs

コンプライアンスジョブを取得します ジョブ種別および任意のステータスでフィルタリングされたコンプライアンスジョブの一覧を取得します。

パラメーター

path.type · str

一覧表示する Compliance Job の種類。

path.status · str or None · デフォルト: "None"

一覧表示する Compliance Job のステータス。

path.compliance_job_fields · List or None · デフォルト: "None"

表示する ComplianceJob のフィールドをカンマ区切りで指定するリスト。

戻り値

GetJobsResponse - レスポンスデータ

get_jobs_by_id

ID で Compliance Job を取得する 特定の ID の Compliance Job の詳細を取得します。

パラメーター

path.id · Any

取得する Compliance Job の id。

path.compliance_job_fields · List or None · デフォルト: "None"

表示する ComplianceJob のフィールドをカンマ区切りのリストで指定します。

戻り値

GetJobsByIdResponse - レスポンスデータ