Jenis Koneksi API

• RegisterConnectionType tindakan (Python: register_connection_type)

• DeleteConnectionType tindakan (Python: delete_connection_type)

• DescribeConnectionType tindakan (Python: describe_connection_type)

• ListConnectionTypes tindakan (Python: list_connection_types)

• ConnectionTypeBrief struktur

• ConnectionTypeVariant struktur

Permintaan

• ConnectionType- Diperlukan: UTF-8 string, panjang tidak kurang dari 1 atau lebih dari 255 byte, cocok denganSingle-line string pattern.

  Nama jenis koneksi. Harus antara 1 dan 255 karakter dan harus diawali dengan “REST-” untuk menunjukkan itu adalah a REST-based connector.

• IntegrationType- Diperlukan: UTF-8 string (nilai valid:REST).

  Jenis integrasi untuk koneksi. Saat ini hanya protokol “REST” yang didukung.

• Description— UTF-8 string, tidak lebih dari 1024 byte panjangnya.

  Deskripsi jenis koneksi. Dapat hingga 2048 karakter dan memberikan rincian tentang tujuan dan fungsionalitas jenis koneksi.

• ConnectionProperties — Wajib: Sebuah objek ConnectionPropertiesConfiguration.

  Mendefinisikan URL dasar dan parameter permintaan tambahan yang diperlukan selama pembuatan koneksi untuk jenis koneksi ini.

• ConnectorAuthenticationConfiguration — Wajib: Sebuah objek ConnectorAuthenticationConfiguration.

  Mendefinisikan jenis otentikasi yang didukung dan properti yang diperlukan untuk jenis koneksi ini, termasuk metode otentikasi Dasar, OAuth2, dan Kustom.

• RestConfiguration — Wajib: Sebuah objek RestConfiguration.

  Mendefinisikan konfigurasi permintaan dan respons HTTP, titik akhir validasi, dan konfigurasi entitas untuk interaksi REST API.

• Tags — Sebuah rangkaian peta pasangan nilai kunci, tidak lebih dari 50 pasang.

  Setiap kunci adalah UTF-8 string, tidak kurang dari 1 atau lebih dari 128 byte panjangnya.

  Setiap nilai adalah UTF-8 string, panjangnya tidak lebih dari 256 byte.

  Tag yang Anda tetapkan untuk jenis koneksi.

Respons

Berisi Nama Sumber Daya Amazon (ARN) dari jenis koneksi yang baru terdaftar.

• ConnectionTypeArn— UTF-8 string, panjangnya tidak kurang dari 1 atau lebih dari 10240 byte, cocok dengan. Custom string pattern #47

  Nama Sumber Daya Amazon (ARN) dari jenis koneksi terdaftar. Pengidentifikasi unik ini dapat digunakan untuk mereferensikan jenis koneksi dalam AWS Glue operasi lain.

Kesalahan

• AlreadyExistsException

• InvalidInputException

• OperationTimeoutException

• ResourceNumberLimitExceededException

• InternalServiceException

Permintaan

• ConnectionType- Diperlukan: UTF-8 string, panjang tidak kurang dari 1 atau lebih dari 255 byte, cocok denganSingle-line string pattern.

  Nama jenis koneksi yang akan dihapus. Harus mereferensikan jenis koneksi terdaftar yang ada.

Respons

• Tidak ada parameter Respons.

Kesalahan

• EntityNotFoundException

• InvalidInputException

• OperationTimeoutException

• InternalServiceException

• AccessDeniedException

Permintaan

• ConnectionType- Diperlukan: UTF-8 string, panjang tidak kurang dari 1 atau lebih dari 255 byte, cocok denganSingle-line string pattern.

  Nama jenis koneksi yang akan dijelaskan.

Respons

• ConnectionType— UTF-8 string, panjangnya tidak kurang dari 1 atau lebih dari 255 byte, cocok denganSingle-line string pattern.

  Nama jenis koneksi.

• Description— UTF-8 string, tidak lebih dari 1024 byte panjangnya.

  Deskripsi jenis koneksi.

• Capabilities — Sebuah objek Kemampuan.

  Jenis otentikasi yang didukung, jenis antarmuka data (lingkungan komputasi), dan operasi data dari connector.

• ConnectionProperties – Susunan peta pasangan nilai kunci.

  Setiap kunci adalah UTF-8 string, tidak kurang dari 1 atau lebih dari 128 byte panjangnya.

  Setiap nilai adalah sebuah objek Properti A.

  Properti koneksi yang umum di seluruh lingkungan komputasi.

• ConnectionOptions – Susunan peta pasangan nilai kunci.

  Setiap kunci adalah UTF-8 string, tidak kurang dari 1 atau lebih dari 128 byte panjangnya.

  Setiap nilai adalah sebuah objek Properti A.

  Mengembalikan properti yang dapat diatur saat membuat koneksi diConnectionInput.ConnectionProperties. ConnectionOptionsmendefinisikan parameter yang dapat diatur dalam skrip Spark ETL di peta opsi koneksi yang diteruskan ke kerangka data.

