MaxCompute:Panduan Pengguna SDK CatalogAPI

Signature metode

Table createTable(Table table)

Parameter permintaan

Respons

Mengembalikan objek Table yang dibuat.

Contoh penggunaan

// Bangun tabel
Table table = new Table();
table.setProjectId("my_project");
table.setSchemaName("default");
table.setTableName("my_table");
table.setDescription("Ini adalah contoh tabel");
table.setType("TABLE");

// Tetapkan skema tabel
TableFieldSchema field = new TableFieldSchema();
field.setFieldName("id");
field.setTypeCategory("BIGINT");
field.setMode("REQUIRED");

TableFieldSchema nameField = new TableFieldSchema();
nameField.setFieldName("name");
nameField.setTypeCategory("STRING");
nameField.setMode("NULLABLE");

TableFieldSchema schema = new TableFieldSchema();
schema.setFields(Arrays.asList(field, nameField));
table.setTableSchema(schema);

// Buat tabel
Table createdTable = client.createTable(table);
System.out.println("Tabel dibuat: " + createdTable.getName());

Signature metode

Table getTable(Table table)

Parameter permintaan

Respons

Mengembalikan objek Table.

Contoh penggunaan

Table query = new Table();
query.setProjectId("my_project");
query.setSchemaName("default");
query.setTableName("my_table");

Table result = client.getTable(query);
System.out.println("Tipe tabel: " + result.getType());
System.out.println("Deskripsi: " + result.getDescription());

Signature metode

Table updateTable(Table table)

Parameter permintaan

Respons

Mengembalikan objek Table yang diperbarui.

Contoh penggunaan

Table table = client.getTable(query);
table.setDescription("Deskripsi diperbarui");

Table updated = client.updateTable(table);

Signature metode

HttpResponse deleteTable(Table table)

Parameter permintaan

Respons

Mengembalikan HttpResponse kosong jika berhasil.

Contoh penggunaan

HttpResponse response = client.deleteTable(table);
System.out.println("Kode status: " + response.getStatusCode());

Signature metode

ListTablesResponse listTables(String projectId, String schemaName, Integer pageSize, String pageToken)

Parameter permintaan

Respons

{
  "tables": [Table],
  "nextPageToken": "string"
}

Contoh penggunaan

ListTablesResponse response = client.listTables("my_project", "default", 100, "");

// Iterasi melalui semua halaman
while (response.getTables() != null && !response.getTables().isEmpty()) {
    for (Table t : response.getTables()) {
        System.out.println(t.getTableName());
    }
    
    if (response.getNextPageToken() == null || response.getNextPageToken().isEmpty()) {
        break;
    }
    response = client.listTables("my_project", "default", 100, response.getNextPageToken());
}

Signature metode

Policy setTablePolicy(Table table, SetPolicyRequest request)

Parameter permintaan

Respons

Mengembalikan objek Policy yang diperbarui.

Signature metode

Policy getTablePolicy(Table table)

Parameter permintaan

Respons

Mengembalikan objek Policy tabel.

Signature metode

DataToken getDataToken(Table table, Integer duration)

Parameter permintaan

Respons

{
  "version": "string",
  "type": "string",
  "value": "string",
  "expiration": "string"
}

Deskripsi field DataToken

Signature metode

ListPartitionsResponse listPartitions(
    String projectId, 
    String schemaName, 
    String tableName, 
    Integer pageSize, 
    String pageToken,
    String query,
    String view
)

Parameter permintaan

Respons

{
  "partitions": [Partition],
  "nextPageToken": "string"
}

Signature metode

Connection createConnection(String namespace, Connection connection)

Parameter permintaan

Respons

Mengembalikan objek Connection yang dibuat.

Contoh penggunaan

// Bangun Koneksi
Connection conn = new Connection();
conn.setConnectionName("my_oss_connection");
conn.setDescription("Koneksi untuk mengakses OSS");
conn.setConnectionType("CLOUD_RESOURCE");

CloudResourceOptions options = new CloudResourceOptions();
options.setRamRoleArn("acs:ram::123456789:role/MaxComputeOSSRole");
conn.setCloudResource(options);

// Buat koneksi
Connection created = client.createConnection("123456789", conn);

Signature metode

ListConnectionsResponse listConnections(String namespace, Integer pageSize, String pageToken)

