Managed Service for Greenplum® API, gRPC: HBARuleService
A set of methods for managing Greenplum clusters.
Call | Description |
---|---|
List | Retrieves a list of HBA rules for Greenplum clusters. |
ListAtRevision | Retrieves a list of HBA rules for Greenplum clusters for particular revision. |
Create | Create single HBA rule for the specified Greenplum cluster to the end of HBA rules list. |
Update | Update specified HBA rule for the specified Greenplum cluster without changind it order. |
Delete | Delete specified HBA rule for the specified Greenplum cluster. |
BatchUpdate | Modifies all HBA rules for the specified Greenplum cluster. |
Calls HBARuleService
List
Retrieves a list of HBA rules for Greenplum clusters.
rpc List (ListHBARulesRequest) returns (ListHBARulesResponse)
ListHBARulesRequest
Field | Description |
---|---|
cluster_id | string Required. ID of the Greenplum cluster. To get the Greenplum cluster ID use a ClusterService.List request. The maximum string length in characters is 50. |
ListHBARulesResponse
Field | Description |
---|---|
hba_rules[] | HBARule Requested list of hba rules for the cluster. |
HBARule
Field | Description |
---|---|
priority | int64 Priority of the Greenplum cluster rule. Acceptable values are 0 to 1000, inclusive. |
connection_type | enum ConnectionType
|
database | string Required. Specifies which database names this record matches. |
user | string Required. Specifies which database role names this user matches. |
address | string Required. Specifies the client machine addresses that this record matches. |
auth_method | enum AuthMethod Specifies the authentication method to use when a connection matches this record. https://gpdb.docs.pivotal.io/6-6/security-guide/topics/Authenticate.html
|
ListAtRevision
Retrieves a list of HBA rules for Greenplum clusters for particular revision.
rpc ListAtRevision (ListHBARulesAtRevisionRequest) returns (ListHBARulesResponse)
ListHBARulesAtRevisionRequest
Field | Description |
---|---|
cluster_id | string Required. ID of the Greenplum cluster. To get the Greenplum cluster ID use a ClusterService.List request. The maximum string length in characters is 50. |
revision | int64 Cluster revision Value must be greater than 0. |
ListHBARulesResponse
Field | Description |
---|---|
hba_rules[] | HBARule Requested list of hba rules for the cluster. |
HBARule
Field | Description |
---|---|
priority | int64 Priority of the Greenplum cluster rule. Acceptable values are 0 to 1000, inclusive. |
connection_type | enum ConnectionType
|
database | string Required. Specifies which database names this record matches. |
user | string Required. Specifies which database role names this user matches. |
address | string Required. Specifies the client machine addresses that this record matches. |
auth_method | enum AuthMethod Specifies the authentication method to use when a connection matches this record. https://gpdb.docs.pivotal.io/6-6/security-guide/topics/Authenticate.html
|
Create
Create single HBA rule for the specified Greenplum cluster to the end of HBA rules list.
rpc Create (CreateHBARuleRequest) returns (operation.Operation)
Metadata and response of Operation:
Operation.metadata:HBARulesMetadata
Operation.response:google.protobuf.Empty
CreateHBARuleRequest
Field | Description |
---|---|
cluster_id | string Required. ID of the Greenplum cluster. To get the Greenplum cluster ID use a ClusterService.List request. The maximum string length in characters is 50. |
hba_rule | HBARule Required. New hba rule for the cluster. |
HBARule
Field | Description |
---|---|
priority | int64 Priority of the Greenplum cluster rule. Acceptable values are 0 to 1000, inclusive. |
connection_type | enum ConnectionType
|
database | string Required. Specifies which database names this record matches. |
user | string Required. Specifies which database role names this user matches. |
address | string Required. Specifies the client machine addresses that this record matches. |
auth_method | enum AuthMethod Specifies the authentication method to use when a connection matches this record. https://gpdb.docs.pivotal.io/6-6/security-guide/topics/Authenticate.html
|
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. |
HBARulesMetadata
Field | Description |
---|---|
cluster_id | string ID of the Greenplum cluster which HBA rules was affected. |
Update
Update specified HBA rule for the specified Greenplum cluster without changind it order.
rpc Update (UpdateHBARuleRequest) returns (operation.Operation)
Metadata and response of Operation:
Operation.metadata:HBARulesMetadata
Operation.response:google.protobuf.Empty
UpdateHBARuleRequest
Field | Description |
---|---|
cluster_id | string Required. ID of the Greenplum cluster. To get the Greenplum cluster ID use a ClusterService.List request. The maximum string length in characters is 50. |
hba_rule | HBARule Required. Updated hba rule for the cluster. |
HBARule
Field | Description |
---|---|
priority | int64 Priority of the Greenplum cluster rule. Acceptable values are 0 to 1000, inclusive. |
connection_type | enum ConnectionType
|
database | string Required. Specifies which database names this record matches. |
user | string Required. Specifies which database role names this user matches. |
address | string Required. Specifies the client machine addresses that this record matches. |
auth_method | enum AuthMethod Specifies the authentication method to use when a connection matches this record. https://gpdb.docs.pivotal.io/6-6/security-guide/topics/Authenticate.html
|
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. |
HBARulesMetadata
Field | Description |
---|---|
cluster_id | string ID of the Greenplum cluster which HBA rules was affected. |
Delete
Delete specified HBA rule for the specified Greenplum cluster.
rpc Delete (DeleteHBARuleRequest) returns (operation.Operation)
Metadata and response of Operation:
Operation.metadata:HBARulesMetadata
Operation.response:google.protobuf.Empty
DeleteHBARuleRequest
Field | Description |
---|---|
cluster_id | string Required. ID of the Greenplum cluster. To get the Greenplum cluster ID use a ClusterService.List request. The maximum string length in characters is 50. |
priority | int64 Priority of the Greenplum cluster rule. Acceptable values are 0 to 1000, inclusive. |
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. |
HBARulesMetadata
Field | Description |
---|---|
cluster_id | string ID of the Greenplum cluster which HBA rules was affected. |
BatchUpdate
Modifies all HBA rules for the specified Greenplum cluster.
rpc BatchUpdate (BatchUpdateHBARulesRequest) returns (operation.Operation)
Metadata and response of Operation:
Operation.metadata:HBARulesMetadata
Operation.response:google.protobuf.Empty
BatchUpdateHBARulesRequest
Field | Description |
---|---|
cluster_id | string Required. ID of the Greenplum cluster. To get the Greenplum cluster ID use a ClusterService.List request. The maximum string length in characters is 50. |
hba_rules[] | HBARule List of new hba rules for the cluster. The number of elements must be greater than 0. |
HBARule
Field | Description |
---|---|
priority | int64 Priority of the Greenplum cluster rule. Acceptable values are 0 to 1000, inclusive. |
connection_type | enum ConnectionType
|
database | string Required. Specifies which database names this record matches. |
user | string Required. Specifies which database role names this user matches. |
address | string Required. Specifies the client machine addresses that this record matches. |
auth_method | enum AuthMethod Specifies the authentication method to use when a connection matches this record. https://gpdb.docs.pivotal.io/6-6/security-guide/topics/Authenticate.html
|
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. |
HBARulesMetadata
Field | Description |
---|---|
cluster_id | string ID of the Greenplum cluster which HBA rules was affected. |