• AuthenticationConfiguration — Sebuah objek AuthConfiguration.

  Jenis otentikasi yang digunakan untuk koneksi.

• ComputeEnvironmentConfigurations – Susunan peta pasangan nilai kunci.

  Setiap kunci adalah UTF-8 string, tidak kurang dari 1 atau lebih dari 128 byte panjangnya.

  Setiap nilai adalah sebuah objek ComputeEnvironmentConfiguration A.

  Lingkungan komputasi yang didukung oleh koneksi.

• PhysicalConnectionRequirements – Susunan peta pasangan nilai kunci.

  Setiap kunci adalah UTF-8 string, tidak kurang dari 1 atau lebih dari 128 byte panjangnya.

  Setiap nilai adalah sebuah objek Properti A.

  Persyaratan fisik untuk koneksi, seperti spesifikasi VPC, Subnet, dan Grup Keamanan.

• AthenaConnectionProperties – Susunan peta pasangan nilai kunci.

  Setiap kunci adalah UTF-8 string, tidak kurang dari 1 atau lebih dari 128 byte panjangnya.

  Setiap nilai adalah sebuah objek Properti A.

  Properti koneksi khusus untuk lingkungan Athena komputasi.

• PythonConnectionProperties – Susunan peta pasangan nilai kunci.

  Setiap kunci adalah UTF-8 string, tidak kurang dari 1 atau lebih dari 128 byte panjangnya.

  Setiap nilai adalah sebuah objek Properti A.

  Properti koneksi khusus untuk lingkungan komputasi Python.

• SparkConnectionProperties – Susunan peta pasangan nilai kunci.

  Setiap kunci adalah UTF-8 string, tidak kurang dari 1 atau lebih dari 128 byte panjangnya.

  Setiap nilai adalah sebuah objek Properti A.

  Properti koneksi khusus untuk lingkungan komputasi Spark.

• RestConfiguration — Sebuah objek RestConfiguration.

  Konfigurasi permintaan dan respons HTTP, titik akhir validasi, dan konfigurasi entitas untuk sumber data berbasis REST.

Kesalahan

• ValidationException

• InvalidInputException

• InternalServiceException

Permintaan

• MaxResults — Nomor (bilangan bulat), tidak kurang dari 1 atau lebih dari 1000.

  Jumlah hasil maksimum yang akan dikembalikan.

• NextToken— UTF-8 string, panjangnya tidak kurang dari 1 atau lebih dari 2048 byte, cocok denganCustom string pattern #11.

  Sebuah token kelanjutan, jika ini adalah panggilan kelanjutan.

Respons

• ConnectionTypes – Susunan objek ConnectionTypeBrief.

  Daftar ConnectionTypeBrief objek yang berisi informasi singkat tentang jenis koneksi yang didukung.

• NextToken— UTF-8 string, panjangnya tidak kurang dari 1 atau lebih dari 2048 byte, cocok denganCustom string pattern #11.

  Token lanjutan, jika segmen daftar saat ini bukan yang terakhir.

Kesalahan

• InternalServiceException

Bidang

• ConnectionType— UTF-8 string (nilai yang valid: JDBC | SFTP | MONGODB | KAFKA | NETWORK | MARKETPLACE | CUSTOM | SALESFORCE | VIEW_VALIDATION_REDSHIFT | | VIEW_VALIDATION_ATHENA | GOOGLEADS | GOOGLESHEETS | GOOGLEANALYTICS4 | SERVICENOW | MARKETO | SAPODATA | ZENDESK | JIRACLOUD | NETSUITEERP | | HUBSPOT | FACEBOOKADS | INSTAGRAMADS | ZOHOCRM | SALESFORCEPARDOT | SALESFORCEMARKETINGCLOUD | ADOBEANALYTICS | SLACK | LINKEDIN | MIXPANEL | | ASANA | STRIPE | SMARTSHEET | DATADOG | WOOCOMMERCE | INTERCOM| | | SNAPCHATADS | | PAYPAL | | QUICKBOOKS | | FACEBOOKPAGEINSIGHTS | | FRESHDESK | | TWILIO | | DOCUSIGNMONITOR | | FRESHSALES | | ZOOM | | GOOGLESEARCHCONSOLE | | SALESFORCECOMMERCECLOUD | | SAPCONCUR | | | DYNATRACE | | MICROSOFTDYNAMIC365FINANCEANDOPS | | MICROSOFTTEAMS | | BLACKBAUDRAISEREDGENXT | | MAILCHIMP | | GITLAB | | PENDO | | PRODUCTBOARD | | CIRCLECI | | PIPEDIVE | | SENDGRID | | AZURECOSMOS | | | AZURESQL | | BIGQUERY | | BLACKBAUD | | CLOUDERAHIVE | | CLOUDERAIMPALA | | CLOUDWATCH | | CLOUDWATCHMETRICS | | CMDB | | DATALAKEGEN2 | | DB2 | | DB2AS400 | | DOCUMENTDB | | DOMO | | DYNAMODB| GOOGLECLOUDSTORAGE | HBASE | KUSTOMER | MICROSOFTDYNAMICS365CRM | MONDAY | MYSQL | OKTA | OPENSEARCH | ORACLE | PIPEDRIVE | POSTGRESQL | SAPHANA | SQLSERVER | SYNAPSE | TERADATA | TERADATANOS | TIMESTREAM | TPCDS |VERTICA).

  Nama jenis koneksi.