Parameter permintaan

Respons

{
  "connections": [Connection],
  "nextPageToken": "string"
}

Signature metode

Connection getConnection(String namespace, String connectionName)

Signature metode

Connection updateConnection(String namespace, String connectionName, Connection connection, String updateMask)

Parameter permintaan

Respons

Mengembalikan objek Connection yang diperbarui.

Contoh penggunaan

Connection conn = new Connection();
conn.setConnectionName("my_oss_connection");
conn.setDescription("Deskripsi diperbarui");

Connection updated = client.updateConnection("123456789", "my_oss_connection", conn, "description");

Signature metode

HttpResponse deleteConnection(String namespace, String connectionName)

Signature metode

Policy setConnectionPolicy(String namespace, String connectionName, SetPolicyRequest request)

Signature metode

Policy getConnectionPolicy(String namespace, String connectionName)

Signature metode

Role createRole(String namespace, Role role)

Parameter permintaan

Respons

Mengembalikan objek Role yang dibuat.

Contoh penggunaan

Role role = new Role();
role.setRoleName("my_custom_role");
role.setDescription("Role kustom");
role.setIncludedPermissions(Arrays.asList("odps:CreateTable", "odps:ListTable"));

Role created = client.createRole("123456789", role);

Signature metode

ListRolesResponse listRoles(
    String namespace, 
    Integer pageSize, 
    String pageToken, 
    String view, 
    Boolean showDeleted
)

Parameter permintaan

Respons

{
  "roles": [Role],
  "nextPageToken": "string"
}

Signature metode

Role getRole(String namespace, String roleName)

Parameter permintaan

Signature metode

Role updateRole(String namespace, String roleName, Role role, String updateMask)

Parameter permintaan

Signature metode

HttpResponse deleteRole(String namespace, String roleName)

Signature metode

Policy setRolePolicy(String namespace, String roleName, SetPolicyRequest request)

Signature metode

Policy getRolePolicy(String namespace, String roleName)

Signature metode

Taxonomy createTaxonomy(String namespace, Taxonomy taxonomy)

Parameter permintaan

Response

Mengembalikan objek Taxonomy yang dibuat.

Contoh penggunaan

Taxonomy taxonomy = new Taxonomy();
taxonomy.setTaxonomyName("sensitive_data");
taxonomy.setDescription("Klasifikasi data sensitif");
taxonomy.setActivatedPolicyTypes(Arrays.asList("FINE_GRAINED_ACCESS_CONTROL"));

Taxonomy created = client.createTaxonomy("123456789", taxonomy);

Signature metode

ListTaxonomiesResponse listTaxonomies(String namespace, Integer pageSize, String pageToken)

Signature metode

Taxonomy getTaxonomy(String namespace, String taxonomyId)

Signature metode

Taxonomy updateTaxonomy(String namespace, String taxonomyId, Taxonomy taxonomy, String updateMask)

Parameter permintaan

Signature metode

HttpResponse deleteTaxonomy(String namespace, String taxonomyId)

Signature metode

Policy setTaxonomyPolicy(String namespace, String taxonomyId, SetPolicyRequest request)

Signature metode

Policy getTaxonomyPolicy(String namespace, String taxonomyId)

Signature metode

PolicyTag createPolicyTag(String namespace, String taxonomyId, PolicyTag policyTag)

Parameter permintaan

Respons

Mengembalikan objek PolicyTag yang dibuat.

Contoh penggunaan

PolicyTag tag = new PolicyTag();
tag.setPolicyTagName("phone_number");
tag.setDescription("Tag penyembunyian nomor telepon");

PolicyTag created = client.createPolicyTag("123456789", "taxonomy_id_123", tag);

Signature metode

ListPolicyTagsResponse listPolicyTags(
    String namespace, 
    String taxonomyId, 
    Integer pageSize, 
    String pageToken
)

Signature metode

PolicyTag getPolicyTag(String namespace, String taxonomyId, String policyTagId)

Signature metode

PolicyTag updatePolicyTag(
    String namespace, 
    String taxonomyId, 
    String policyTagId, 
    PolicyTag policyTag, 
    String updateMask
)

Parameter permintaan

Signature metode

HttpResponse deletePolicyTag(String namespace, String taxonomyId, String policyTagId)

Signature metode

