Managed Service for Greenplum® API, gRPC: PXFDatasourceService
Статья создана
Обновлена 9 октября 2023 г.
Call | Description |
---|---|
List | List all PXF datasources |
Create | Creates PXF datasource |
Update | Update PXF datasource |
Delete | Delete PXF datasource |
Calls PXFDatasourceService
List
List all PXF datasources
rpc List (ListPXFDatasourcesRequest) returns (ListPXFDatasourcesResponse)
ListPXFDatasourcesRequest
Field | Description |
---|---|
cluster_id | string Required. The maximum string length in characters is 50. |
ListPXFDatasourcesResponse
Field | Description |
---|---|
datasources[] | PXFDatasource |
PXFDatasource
Field | Description |
---|---|
name | string Required. The string length in characters must be 3-200. |
settings | oneof: s3 , jdbc , hdfs or hive |
s3 | PXFDatasourceS3 |
jdbc | PXFDatasourceJDBC |
hdfs | PXFDatasourceHDFS |
hive | PXFDatasourceHive |
PXFDatasourceS3
Field | Description |
---|---|
access_key | string The maximum string length in characters is 200. |
secret_key | string The maximum string length in characters is 200. |
fast_upload | google.protobuf.BoolValue |
endpoint | string The maximum string length in characters is 200. |
PXFDatasourceJDBC
Field | Description |
---|---|
driver | string Matches jdbc.driver The maximum string length in characters is 50. |
url | string Matches jdbc.url The maximum string length in characters is 200. |
user | string Matches jdbc.user The maximum string length in characters is 200. |
password | string Matches jdbc.password The maximum string length in characters is 200. |
statement_batch_size | google.protobuf.Int64Value Matches jdbc.statement.batchsize Acceptable values are 50 to 1000, inclusive. |
statement_fetch_size | google.protobuf.Int64Value Matches jdbc.statement.fetchsize Acceptable values are 50 to 10000, inclusive. |
statement_query_timeout | google.protobuf.Int64Value Matches jdbc.statement.querytimeout Acceptable values are 5 to 600, inclusive. |
pool_enabled | google.protobuf.BoolValue Matches jdbc.pool.enabled |
pool_maximum_size | google.protobuf.Int64Value Matches jdbc.pool.property.maximumpoolsize Acceptable values are 10 to 200, inclusive. |
pool_connection_timeout | google.protobuf.Int64Value Matches jdbc.pool.property.connectiontimeout Acceptable values are 5000 to 600000, inclusive. |
pool_idle_timeout | google.protobuf.Int64Value Matches jdbc.pool.property.idletimeout Acceptable values are 5000 to 600000, inclusive. |
pool_minimum_idle | google.protobuf.Int64Value Matches jdbc.pool.property.minimumidle Acceptable values are 0 to 200, inclusive. |
PXFDatasourceHDFS
Field | Description |
---|---|
core | PXFDatasourceCore |
kerberos | PXFDatasourceKerberos |
user_impersonation | google.protobuf.BoolValue |
username | string The maximum string length in characters is 128. |
sasl_connection_retries | google.protobuf.Int64Value Acceptable values are 1 to 50, inclusive. |
zk_hosts[] | string The maximum number of elements is 200. The string length in characters for each value must be 1-200. |
dfs | PXFDatasourceHDFSDfs |
yarn | PXFDatasourceHDFSYarn |
PXFDatasourceCore
Field | Description |
---|---|
default_fs | string The maximum string length in characters is 200. |
security_auth_to_local | string The maximum string length in characters is 1000. |
PXFDatasourceKerberos
Field | Description |
---|---|
enable | google.protobuf.BoolValue |
primary | string The maximum string length in characters is 128. |
realm | string The maximum string length in characters is 1000. |
kdc_servers[] | string The maximum number of elements is 200. The string length in characters for each value must be 1-200. |
admin_server | string The maximum string length in characters is 128. |
default_domain | string The maximum string length in characters is 128. |
keytab_base64 | string Value must match the regular expression ^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=)?$ . The maximum string length in characters is 65536. |
PXFDatasourceHDFSDfs
Field | Description |
---|---|
ha_automatic_failover_enabled | google.protobuf.BoolValue |
block_access_token_enabled | google.protobuf.BoolValue |
use_datanode_hostname | google.protobuf.BoolValue |
namenodes | map<string,PXFDatasourceHDFSDfsNamenode> No more than 10000 per resource. |
PXFDatasourceHDFSYarn
Field | Description |
---|---|
resourcemanager_ha_enabled | google.protobuf.BoolValue |
resourcemanager_ha_auto_failover_enabled | google.protobuf.BoolValue |
resourcemanager_ha_auto_failover_embedded | google.protobuf.BoolValue |
resourcemanager_cluster_id | string The maximum string length in characters is 1000. |
ha_rm | map<string,PXFDatasourceHDFSYarnHaRm> No more than 10000 per resource. |
PXFDatasourceHive
Field | Description |
---|---|
core | PXFDatasourceCore |
kerberos | PXFDatasourceKerberos |
user_impersonation | google.protobuf.BoolValue |
username | string The maximum string length in characters is 128. |
sasl_connection_retries | google.protobuf.Int64Value Acceptable values are 1 to 50, inclusive. |
zk_hosts[] | string The maximum number of elements is 200. The string length in characters for each value must be 1-200. |
ppd | google.protobuf.BoolValue |
metastore_uris[] | string The maximum number of elements is 200. The string length in characters for each value must be 1-200. |
metastore_kerberos_principal | string The maximum string length in characters is 1000. |
auth_kerberos_principal | string The maximum string length in characters is 1000. |
Create
Creates PXF datasource
rpc Create (CreatePXFDatasourceRequest) returns (operation.Operation)
Metadata and response of Operation:
Operation.metadata:CreatePXFDatasourceMetadata
Operation.response:PXFDatasource
CreatePXFDatasourceRequest
Field | Description |
---|---|
cluster_id | string Required. The maximum string length in characters is 50. |
datasource | PXFDatasource |
PXFDatasource
Field | Description |
---|---|
name | string Required. The string length in characters must be 3-200. |
settings | oneof: s3 , jdbc , hdfs or hive |
s3 | PXFDatasourceS3 |
jdbc | PXFDatasourceJDBC |
hdfs | PXFDatasourceHDFS |
hive | PXFDatasourceHive |
PXFDatasourceS3
Field | Description |
---|---|
access_key | string The maximum string length in characters is 200. |
secret_key | string The maximum string length in characters is 200. |
fast_upload | google.protobuf.BoolValue |
endpoint | string The maximum string length in characters is 200. |
PXFDatasourceJDBC
Field | Description |
---|---|
driver | string Matches jdbc.driver The maximum string length in characters is 50. |
url | string Matches jdbc.url The maximum string length in characters is 200. |
user | string Matches jdbc.user The maximum string length in characters is 200. |
password | string Matches jdbc.password The maximum string length in characters is 200. |
statement_batch_size | google.protobuf.Int64Value Matches jdbc.statement.batchsize Acceptable values are 50 to 1000, inclusive. |
statement_fetch_size | google.protobuf.Int64Value Matches jdbc.statement.fetchsize Acceptable values are 50 to 10000, inclusive. |
statement_query_timeout | google.protobuf.Int64Value Matches jdbc.statement.querytimeout Acceptable values are 5 to 600, inclusive. |
pool_enabled | google.protobuf.BoolValue Matches jdbc.pool.enabled |
pool_maximum_size | google.protobuf.Int64Value Matches jdbc.pool.property.maximumpoolsize Acceptable values are 10 to 200, inclusive. |
pool_connection_timeout | google.protobuf.Int64Value Matches jdbc.pool.property.connectiontimeout Acceptable values are 5000 to 600000, inclusive. |
pool_idle_timeout | google.protobuf.Int64Value Matches jdbc.pool.property.idletimeout Acceptable values are 5000 to 600000, inclusive. |
pool_minimum_idle | google.protobuf.Int64Value Matches jdbc.pool.property.minimumidle Acceptable values are 0 to 200, inclusive. |
PXFDatasourceHDFS
Field | Description |
---|---|
core | PXFDatasourceCore |
kerberos | PXFDatasourceKerberos |
user_impersonation | google.protobuf.BoolValue |
username | string The maximum string length in characters is 128. |
sasl_connection_retries | google.protobuf.Int64Value Acceptable values are 1 to 50, inclusive. |
zk_hosts[] | string The maximum number of elements is 200. The string length in characters for each value must be 1-200. |
dfs | PXFDatasourceHDFSDfs |
yarn | PXFDatasourceHDFSYarn |
PXFDatasourceCore
Field | Description |
---|---|
default_fs | string The maximum string length in characters is 200. |
security_auth_to_local | string The maximum string length in characters is 1000. |
PXFDatasourceKerberos
Field | Description |
---|---|
enable | google.protobuf.BoolValue |
primary | string The maximum string length in characters is 128. |
realm | string The maximum string length in characters is 1000. |
kdc_servers[] | string The maximum number of elements is 200. The string length in characters for each value must be 1-200. |
admin_server | string The maximum string length in characters is 128. |
default_domain | string The maximum string length in characters is 128. |
keytab_base64 | string Value must match the regular expression ^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=)?$ . The maximum string length in characters is 65536. |
PXFDatasourceHDFSDfs
Field | Description |
---|---|
ha_automatic_failover_enabled | google.protobuf.BoolValue |
block_access_token_enabled | google.protobuf.BoolValue |
use_datanode_hostname | google.protobuf.BoolValue |
namenodes | map<string,PXFDatasourceHDFSDfsNamenode> No more than 10000 per resource. |
PXFDatasourceHDFSYarn
Field | Description |
---|---|
resourcemanager_ha_enabled | google.protobuf.BoolValue |
resourcemanager_ha_auto_failover_enabled | google.protobuf.BoolValue |
resourcemanager_ha_auto_failover_embedded | google.protobuf.BoolValue |
resourcemanager_cluster_id | string The maximum string length in characters is 1000. |
ha_rm | map<string,PXFDatasourceHDFSYarnHaRm> No more than 10000 per resource. |
PXFDatasourceHive
Field | Description |
---|---|
core | PXFDatasourceCore |
kerberos | PXFDatasourceKerberos |
user_impersonation | google.protobuf.BoolValue |
username | string The maximum string length in characters is 128. |
sasl_connection_retries | google.protobuf.Int64Value Acceptable values are 1 to 50, inclusive. |
zk_hosts[] | string The maximum number of elements is 200. The string length in characters for each value must be 1-200. |
ppd | google.protobuf.BoolValue |
metastore_uris[] | string The maximum number of elements is 200. The string length in characters for each value must be 1-200. |
metastore_kerberos_principal | string The maximum string length in characters is 1000. |
auth_kerberos_principal | string The maximum string length in characters is 1000. |
Operation
Field | Description |
---|---|
id | string ID of the operation. |
description | string Description of the operation. 0-256 characters long. |
created_at | google.protobuf.Timestamp Creation timestamp. |
created_by | string ID of the user or service account who initiated the operation. |
modified_at | google.protobuf.Timestamp The time when the Operation resource was last modified. |
done | bool If the value is false , it means the operation is still in progress. If true , the operation is completed, and either error or response is available. |
metadata | google.protobuf.Any Service-specific metadata associated with the operation. It typically contains the ID of the target resource that the operation is performed on. Any method that returns a long-running operation should document the metadata type, if any. |
result | oneof: error or response The operation result. If done == false and there was no failure detected, neither error nor response is set. If done == false and there was a failure detected, error is set. If done == true , exactly one of error or response is set. |
error | google.rpc.Status The error result of the operation in case of failure or cancellation. |
response | google.protobuf.Any if operation finished successfully. |
CreatePXFDatasourceMetadata
Field | Description |
---|---|
cluster_id | string Required. The maximum string length in characters is 50. |
datasource_name | string Required. The string length in characters must be 3-200. |
PXFDatasource
Field | Description |
---|---|
name | string Required. The string length in characters must be 3-200. |
settings | oneof: s3 , jdbc , hdfs or hive |
s3 | PXFDatasourceS3 |
jdbc | PXFDatasourceJDBC |
hdfs | PXFDatasourceHDFS |
hive | PXFDatasourceHive |
Update
Update PXF datasource
rpc Update (UpdatePXFDatasourceRequest) returns (operation.Operation)
Metadata and response of Operation:
Operation.metadata:UpdatePXFDatasourceMetadata
Operation.response:PXFDatasource
UpdatePXFDatasourceRequest
Field | Description |
---|---|
cluster_id | string Required. The maximum string length in characters is 50. |
update_mask | google.protobuf.FieldMask |
datasource | PXFDatasource |
PXFDatasource
Field | Description |
---|---|
name | string Required. The string length in characters must be 3-200. |
settings | oneof: s3 , jdbc , hdfs or hive |
s3 | PXFDatasourceS3 |
jdbc | PXFDatasourceJDBC |
hdfs | PXFDatasourceHDFS |
hive | PXFDatasourceHive |
PXFDatasourceS3
Field | Description |
---|---|
access_key | string The maximum string length in characters is 200. |
secret_key | string The maximum string length in characters is 200. |
fast_upload | google.protobuf.BoolValue |
endpoint | string The maximum string length in characters is 200. |
PXFDatasourceJDBC
Field | Description |
---|---|
driver | string Matches jdbc.driver The maximum string length in characters is 50. |
url | string Matches jdbc.url The maximum string length in characters is 200. |
user | string Matches jdbc.user The maximum string length in characters is 200. |
password | string Matches jdbc.password The maximum string length in characters is 200. |
statement_batch_size | google.protobuf.Int64Value Matches jdbc.statement.batchsize Acceptable values are 50 to 1000, inclusive. |
statement_fetch_size | google.protobuf.Int64Value Matches jdbc.statement.fetchsize Acceptable values are 50 to 10000, inclusive. |
statement_query_timeout | google.protobuf.Int64Value Matches jdbc.statement.querytimeout Acceptable values are 5 to 600, inclusive. |
pool_enabled | google.protobuf.BoolValue Matches jdbc.pool.enabled |
pool_maximum_size | google.protobuf.Int64Value Matches jdbc.pool.property.maximumpoolsize Acceptable values are 10 to 200, inclusive. |
pool_connection_timeout | google.protobuf.Int64Value Matches jdbc.pool.property.connectiontimeout Acceptable values are 5000 to 600000, inclusive. |
pool_idle_timeout | google.protobuf.Int64Value Matches jdbc.pool.property.idletimeout Acceptable values are 5000 to 600000, inclusive. |
pool_minimum_idle | google.protobuf.Int64Value Matches jdbc.pool.property.minimumidle Acceptable values are 0 to 200, inclusive. |
PXFDatasourceHDFS
Field | Description |
---|---|
core | PXFDatasourceCore |
kerberos | PXFDatasourceKerberos |
user_impersonation | google.protobuf.BoolValue |
username | string The maximum string length in characters is 128. |
sasl_connection_retries | google.protobuf.Int64Value Acceptable values are 1 to 50, inclusive. |
zk_hosts[] | string The maximum number of elements is 200. The string length in characters for each value must be 1-200. |
dfs | PXFDatasourceHDFSDfs |
yarn | PXFDatasourceHDFSYarn |
PXFDatasourceCore
Field | Description |
---|---|
default_fs | string The maximum string length in characters is 200. |
security_auth_to_local | string The maximum string length in characters is 1000. |
PXFDatasourceKerberos
Field | Description |
---|---|
enable | google.protobuf.BoolValue |
primary | string The maximum string length in characters is 128. |
realm | string The maximum string length in characters is 1000. |
kdc_servers[] | string The maximum number of elements is 200. The string length in characters for each value must be 1-200. |
admin_server | string The maximum string length in characters is 128. |
default_domain | string The maximum string length in characters is 128. |
keytab_base64 | string Value must match the regular expression ^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=)?$ . The maximum string length in characters is 65536. |
PXFDatasourceHDFSDfs
Field | Description |
---|---|
ha_automatic_failover_enabled | google.protobuf.BoolValue |
block_access_token_enabled | google.protobuf.BoolValue |
use_datanode_hostname | google.protobuf.BoolValue |
namenodes | map<string,PXFDatasourceHDFSDfsNamenode> No more than 10000 per resource. |
PXFDatasourceHDFSYarn
Field | Description |
---|---|
resourcemanager_ha_enabled | google.protobuf.BoolValue |
resourcemanager_ha_auto_failover_enabled | google.protobuf.BoolValue |
resourcemanager_ha_auto_failover_embedded | google.protobuf.BoolValue |
resourcemanager_cluster_id | string The maximum string length in characters is 1000. |
ha_rm | map<string,PXFDatasourceHDFSYarnHaRm> No more than 10000 per resource. |
PXFDatasourceHive
Field | Description |
---|---|
core | PXFDatasourceCore |
kerberos | PXFDatasourceKerberos |
user_impersonation | google.protobuf.BoolValue |
username | string The maximum string length in characters is 128. |
sasl_connection_retries | google.protobuf.Int64Value Acceptable values are 1 to 50, inclusive. |
zk_hosts[] | string The maximum number of elements is 200. The string length in characters for each value must be 1-200. |
ppd | google.protobuf.BoolValue |
metastore_uris[] | string The maximum number of elements is 200. The string length in characters for each value must be 1-200. |
metastore_kerberos_principal | string The maximum string length in characters is 1000. |
auth_kerberos_principal | string The maximum string length in characters is 1000. |
Operation
Field | Description |
---|---|
id | string ID of the operation. |
description | string Description of the operation. 0-256 characters long. |
created_at | google.protobuf.Timestamp Creation timestamp. |
created_by | string ID of the user or service account who initiated the operation. |
modified_at | google.protobuf.Timestamp The time when the Operation resource was last modified. |
done | bool If the value is false , it means the operation is still in progress. If true , the operation is completed, and either error or response is available. |
metadata | google.protobuf.Any Service-specific metadata associated with the operation. It typically contains the ID of the target resource that the operation is performed on. Any method that returns a long-running operation should document the metadata type, if any. |
result | oneof: error or response The operation result. If done == false and there was no failure detected, neither error nor response is set. If done == false and there was a failure detected, error is set. If done == true , exactly one of error or response is set. |
error | google.rpc.Status The error result of the operation in case of failure or cancellation. |
response | google.protobuf.Any if operation finished successfully. |
UpdatePXFDatasourceMetadata
Field | Description |
---|---|
cluster_id | string Required. The maximum string length in characters is 50. |
datasource_name | string Required. The string length in characters must be 3-200. |
PXFDatasource
Field | Description |
---|---|
name | string Required. The string length in characters must be 3-200. |
settings | oneof: s3 , jdbc , hdfs or hive |
s3 | PXFDatasourceS3 |
jdbc | PXFDatasourceJDBC |
hdfs | PXFDatasourceHDFS |
hive | PXFDatasourceHive |
Delete
Delete PXF datasource
rpc Delete (DeletePXFDatasourceRequest) returns (operation.Operation)
Metadata and response of Operation:
Operation.metadata:DeletePXFDatasourceMetadata
Operation.response:google.protobuf.Empty
DeletePXFDatasourceRequest
Field | Description |
---|---|
cluster_id | string Required. The maximum string length in characters is 50. |
datasource_name | string Required. The string length in characters must be 3-200. |
Operation
Field | Description |
---|---|
id | string ID of the operation. |
description | string Description of the operation. 0-256 characters long. |
created_at | google.protobuf.Timestamp Creation timestamp. |
created_by | string ID of the user or service account who initiated the operation. |
modified_at | google.protobuf.Timestamp The time when the Operation resource was last modified. |
done | bool If the value is false , it means the operation is still in progress. If true , the operation is completed, and either error or response is available. |
metadata | google.protobuf.Any Service-specific metadata associated with the operation. It typically contains the ID of the target resource that the operation is performed on. Any method that returns a long-running operation should document the metadata type, if any. |
result | oneof: error or response The operation result. If done == false and there was no failure detected, neither error nor response is set. If done == false and there was a failure detected, error is set. If done == true , exactly one of error or response is set. |
error | google.rpc.Status The error result of the operation in case of failure or cancellation. |
response | google.protobuf.Any if operation finished successfully. |
DeletePXFDatasourceMetadata
Field | Description |
---|---|
cluster_id | string Required. The maximum string length in characters is 50. |
datasource_name | string Required. The string length in characters must be 3-200. |