• DisplayName— UTF-8 string, tidak kurang dari 1 atau lebih dari 128 byte panjangnya.

  Nama yang dapat dibaca manusia untuk jenis koneksi yang ditampilkan di AWS Glue konsol.

• Vendor— UTF-8 string, tidak kurang dari 1 atau lebih dari 128 byte panjangnya.

  Nama vendor atau penyedia yang membuat atau memelihara jenis koneksi ini.

• Description— UTF-8 string, tidak lebih dari 1024 byte panjangnya.

  Deskripsi jenis koneksi.

• Categories— Sebuah array UTF-8 string.

  Daftar kategori yang dimiliki jenis koneksi ini. Kategori membantu pengguna memfilter dan menemukan jenis koneksi yang sesuai berdasarkan kasus penggunaan mereka.

• Capabilities — Sebuah objek Kemampuan.

  Jenis otentikasi yang didukung, jenis antarmuka data (lingkungan komputasi), dan operasi data dari connector.

• LogoUrl— UTF-8 tali.

  URL logo yang terkait dengan jenis koneksi.

• ConnectionTypeVariants – Susunan objek ConnectionTypeVariant.

  Daftar varian yang tersedia untuk jenis koneksi ini. Varian yang berbeda dapat menyediakan konfigurasi khusus untuk kasus penggunaan tertentu atau implementasi dari jenis koneksi umum yang sama.

Bidang

• ConnectionTypeVariantName— UTF-8 string, tidak kurang dari 1 atau lebih dari 128 byte panjangnya.

  Pengidentifikasi unik untuk varian tipe koneksi. Nama ini digunakan secara internal untuk mengidentifikasi varian spesifik dari jenis koneksi.

• DisplayName— UTF-8 string, tidak kurang dari 1 atau lebih dari 128 byte panjangnya.

  Nama yang dapat dibaca manusia untuk varian jenis koneksi yang ditampilkan di AWS Glue konsol.

• Description— UTF-8 string, tidak lebih dari 1024 byte panjangnya.

  Penjelasan rinci tentang varian jenis koneksi, termasuk tujuannya, kasus penggunaan, dan persyaratan konfigurasi tertentu.

• LogoUrl— UTF-8 tali.

  URL logo yang terkait dengan varian jenis koneksi.

• Struktur validasi

• AuthConfiguration struktur

• Struktur kemampuan

• Struktur properti

• AllowedValue struktur

• ComputeEnvironmentConfiguration struktur

Bidang

• ValidationType— Diperlukan: UTF-8 string (nilai valid: REGEX |RANGE).

  Jenis validasi yang akan dilakukan, sepertiREGEX.

• Patterns— Sebuah array UTF-8 string.

  Daftar pola yang berlaku untuk validasi.

• Description- Diperlukan: UTF-8 string, tidak kurang dari 1 atau lebih dari 1024 byte panjangnya.

  Deskripsi untuk validasi.

• MaxLength — Nomor (bilangan bulat).

  Panjang maksimum untuk properti koneksi string.

• Maximum — Nomor (bilangan bulat).

  Nilai maksimum saat menentukan RANGE jenis validasi.

• Minimum — Nomor (bilangan bulat).

  Nilai minimum saat menentukan RANGE jenis validasi.

Bidang

• AuthenticationType — Wajib: Sebuah objek Properti.

  Jenis otentikasi untuk koneksi.

• SecretArn — Sebuah objek Properti.

  Nama Sumber Daya Amazon (ARN) untuk Manajer Rahasia.

• OAuth2Properties – Susunan peta pasangan nilai kunci.

  Setiap kunci adalah UTF-8 string, tidak kurang dari 1 atau lebih dari 128 byte panjangnya.

  Setiap nilai adalah sebuah objek Properti A.

  Peta pasangan kunci-nilai untuk properti OAuth2. Setiap nilai adalah sebuah Property objek.

• BasicAuthenticationProperties – Susunan peta pasangan nilai kunci.

  Setiap kunci adalah UTF-8 string, tidak kurang dari 1 atau lebih dari 128 byte panjangnya.

  Setiap nilai adalah sebuah objek Properti A.

  Peta pasangan kunci-nilai untuk properti OAuth2. Setiap nilai adalah sebuah Property objek.