Policy setPolicyTagPolicy(String namespace, String taxonomyId, String policyTagId, SetPolicyRequest request)

Signature metode

Policy getPolicyTagPolicy(String namespace, String taxonomyId, String policyTagId)

Signature metode

DataPolicy createDataPolicy(String namespace, DataPolicy dataPolicy)

Parameter permintaan

Respons

Mengembalikan objek DataPolicy yang dibuat.

Contoh penggunaan

// Bangun aturan penyembunyian
DataMaskingPolicy maskingPolicy = new DataMaskingPolicy();
maskingPolicy.setPredefinedExpression("STRING_MASKED_BA");

DataPolicy policy = new DataPolicy();
policy.setDataPolicyName("phone_masking");
policy.setPolicyTag("namespaces/123456789/taxonomies/tid_123/policyTags/ptid_456");
policy.setDataPolicyType("DATA_MASKING_POLICY");
policy.setDataMaskingPolicy(maskingPolicy);

DataPolicy created = client.createDataPolicy("123456789", policy);

Signature metode

ListDataPoliciesResponse listDataPolicies(String namespace, Integer pageSize, String pageToken)

Signature metode

DataPolicy getDataPolicy(String namespace, String dataPolicyName)

Signature metode

HttpResponse deleteDataPolicy(String namespace, String dataPolicyName)

Signature metode

Policy setDataPolicyPolicy(String namespace, String dataPolicyName, SetPolicyRequest request)

Signature metode

Policy getDataPolicyPolicy(String namespace, String dataPolicyName)

Signature metode

DataScan createDataScan(String namespace, DataScan dataScan)

Parameter permintaan

Respons

Mengembalikan objek DataScan yang dibuat.

Contoh penggunaan

// Bangun tugas pemerindaian
DataScanSource source = new DataScanSource();
source.setLocation("oss://my-bucket/my-path/");
source.setConnection("my_oss_connection");

DataScanTarget target = new DataScanTarget();
target.setProject("my_project");
target.setSchema("default");
target.setNamePrefix("auto_");

DataScanProperties properties = new DataScanProperties();
properties.setFormatFilter("AUTO");
properties.setScanMode("SAMPLE");
properties.setAutoCommit(true);

DataScan dataScan = new DataScan();
dataScan.setScanName("my_oss_scan");
dataScan.setType("TABLE_DISCOVERY");
dataScan.setDescription("Pindai metadata OSS");
dataScan.setSource(source);
dataScan.setTarget(target);
dataScan.setProperties(properties);
dataScan.setSchedulerMode("MANUAL");

DataScan created = client.createDataScan("123456789", dataScan);

Signature metode

ListDataScansResponse listDataScans(String namespace, Integer pageSize, String pageToken)

Signature metode

DataScan getDataScan(String namespace, String dataScanName)

Signature metode

DataScan updateDataScan(String namespace, DataScan dataScan, String updateMask)

Signature metode

HttpResponse deleteDataScan(String namespace, String dataScanName)

Signature metode

HttpResponse triggerDataScan(String namespace, String dataScanName)

Contoh penggunaan

HttpResponse response = client.triggerDataScan("123456789", "my_oss_scan");
System.out.println("Dipicu: " + response.getStatusCode());

Signature metode

ListDataScanJobsResponse listDataScanJobs(
    String namespace, 
    String dataScanName, 
    Integer pageSize, 
    String pageToken
)

Respons

{
  "scanJobs": [ScanJob],
  "nextPageToken": "string"
}

Model ScanJob

Signature metode

Model createModel(String projectId, String schemaName, Model model)

Parameter permintaan

Respons

Mengembalikan objek Model yang dibuat.

Contoh penggunaan

Model model = new Model();
model.setModelName("my_llm_model");
model.setVersionName("v1");
model.setDefaultVersion("v1");
model.setDescription("Model bahasa besar saya");
model.setSourceType("IMPORT");
model.setModelType("LLM");
model.setPath("oss://my-bucket/models/my_llm/");
model.setTasks(Arrays.asList("text-generation", "chat"));

Model created = client.createModel("my_project", "default", model);

Signature metode

ListModelsResponse listModels(
    String projectId, 
    String schemaName, 
    Integer pageSize, 
    String pageToken
)

Signature metode

Model getModel(String projectId, String schemaName, String modelName, String versionName)

Parameter permintaan

Signature metode

