Share via

JobClient class

  • Referensi
Paket:
azure-iothub

Menyediakan metode untuk membuat, memperbarui, memantau, dan membatalkan pekerjaan yang berjalan lama pada instans IoT Hub, serta mengkueri pekerjaan yang ada. API Pekerjaan di Azure IoT Hub memungkinkan untuk menjadwalkan panggilan metode langsung dan pembaruan kembar di beberapa perangkat.

Pengguna SDK diharapkan membuat JobClient instans menggunakan metode fromConnectionString(string) pabrik dan fromSharedAccessSignature(string).

Metode

cancelJob(string | number)
cancelJob(string | number, TripleValueCallback<any, any>)

Membatalkan pekerjaan yang ada.
createQuery(JobType, JobStatus, number)

Membuat kueri yang dapat digunakan untuk mengembalikan halaman pekerjaan yang sudah ada berdasarkan jenis dan status.
fromConnectionString(string)

Membuat objek JobClient dari string koneksi yang diberikan.
fromSharedAccessSignature(string)

Membuat objek JobClient dari tanda tangan akses bersama yang diberikan.
fromTokenCredential(string, TokenCredential)

Membuat objek JobClient dari Azure TokenCredential bersama yang diberikan.
getJob(string | number)
getJob(string | number, TripleValueCallback<any, any>)

Meminta informasi tentang pekerjaan yang ada.
scheduleDeviceMethod(string | number, string, DeviceMethodParams)
scheduleDeviceMethod(string | number, string, DeviceMethodParams, Date)
scheduleDeviceMethod(string | number, string, DeviceMethodParams, Date, number)
scheduleDeviceMethod(string | number, string, DeviceMethodParams, Date, number, TripleValueCallback<any, any>)

Menjadwalkan pekerjaan yang akan menjalankan metode perangkat pada sekumpulan perangkat.
scheduleDeviceMethod(string | number, string, DeviceMethodParams, Date, TripleValueCallback<any, any>)
scheduleDeviceMethod(string | number, string, DeviceMethodParams, TripleValueCallback<any, any>)
scheduleTwinUpdate(string | number, string, any)
scheduleTwinUpdate(string | number, string, any, Date)
scheduleTwinUpdate(string | number, string, any, Date, number)
scheduleTwinUpdate(string | number, string, any, Date, number, TripleValueCallback<any, any>)

Jadwalkan pekerjaan yang akan memperbarui sekumpulan kembar dengan patch yang disediakan sebagai parameter.
scheduleTwinUpdate(string | number, string, any, Date, TripleValueCallback<any, any>)
scheduleTwinUpdate(string | number, string, any, TripleValueCallback<any, any>)

Detail Metode

cancelJob(string | number) 

function cancelJob(jobId: string | number): Promise<JobStatusResponse>

Parameter

jobId

string | number

Mengembalikan

Promise<JobStatusResponse>

cancelJob(string | number, TripleValueCallback<any, any>)

Membatalkan pekerjaan yang ada.

function cancelJob(jobId: string | number, done?: TripleValueCallback<any, any>)

Parameter

jobId

string | number

Pengidentifikasi pekerjaan yang ada.

done

TripleValueCallback<any, any>

Fungsi opsional untuk dipanggil saat operasi selesai. done akan dipanggil dengan tiga argumen: objek Kesalahan (bisa null), objek pekerjaan, dan objek respons khusus transportasi yang berguna untuk pengelogan atau penelusuran kesalahan.

createQuery(JobType, JobStatus, number)

Membuat kueri yang dapat digunakan untuk mengembalikan halaman pekerjaan yang sudah ada berdasarkan jenis dan status.

function createQuery(jobType?: JobType, jobStatus?: JobStatus, pageSize?: number): Query

Parameter

jobType

JobType

Jenis yang harus digunakan untuk memfilter hasil.

jobStatus

JobStatus

Status yang harus digunakan untuk memfilter hasil.

pageSize

number

Jumlah elemen yang akan dikembalikan per halaman.

Mengembalikan

Query

fromConnectionString(string)

Membuat objek JobClient dari string koneksi yang diberikan.

static function fromConnectionString(connectionString: string): JobClient

Parameter

connectionString

string

String koneksi yang merangkum izin Registri yang sesuai (baca dan/atau tulis).