• CustomAuthenticationProperties – Susunan peta pasangan nilai kunci.

  Setiap kunci adalah UTF-8 string, tidak kurang dari 1 atau lebih dari 128 byte panjangnya.

  Setiap nilai adalah sebuah objek Properti A.

  Peta pasangan kunci-nilai untuk properti otentikasi kustom. Setiap nilai adalah sebuah Property objek.

Bidang

• SupportedAuthenticationTypes- Diperlukan: Array UTF-8 string.

  Daftar jenis otentikasi yang didukung.

• SupportedDataOperations- Diperlukan: Array UTF-8 string.

  Daftar operasi data yang didukung.

• SupportedComputeEnvironments- Diperlukan: Array UTF-8 string.

  Daftar lingkungan komputasi yang didukung.

Bidang

• Name- Diperlukan: UTF-8 string, tidak kurang dari 1 atau lebih dari 128 byte panjangnya.

  Nama properti.

• Description- Diperlukan: UTF-8 string, panjangnya tidak lebih dari 1024 byte.

  Deskripsi properti.

• Required – Wajib: Boolean.

  Menunjukkan apakah properti diperlukan.

• DefaultValue— UTF-8 tali.

  Nilai default untuk properti.

• PropertyTypes- Diperlukan: Array UTF-8 string.

  Menjelaskan jenis properti.

• AllowedValues – Susunan objek AllowedValue.

  Daftar AllowedValue objek yang mewakili nilai yang diizinkan untuk properti.

• DataOperationScopes— Sebuah array UTF-8 string.

  Menunjukkan operasi data mana yang berlaku untuk properti.

• KeyOverride— UTF-8 tali.

  Nama kunci yang digunakan saat mengirim properti ini dalam permintaan API, jika berbeda dari nama tampilan.

• PropertyLocation— UTF-8 string (nilai valid: HEADER | BODY | QUERY_PARAM |PATH).

  Menentukan di mana properti ini harus disertakan dalam permintaan REST, seperti di header, parameter kueri, atau badan permintaan.

Bidang

• Description— UTF-8 string, tidak lebih dari 1024 byte panjangnya.

  Deskripsi nilai yang diizinkan.

• Value- Diperlukan: UTF-8 string, tidak kurang dari 1 atau lebih dari 128 byte panjangnya.

  Nilai yang diizinkan untuk properti.

Bidang

• Name- Diperlukan: UTF-8 string, tidak kurang dari 1 atau lebih dari 128 byte panjangnya.

  Nama untuk konfigurasi lingkungan komputasi.

• Description- Diperlukan: UTF-8 string, panjangnya tidak lebih dari 1024 byte.

  Deskripsi lingkungan komputasi.

• ComputeEnvironment— Diperlukan: UTF-8 string (nilai valid: SPARK | ATHENA |PYTHON).

  Tipe lingkungan komputasi.

• SupportedAuthenticationTypes- Diperlukan: Array UTF-8 string.

  Jenis otentikasi yang didukung untuk lingkungan komputasi.

• ConnectionOptions – Wajib: Susunan peta pasangan nilai kunci.

  Setiap kunci adalah UTF-8 string, tidak kurang dari 1 atau lebih dari 128 byte panjangnya.

  Setiap nilai adalah sebuah objek Properti A.

  Parameter yang digunakan sebagai opsi koneksi untuk lingkungan komputasi.

• ConnectionPropertyNameOverrides – Wajib: Susunan peta pasangan nilai kunci.

  Setiap kunci adalah UTF-8 string, tidak kurang dari 1 atau lebih dari 128 byte panjangnya.

  Setiap nilai adalah UTF-8 string, tidak kurang dari 1 atau lebih dari 128 byte panjangnya.

  Nama properti koneksi diganti untuk lingkungan komputasi.

• ConnectionOptionNameOverrides – Wajib: Susunan peta pasangan nilai kunci.

  Setiap kunci adalah UTF-8 string, tidak kurang dari 1 atau lebih dari 128 byte panjangnya.

  Setiap nilai adalah UTF-8 string, tidak kurang dari 1 atau lebih dari 128 byte panjangnya.

  Nama opsi koneksi diganti untuk lingkungan komputasi.

• ConnectionPropertiesRequiredOverrides- Diperlukan: Array UTF-8 string.

  Properti koneksi yang diperlukan sebagai penggantian untuk lingkungan komputasi.

• PhysicalConnectionPropertiesRequired – Boolean.

  Menunjukkan PhysicalConnectionProperties apakah diperlukan untuk lingkungan komputasi.

• ConnectionPropertiesConfiguration struktur

• ConnectorAuthenticationConfiguration struktur

• ConnectorProperty struktur

• RestConfiguration struktur

• SourceConfiguration struktur

• EntityConfiguration struktur

• ResponseConfiguration struktur

• ResponseExtractionMapping struktur

• PaginationConfiguration struktur

• CursorConfiguration struktur

• OffsetConfiguration struktur

• ExtractedParameter struktur