Model updateModel(
    String projectId, 
    String schemaName, 
    String modelName, 
    Model model, 
    String updateMask, 
    String versionName
)

Signature metode

HttpResponse deleteModel(String projectId, String schemaName, String modelName)

Signature metode

Model createModelVersion(String projectId, String schemaName, String modelName, Model model)

Contoh penggunaan

Model version = new Model();
version.setModelName("my_llm_model");
version.setVersionName("v2");
version.setVersionDescription("Versi model diperbarui");
version.setPath("oss://my-bucket/models/my_llm_v2/");
version.setTasks(Arrays.asList("text-generation", "chat"));

Model createdVersion = client.createModelVersion("my_project", "default", "my_llm_model", version);

Signature metode

HttpResponse deleteModelVersion(
    String projectId, 
    String schemaName, 
    String modelName, 
    String versionName
)

Signature metode

ListModelVersionsResponse listModelVersions(
    String projectId, 
    String schemaName, 
    String modelName, 
    Integer pageSize, 
    String pageToken
)

Signature metode

Policy setModelPolicy(String projectId, String schemaName, String modelName, SetPolicyRequest request)

Signature metode

Policy getModelPolicy(String projectId, String schemaName, String modelName)

Signature metode

Project getProject(String projectId)

Contoh penggunaan

Project project = client.getProject("my_project");
System.out.println("Pemilik proyek: " + project.getOwner());
System.out.println("Skema diaktifkan: " + project.getSchemaEnabled());
System.out.println("Wilayah: " + project.getRegion());

Signature metode

Schema createSchema(String projectId, Schema schema)

Parameter permintaan

Respons

Mengembalikan objek Schema yang dibuat.

Contoh penggunaan

Schema schema = new Schema();
schema.setSchemaName("my_schema");
schema.setDescription("Skema kustom saya");

Schema created = client.createSchema("my_project", schema);

Signature metode

ListSchemasResponse listSchemas(String projectId, Integer pageSize, String pageToken)

Signature metode

Schema getSchema(String projectId, String schemaName)

Signature metode

Schema updateSchema(String projectId, String schemaName, String updateMask, Schema schema)

Parameter permintaan

Signature metode

HttpResponse deleteSchema(String projectId, String schemaName)

Signature metode

Policy setSchemaPolicy(String projectId, String schemaName, SetPolicyRequest request)

Signature metode

Policy getSchemaPolicy(String projectId, String schemaName)

Signature metode

SearchResponse search(
    String namespaceId, 
    String query, 
    Integer pageSize, 
    String pageToken, 
    String orderBy
)

Parameter permintaan

Sintaks kueri

• Daftar kondisi kueri:

  Kondisi kueri	Deskripsi
  name:foo	Cocokkan foo sebagai substring terhadap nama entitas
  description:bar	Cocokkan bar sebagai substring terhadap deskripsi entitas
  type=TABLE	Wajib. Cocokkan entitas dengan tipe tertentu. Saat ini mendukung TABLE, RESOURCE, SCHEMA
  project=proj	Cari entitas hanya di bawah proyek tertentu. Pemanggil harus memiliki izin SearchProject untuk proyek tersebut
  project=(proj1|proj2|proj3)	Cari entitas di beberapa proyek (maksimal 512). Pemanggil harus memiliki izin SearchProject untuk semua proyek yang ditentukan
  region=region_id	Cari entitas di bawah proyek dalam wilayah tertentu

  • project=proj dan project=(proj1|proj2|proj3) tidak dapat digunakan bersamaan

  • region=region_id tidak dapat digunakan bersamaan dengan kondisi kueri project

Urutan pengurutan (orderBy)

Respons

{
  "entries": [SearchResultEntry],
  "nextPageToken": "string"
}

Contoh penggunaan

// Cari semua tabel dalam proyek tertentu
SearchResponse response = client.search(
    "123456789",                            // namespaceId
    "type=TABLE,project=my_project",        // query
    50,                                     // pageSize
    "",                                     // pageToken
    "last_modified_time desc"               // orderBy
);

if (response.getEntries() != null) {
    for (SearchResultEntry entry : response.getEntries()) {
        System.out.println("Nama: " + entry.getDisplayName());
        System.out.println("Tipe: " + entry.getType());
        System.out.println("Path: " + entry.getName());
    }
}