Mengembalikan

JobClient

fromSharedAccessSignature(string)

Membuat objek JobClient dari tanda tangan akses bersama yang diberikan.

static function fromSharedAccessSignature(sharedAccessSignature: string): JobClient

Parameter

sharedAccessSignature

string

Tanda tangan akses bersama yang merangkum izin Registri yang sesuai (baca dan/atau tulis).

Mengembalikan

JobClient

fromTokenCredential(string, TokenCredential)

Membuat objek JobClient dari Azure TokenCredential bersama yang diberikan.

static function fromTokenCredential(hostName: string, tokenCredential: TokenCredential): JobClient

Parameter

hostName

string

Nama host layanan Azure.

tokenCredential
TokenCredential

Azure TokenCredential yang digunakan untuk mengautentikasi dengan layanan Azure

Mengembalikan

JobClient

getJob(string | number) 

function getJob(jobId: string | number): Promise<JobStatusResponse>

Parameter

jobId

string | number

Mengembalikan

Promise<JobStatusResponse>

getJob(string | number, TripleValueCallback<any, any>)

Meminta informasi tentang pekerjaan yang ada.

function getJob(jobId: string | number, done?: TripleValueCallback<any, any>)

Parameter

jobId

string | number

Pengidentifikasi pekerjaan yang ada.

done

TripleValueCallback<any, any>

Fungsi opsional untuk dipanggil saat operasi selesai. done akan dipanggil dengan tiga argumen: objek Kesalahan (bisa null), objek pekerjaan, dan objek respons khusus transportasi yang berguna untuk pengelogan atau penelusuran kesalahan.

scheduleDeviceMethod(string | number, string, DeviceMethodParams) 

function scheduleDeviceMethod(jobId: string | number, queryCondition: string, methodParams: DeviceMethodParams): Promise<JobStatusResponse>

Parameter

jobId

string | number

queryCondition

string

methodParams
DeviceMethodParams

Mengembalikan

Promise<JobStatusResponse>

scheduleDeviceMethod(string | number, string, DeviceMethodParams, Date) 

function scheduleDeviceMethod(jobId: string | number, queryCondition: string, methodParams: DeviceMethodParams, jobStartTime: Date): Promise<JobStatusResponse>

Parameter

jobId

string | number

queryCondition

string

methodParams
DeviceMethodParams
jobStartTime

Date

Mengembalikan

Promise<JobStatusResponse>

scheduleDeviceMethod(string | number, string, DeviceMethodParams, Date, number) 

function scheduleDeviceMethod(jobId: string | number, queryCondition: string, methodParams: DeviceMethodParams, jobStartTime: Date, maxExecutionTimeInSeconds: number): Promise<JobStatusResponse>

Parameter

jobId

string | number

queryCondition

string

methodParams
DeviceMethodParams
jobStartTime

Date

maxExecutionTimeInSeconds

number

Mengembalikan

Promise<JobStatusResponse>

scheduleDeviceMethod(string | number, string, DeviceMethodParams, Date, number, TripleValueCallback<any, any>)

Menjadwalkan pekerjaan yang akan menjalankan metode perangkat pada sekumpulan perangkat.

function scheduleDeviceMethod(jobId: string | number, queryCondition: string, methodParams: DeviceMethodParams, jobStartTime?: Date, maxExecutionTimeInSeconds?: number, done?: TripleValueCallback<any, any>)

Parameter

jobId

string | number

Pengidentifikasi unik yang harus digunakan untuk pekerjaan ini.

queryCondition

string

Klausa WHERE kueri SQL yang digunakan untuk menghitung daftar perangkat tempat pekerjaan ini harus dijalankan.

methodParams
DeviceMethodParams

Objek yang menjelaskan metode dan harus memiliki properti berikut: - methodName Nama metode yang akan dipanggil. - payload [opsional] Payload yang digunakan untuk panggilan metode. - responseTimeoutInSeconds [opsional] Jumlah detik IoT Hub harus menunggu perangkat

jobStartTime

Date

Waktu di mana pekerjaan harus dimulai

maxExecutionTimeInSeconds

number

Waktu maksimum yang dialokasikan untuk pekerjaan ini berjalan dalam detik.

done