• FieldDefinition struktur

• ConnectorOAuth2Properties struktur

• ClientCredentialsProperties struktur

• JWTBearerProperties struktur

• ConnectorAuthorizationCodeProperties struktur

• BasicAuthenticationProperties struktur

• CustomAuthenticationProperties struktur

• FilterConfiguration struktur

• FilterOverrides struktur

• BetweenConfiguration struktur

• FilterStringConfiguration struktur

Bidang

• Url — Sebuah objek ConnectorProperty.

  URL instance dasar untuk titik akhir yang akan dihubungkan oleh jenis koneksi ini.

• AdditionalRequestParameters – Susunan objek ConnectorProperty.

  Key-value pasangan parameter permintaan tambahan yang mungkin diperlukan selama pembuatan koneksi, seperti versi API atau opsi konfigurasi khusus layanan.

Bidang

• AuthenticationTypes- Diperlukan: Array UTF-8 string.

  Daftar jenis otentikasi yang didukung oleh jenis koneksi ini, seperti Basic, OAuth2, atau metode otentikasi Kustom.

Bidang

• Name- Diperlukan: UTF-8 string, tidak kurang dari 1 atau lebih dari 128 byte panjangnya.

  Nama properti.

• KeyOverride— UTF-8 string, panjangnya tidak kurang dari 1 atau lebih dari 128 byte, cocok denganCustom string pattern #15.

  Nama kunci yang digunakan saat mengirim properti ini dalam permintaan API, jika berbeda dari nama tampilan.

• Required – Wajib: Boolean.

  Menunjukkan apakah properti diperlukan.

• DefaultValue— UTF-8 tali.

  Nilai default untuk properti.

• AllowedValues— Sebuah array UTF-8 string.

  Daftar AllowedValue objek yang mewakili nilai-nilai yang diizinkan untuk properti.

• PropertyLocation— UTF-8 string (nilai valid: HEADER | BODY | QUERY_PARAM |PATH).

  Menentukan di mana properti ini harus disertakan dalam permintaan REST, seperti di header, parameter kueri, atau badan permintaan.

• PropertyType— Diperlukan: UTF-8 string (nilai valid: USER_INPUT | SECRET | READ_ONLY | UNUSED |SECRET_OR_USER_INPUT).

  Tipe data properti ini

• Format— UTF-8 tali.

  Template format untuk nilai properti yang menentukan bagaimana nilai harus diformat sebelum mengirimkannya dalam permintaan API. Gunakan {value} sebagai placeholder untuk nilai properti aktual (misalnya,SSWS {value}).

Bidang

• GlobalSourceConfiguration — Sebuah objek SourceConfiguration.

  Setelan konfigurasi global yang berlaku untuk semua permintaan REST API untuk jenis koneksi ini, termasuk metode permintaan umum, jalur, dan parameter.

• ValidationEndpointConfiguration — Sebuah objek SourceConfiguration.

  Konfigurasi untuk titik akhir yang digunakan untuk memvalidasi kredentif koneksi dan menguji konektivitas selama pembuatan koneksi.

• EntityConfigurations – Susunan peta pasangan nilai kunci.

  Setiap kunci adalah UTF-8 string, panjangnya tidak kurang dari 1 atau lebih dari 128 byte, cocok denganCustom string pattern #12.

  Setiap nilai adalah sebuah objek EntityConfiguration.

  Peta konfigurasi entitas yang menentukan cara berinteraksi dengan entitas data yang berbeda yang tersedia melalui REST API, termasuk skema dan pola aksesnya.

Bidang

• RequestMethod— UTF-8 string (nilai valid: GET |POST).

  Metode HTTP yang digunakan untuk permintaan ke titik akhir ini, seperti GET, POST.

• RequestPath— UTF-8 string, tidak kurang dari 1 atau lebih dari 512 byte panjang, cocok denganCustom string pattern #14.

  Jalur URL untuk titik akhir REST, yang mungkin menyertakan placeholder parameter yang akan diganti dengan nilai aktual selama permintaan.

• RequestParameters – Susunan objek ConnectorProperty.

  Konfigurasi untuk parameter permintaan yang harus disertakan dalam panggilan API, seperti parameter kueri, header, atau isi isi.

• ResponseConfiguration — Sebuah objek ResponseConfiguration.

  Konfigurasi yang menentukan cara mengurai dan mengekstrak data dari respons API, termasuk keberhasilan dan penanganan kesalahan.

• PaginationConfiguration — Sebuah objek PaginationConfiguration.

  Konfigurasi untuk menangani respons berpaginasi dari REST API, mendukung strategi pagination berbasis kursor dan offset.

• FilterConfiguration — Sebuah objek FilterConfiguration.

  Konfigurasi untuk menerapkan pushdown filter ke permintaan REST API, menentukan bagaimana predikat filter diterjemahkan ke dalam parameter kueri atau string filter.

Bidang

• SourceConfiguration — Sebuah objek SourceConfiguration.

  Konfigurasi sumber yang mendefinisikan cara membuat permintaan untuk mengakses data entitas ini melalui REST API.

• Schema – Susunan peta pasangan nilai kunci.

  Setiap kunci adalah UTF-8 string, setidaknya 1 byte panjangnya.

  Setiap nilai adalah sebuah objek FieldDefinition A.

  Definisi skema untuk entitas ini, termasuk nama bidang, tipe, dan metadata lain yang menjelaskan struktur data.

Bidang

• ResultPath- Diperlukan: UTF-8 string, panjang tidak kurang dari 1 atau lebih dari 512 byte, cocok denganCustom string pattern #10.

  Ekspresi jalur JSON yang mengidentifikasi di mana data hasil aktual berada dalam respons API.

• ErrorPath— UTF-8 string, tidak kurang dari 1 atau lebih dari 512 byte panjang, cocok denganCustom string pattern #10.

  Ekspresi jalur JSON yang mengidentifikasi lokasi informasi kesalahan dalam respons API saat permintaan gagal.

Bidang

• ContentPath— UTF-8 string, tidak kurang dari 1 atau lebih dari 512 byte panjang, cocok denganCustom string pattern #10.

  Ekspresi jalur JSON yang menentukan cara mengekstrak nilai dari konten badan respons.

• HeaderKey— UTF-8 string, panjangnya tidak kurang dari 1 atau lebih dari 128 byte, cocok denganCustom string pattern #15.

  Nama header respons HTTP untuk mengekstrak nilainya.

Bidang

• CursorConfiguration — Sebuah objek CursorConfiguration.

  Konfigurasi untuk paginasi berbasis kursor, di mana API menyediakan kursor atau token untuk mengambil halaman hasil berikutnya.

• OffsetConfiguration — Sebuah objek OffsetConfiguration.

  Konfigurasi untuk paginasi berbasis offset, di mana API menggunakan offset numerik dan batas untuk mengontrol hasil mana yang dikembalikan.

Bidang

• NextPage — Wajib: Sebuah objek ExtractedParameter.

  Nama parameter atau jalur JSON yang berisi kursor atau token untuk mengambil halaman hasil berikutnya.

• LimitParameter — Sebuah objek ExtractedParameter.

  Nama parameter yang digunakan untuk menentukan jumlah maksimum hasil yang akan dikembalikan per halaman.

Bidang

• OffsetParameter — Wajib: Sebuah objek ExtractedParameter.

  Nama parameter yang digunakan untuk menentukan posisi awal atau offset untuk mengambil hasil.

• LimitParameter — Wajib: Sebuah objek ExtractedParameter.

  Nama parameter yang digunakan untuk menentukan jumlah maksimum hasil yang akan dikembalikan per halaman.

Bidang

• Key— UTF-8 string, panjangnya tidak kurang dari 1 atau lebih dari 128 byte, cocok denganCustom string pattern #15.

  Nama kunci parameter yang akan digunakan dalam permintaan berikutnya.

• DefaultValue— UTF-8 string, panjangnya tidak kurang dari 1 atau lebih dari 1024 byte, cocok denganCustom string pattern #16.

  Nilai default untuk digunakan jika parameter tidak dapat diekstraksi dari respons.

• PropertyLocation— UTF-8 string (nilai valid: HEADER | BODY | QUERY_PARAM |PATH).

  Menentukan di mana parameter yang diekstraksi ini harus ditempatkan dalam permintaan berikutnya, seperti di header, parameter kueri, atau badan permintaan.

• Value — Sebuah objek ResponseExtractionMapping.

  Jalur JSON atau pemetaan ekstraksi yang mendefinisikan cara mengekstrak nilai parameter dari respons API.

Bidang

• Name- Diperlukan: UTF-8 string.

  Nama bidang dalam skema entitas.

• FieldDataType— Diperlukan: UTF-8 string (nilai yang valid: INT SMALLINT | BIGINT | FLOAT | LONG | DATE | BOOLEAN | MAP | ARRAY | STRING | TIMESTAMP | DECIMAL | | BYTE | SHORT | DOUBLE | STRUCT | BINARY |UNION).

  Jenis data bidang.

• ResponseDateFormat— UTF-8 tali.

  Pola format untuk mengurai nilai tanggal dari respons API. Diperlukan saat API menggunakan non- ISO-8601 format. DateTimeFormatterMenerima pola Java (misalnya,EEE, d MMM yyyy HH:mm:ss Z), EPOCH_SECONDS untuk detik zaman Unix, atau EPOCH_MILLIS untuk milidetik zaman Unix.

• IsPartitionable – Boolean.

  Menunjukkan apakah bidang ini dapat digunakan untuk mempartisi kueri ke sumber data.

• IsNullable – Boolean.

  Menunjukkan apakah bidang ini dapat berisi nilai null.

• IsQueryable – Boolean.

  Menunjukkan apakah bidang ini dapat digunakan dalam predikat filter saat menanyakan data.