TripleValueCallback<any, any>

Fungsi opsional untuk dipanggil saat operasi selesai. done akan dipanggil dengan tiga argumen: objek Kesalahan (bisa null), objek pekerjaan, dan objek respons khusus transportasi yang berguna untuk pengelogan atau penelusuran kesalahan.

scheduleDeviceMethod(string | number, string, DeviceMethodParams, Date, TripleValueCallback<any, any>) 

function scheduleDeviceMethod(jobId: string | number, queryCondition: string, methodParams: DeviceMethodParams, jobStartTime: Date, done: TripleValueCallback<any, any>)

Parameter

jobId

string | number

queryCondition

string

methodParams
DeviceMethodParams
jobStartTime

Date

done

TripleValueCallback<any, any>

scheduleDeviceMethod(string | number, string, DeviceMethodParams, TripleValueCallback<any, any>) 

function scheduleDeviceMethod(jobId: string | number, queryCondition: string, methodParams: DeviceMethodParams, done: TripleValueCallback<any, any>)

Parameter

jobId

string | number

queryCondition

string

methodParams
DeviceMethodParams
done

TripleValueCallback<any, any>

scheduleTwinUpdate(string | number, string, any) 

function scheduleTwinUpdate(jobId: string | number, queryCondition: string, patch: any): Promise<JobStatusResponse>

Parameter

jobId

string | number

queryCondition

string

patch

any

Mengembalikan

Promise<JobStatusResponse>

scheduleTwinUpdate(string | number, string, any, Date) 

function scheduleTwinUpdate(jobId: string | number, queryCondition: string, patch: any, jobStartTime: Date): Promise<JobStatusResponse>

Parameter

jobId

string | number

queryCondition

string

patch

any

jobStartTime

Date

Mengembalikan

Promise<JobStatusResponse>

scheduleTwinUpdate(string | number, string, any, Date, number) 

function scheduleTwinUpdate(jobId: string | number, queryCondition: string, patch: any, jobStartTime: Date, maxExecutionTimeInSeconds?: number): Promise<JobStatusResponse>

Parameter

jobId

string | number

queryCondition

string

patch

any

jobStartTime

Date

maxExecutionTimeInSeconds

number

Mengembalikan

Promise<JobStatusResponse>

scheduleTwinUpdate(string | number, string, any, Date, number, TripleValueCallback<any, any>)

Jadwalkan pekerjaan yang akan memperbarui sekumpulan kembar dengan patch yang disediakan sebagai parameter.

function scheduleTwinUpdate(jobId: string | number, queryCondition: string, patch: any, jobStartTime?: Date, maxExecutionTimeInSeconds?: number, done?: TripleValueCallback<any, any>)

Parameter

jobId

string | number

Pengidentifikasi unik yang harus digunakan untuk pekerjaan ini.

queryCondition

string

Klausa WHERE kueri SQL yang digunakan untuk menghitung daftar perangkat tempat pekerjaan ini harus dijalankan.

patch

any

Patch kembar yang harus diterapkan pada kembar.

jobStartTime

Date

Waktu di mana pekerjaan harus dimulai

maxExecutionTimeInSeconds

number

Waktu maksimum yang dialokasikan untuk pekerjaan ini berjalan dalam detik.

done

TripleValueCallback<any, any>

Fungsi opsional untuk dipanggil saat operasi selesai. done akan dipanggil dengan tiga argumen: objek Kesalahan (bisa null), objek pekerjaan, dan objek respons khusus transportasi yang berguna untuk pengelogan atau penelusuran kesalahan.

scheduleTwinUpdate(string | number, string, any, Date, TripleValueCallback<any, any>) 

function scheduleTwinUpdate(jobId: string | number, queryCondition: string, patch: any, jobStartTime: Date, done: TripleValueCallback<any, any>)

Parameter

jobId

string | number

queryCondition

string

patch

any

jobStartTime

Date

done

TripleValueCallback<any, any>

scheduleTwinUpdate(string | number, string, any, TripleValueCallback<any, any>) 

function scheduleTwinUpdate(jobId: string | number, queryCondition: string, patch: any, done: TripleValueCallback<any, any>)

Parameter

jobId

string | number

queryCondition

string

patch

any

done

TripleValueCallback<any, any>