• IsOrderable – Boolean.

  Menunjukkan apakah bidang ini dapat digunakan untuk mengurutkan hasil.

• FilterOverrides — Sebuah objek FilterOverrides.

  Per-field mengganti perilaku filter, memungkinkan penyesuaian bagaimana filter diterapkan ke bidang khusus ini.

Bidang

• OAuth2GrantType— Diperlukan: UTF-8 string (nilai valid: CLIENT_CREDENTIALS | JWT_BEARER |AUTHORIZATION_CODE).

  Jenis pemberian OAuth2 untuk digunakan untuk otentikasi, seperti CLIENT_CREDENTIALS, JWT_BEARER, atau AUTHORIZATION_CODE.

• ClientCredentialsProperties — Sebuah objek ClientCredentialsProperties.

  Properti konfigurasi khusus untuk aliran jenis pemberian Kredensi Klien OAuth2.

• JWTBearerProperties — Sebuah objek JWTBearerProperties.

  Properti konfigurasi khusus untuk aliran jenis hibah OAuth2 JWT Bearer.

• AuthorizationCodeProperties — Sebuah objek ConnectorAuthorizationCodeProperties.

  Properti konfigurasi khusus untuk aliran jenis pemberian Kode Ootorisasi OAuth2.

Bidang

• TokenUrl — Sebuah objek ConnectorProperty.

  URL titik akhir token tempat klien akan meminta token akses menggunakan kredenSIAL klien.

• RequestMethod— UTF-8 string (nilai valid: GET |POST).

  Metode HTTP yang digunakan saat membuat permintaan token, biasanya POST.

• ContentType— UTF-8 string (nilai valid: APPLICATION_JSON |URL_ENCODED).

  Jenis konten yang digunakan untuk permintaan token, seperti application/x -www-form-urlencoded atau. application/json

• ClientId — Sebuah objek ConnectorProperty.

  Pengidentifikasi klien OAuth2 disediakan oleh server otorisasi.

• ClientSecret — Sebuah objek ConnectorProperty.

  Rahasia klien OAuth2 disediakan oleh server otorisasi.

• Scope — Sebuah objek ConnectorProperty.

  Cakupan OAuth2 yang mendefinisikan tingkat akses yang diminta untuk alur kredenSIAL klien.

• TokenUrlParameters – Susunan objek ConnectorProperty.

  Parameter tambahan untuk disertakan dalam permintaan URL token sebagai pasangan kunci-nilai.

Bidang

• TokenUrl — Sebuah objek ConnectorProperty.

  URL titik akhir token tempat token pembawa JWT akan ditukar dengan token akses.

• RequestMethod— UTF-8 string (nilai valid: GET |POST).

  Metode HTTP yang digunakan saat membuat permintaan token pembawa JWT, biasanya POST.

• ContentType— UTF-8 string (nilai valid: APPLICATION_JSON |URL_ENCODED).

  Jenis konten yang digunakan untuk permintaan token pembawa JWT, seperti application/x -www-form-urlencoded atau. application/json

• JwtToken — Sebuah objek ConnectorProperty.

  Token JWT yang akan digunakan dalam aliran hibah token pembawa untuk otentikasi.

• TokenUrlParameters – Susunan objek ConnectorProperty.

  Parameter tambahan untuk disertakan dalam permintaan URL token sebagai pasangan kunci-nilai.

Bidang

• AuthorizationCodeUrl — Sebuah objek ConnectorProperty.

  URL titik akhir otorisasi tempat pengguna akan diarahkan untuk memberikan otorisasi.

• AuthorizationCode — Sebuah objek ConnectorProperty.

  Kode otorisasi diterima dari server otorisasi setelah persetujuan pengguna.

• RedirectUri — Sebuah objek ConnectorProperty.

  URI pengalihan yang harus cocok dengan URI yang terdaftar dengan server otorisasi.

• TokenUrl — Sebuah objek ConnectorProperty.

  URL titik akhir token tempat kode otorisasi akan ditukar dengan token akses.

• RequestMethod— UTF-8 string (nilai valid: GET |POST).

  Metode HTTP yang digunakan saat membuat permintaan pertukaran token, biasanya POST.

• ContentType— UTF-8 string (nilai valid: APPLICATION_JSON |URL_ENCODED).

  Jenis konten yang digunakan untuk permintaan pertukaran token, seperti application/x -www-form-urlencoded atau. application/json

• ClientId — Sebuah objek ConnectorProperty.

  Pengidentifikasi klien OAuth2 disediakan oleh server otorisasi.

• ClientSecret — Sebuah objek ConnectorProperty.

  Rahasia klien OAuth2 disediakan oleh server otorisasi.

• Scope — Sebuah objek ConnectorProperty.

  Cakupan OAuth2 yang mendefinisikan tingkat akses yang diminta untuk aliran kode otorisasi.

• Prompt — Sebuah objek ConnectorProperty.

  Parameter prompt OAuth2 yang mengontrol perilaku server otorisasi selama otentikasi pengguna.

• TokenUrlParameters – Susunan objek ConnectorProperty.

  Parameter tambahan untuk disertakan dalam permintaan URL token sebagai pasangan kunci-nilai.

Bidang

• Username — Sebuah objek ConnectorProperty.

  Nama properti username yang akan digunakan untuk kredentif otentikasi Dasar.

• Password — Sebuah objek ConnectorProperty.

  Nama properti kata sandi yang akan digunakan untuk kredentif otentikasi Dasar.

Bidang

• AuthenticationParameters – Wajib: Susunan objek ConnectorProperty.

  Peta parameter otentikasi khusus yang menentukan mekanisme otentikasi spesifik dan properti yang diperlukan.

Bidang

• FilterMode— Diperlukan: UTF-8 string (nilai valid: QUERY_PARAMS |FILTER_STRING).

  Strategi untuk menerapkan filter ke permintaan. Gunakan QUERY_PARAMS untuk meneruskan filter sebagai parameter kueri individu, atau FILTER_STRING untuk membangun string ekspresi filter tunggal.

• OperatorMappings – Susunan peta pasangan nilai kunci.

  Setiap kunci adalah UTF-8 string.

  Setiap nilai adalah UTF-8 string.

  Peta operator filter logis ke representasi API-specific string mereka. Kunci operator yang didukung adalah: EQUAL_TO NOT_EQUAL_TOLESS_THAN,,GREATER_THAN,LESS_THAN_OR_EQUAL_TO,GREATER_THAN_OR_EQUAL_TO,CONTAINS,BETWEEN,AND, danOR.

• DateTimeFormat— UTF-8 tali.

  Format tanggal dan waktu global untuk ekspresi filter. DateTimeFormatterMenerima pola Java (misalnya,EEE, d MMM yyyy HH:mm:ss Z), EPOCH_SECONDS untuk detik zaman Unix, atau EPOCH_MILLIS untuk milidetik zaman Unix. Jika tidak ditentukan, nilai diteruskan apa adanya dalam ISO-8601 format.

• StripQuotes – Boolean.

  Menunjukkan apakah tanda kutip ganda di sekitarnya harus dilucuti dari nilai filter sebelum diproses.

• BetweenConfiguration — Sebuah objek BetweenConfiguration.

  Konfigurasi untuk menangani operasi filter rentang BETWEEN.

• FilterStringConfiguration — Sebuah objek FilterStringConfiguration.

  Konfigurasi untuk membangun ekspresi filter ketika FilterMode disetel keFILTER_STRING.

Bidang

• FieldName— UTF-8 tali.

  Penggantian nama bidang yang akan digunakan dalam ekspresi filter, jika berbeda dari nama bidang skema.

• OperatorMappings – Susunan peta pasangan nilai kunci.

  Setiap kunci adalah UTF-8 string.

  Setiap nilai adalah UTF-8 string.

  Peta operator filter logis ke representasi API khusus bidang mereka, mengesampingkan pemetaan operator global. Kunci operator yang didukung adalah: EQUAL_TO NOT_EQUAL_TOLESS_THAN,,GREATER_THAN,LESS_THAN_OR_EQUAL_TO,GREATER_THAN_OR_EQUAL_TO,CONTAINS,BETWEEN,AND, danOR.

• BetweenConfiguration — Sebuah objek BetweenConfiguration.

  Field-specific konfigurasi untuk menangani operasi filter rentang ANTARA.

• DateTimeFormat— UTF-8 tali.

  Format tanggal dan waktu untuk ekspresi filter pada bidang ini, mengesampingkan globalDateTimeFormat. DateTimeFormatterMenerima pola Java (misalnya,EEE, d MMM yyyy HH:mm:ss Z), EPOCH_SECONDS untuk detik zaman Unix, atau EPOCH_MILLIS untuk milidetik zaman Unix.

Bidang

• LowBoundKey— UTF-8 tali.

  Nama parameter yang digunakan untuk nilai batas bawah dalam operasi filter BETWEEN.

• HighBoundKey— UTF-8 tali.

  Nama parameter yang digunakan untuk nilai batas atas dalam operasi filter BETWEEN.

• Template— UTF-8 tali.

  String template untuk membangun ekspresi filter BETWEEN.

Bidang

• QueryParameterName- Diperlukan: UTF-8 string.

  Nama parameter kueri yang digunakan untuk mengirim string ekspresi filter yang dibangun dalam permintaan API.

• QuoteStringValues – Boolean.

  Menunjukkan apakah nilai string dan tanggal harus dibungkus dengan karakter kutipan dalam ekspresi filter.

• QuoteCharacter— UTF-8 tali.

  Karakter yang digunakan untuk mengutip nilai ketika QuoteStringValues benar. Defaultnya adalah tanda kutip ganda jika tidak ditentukan.