| Field | Type | Label | Description |
| role_arn | string | Prioritized over id/secret. |
|
| client_id_arn | string |
|
|
| client_secret | string |
|
|
| location | Location |
|
| Field | Type | Label | Description |
| service_account | bytes |
|
|
| location | Location |
|
| Field | Type | Label | Description |
| active_zone | string | If set, prioritize over active region. |
|
| active_region | string | Valid only when active zone is not set. |
|
| passive_zone | string | If set, prioritize over passive region. |
|
| passive_region | string | Valid only when passive zone is not set. |
This resource represents a long-running operation that is the result of a
network API call.
| Field | Type | Label | Description |
| name | string | The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`. |
|
| metadata | google.protobuf.Any | Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any. |
|
| 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. |
|
| error | google.rpc.Status | The error result of the operation in case of failure or cancellation. |
|
| response | google.protobuf.Any | The normal response of the operation in case of success. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`. |
Request message for the Login rpc.
| Field | Type | Label | Description |
| access_token | string | Optional. If set, use to call user profile. |
|
| id | string |
|
|
| password | string |
|
|
| device_auth | string | Optional. If non-empty, do a device auth flow. |
Response message for the Login rpc.
| Field | Type | Label | Description |
| device_auth | LoginResponse.DeviceAuth |
|
|
| access_token | string |
|
|
| status | google.rpc.Status |
|
| Field | Type | Label | Description |
| user_code | string |
|
|
| verification_uri_complete | string |
|
|
| expires_in | int64 |
|
Request message for the WhoAmI rpc.
| Field | Type | Label | Description |
| access_token | string |
|
Request message for the WhoAmI rpc.
| Field | Type | Label | Description |
| id | string |
|
|
| name | string |
|
|
| string |
|
Iam service definition.
| Method Name | Request Type | Response Type | Description |
| Login | LoginRequest | LoginResponse stream | Create an account for the Vortex Platform. |
| WhoAmI | WhoAmIRequest | WhoAmIResponse | Testing endpoint. |
| Method Name | Method | Pattern | Body |
| Login | POST | /vortex/iam/v1/login | * |
| WhoAmI | GET | /vortex/iam/v1/whoami |
Request message for the CreateEnvironment rpc.
| Field | Type | Label | Description |
| name | string |
|
|
| profile | string | Valid values: SC_MR_GCP SC_SR_GCP SC_MR_AWS SC_SR_AWS MC_AUTO |
|
| gcp_info | vortexproto.types.GCPInfo |
|
|
| aws_info | vortexproto.types.AWSInfo |
|
|
| azure_info | vortexproto.types.AzureInfo | TBD. |
Response message for the CreateEnvironment rpc.
| Field | Type | Label | Description |
| name | string |
|
|
| operation | vortexproto.types.Operation |
|
Request message for the DeleteEnvironment rpc.
| Field | Type | Label | Description |
| name | string |
|
Response message for the DeleteEnvironment rpc.
| Field | Type | Label | Description |
| name | string |
|
Request message for the Do rpc.
| Field | Type | Label | Description |
| data | string |
|
Response message for the Do rpc.
| Field | Type | Label | Description |
| data | string |
|
Request message for the GetEnvironment rpc.
| Field | Type | Label | Description |
| name | string |
|
Response message for the GetEnvironment rpc.
| Field | Type | Label | Description |
| name | string |
|
Request message for the ListEnvironments rpc.
| Field | Type | Label | Description |
| name | string |
|
Response message for the ListEnvironments rpc.
| Field | Type | Label | Description |
| name | string |
|
Vortex service definition.
| Method Name | Request Type | Response Type | Description |
| CreateEnvironment | CreateEnvironmentRequest | CreateEnvironmentResponse | Create a deployment environment. |
| GetEnvironment | GetEnvironmentRequest | GetEnvironmentResponse | Describe a deployment environment. |
| ListEnvironments | ListEnvironmentsRequest | ListEnvironmentsResponse | List deployment environments. |
| DeleteEnvironment | DeleteEnvironmentRequest | DeleteEnvironmentResponse | Delete a deployment environment. |
| Do | DoRequest | DoResponse | Testing endpoint. |
| Method Name | Method | Pattern | Body |
| CreateEnvironment | POST | /vortex/v1/envs | * |
| GetEnvironment | GET | /vortex/v1/envs/{name} | |
| ListEnvironments | GET | /vortex/v1/envs | |
| DeleteEnvironment | DELETE | /vortex/v1/envs/{name} | |
| Do | POST | /vortex/v1:do | * |
Request message for the CancelOperation rpc.
| Field | Type | Label | Description |
| name | string |
|
Request message for the DeleteOperation rpc.
| Field | Type | Label | Description |
| name | string |
|
Request message for the GetOperation rpc.
| Field | Type | Label | Description |
| name | string |
|
Request message for the ListOperations rpc.
| Field | Type | Label | Description |
| name | string |
|
|
| next_token | string |
|
Response message for the ListOperations rpc.
| Field | Type | Label | Description |
| operations | vortexproto.types.Operation | repeated |
|
| next_token | string |
|
Request message for the WaitOperation rpc.
| Field | Type | Label | Description |
| name | string |
|
Operations service definition.
| Method Name | Request Type | Response Type | Description |
| ListOperations | ListOperationsRequest | ListOperationsResponse | List long-running operations. |
| GetOperation | GetOperationRequest | .vortexproto.types.Operation | Get a long-running operation. |
| DeleteOperation | DeleteOperationRequest | .google.protobuf.Empty | Delete a long-running operation. |
| CancelOperation | CancelOperationRequest | .google.protobuf.Empty | Cancel a long-running operation. |
| WaitOperation | WaitOperationRequest | .vortexproto.types.Operation | Wait on a long-running operation. |
| Method Name | Method | Pattern | Body |
| ListOperations | GET | /vortex/ops/v1 | |
| GetOperation | GET | /vortex/ops/v1/{name} | |
| DeleteOperation | DELETE | /vortex/ops/v1/{name} | |
| CancelOperation | POST | /vortex/ops/v1/{name}:cancel | * |
| .proto Type | Notes | C++ | Java | Python | Go | C# | PHP | Ruby |
| double | double | double | float | float64 | double | float | Float | |
| float | float | float | float | float32 | float | float | Float | |
| int32 | Uses variable-length encoding. Inefficient for encoding negative numbers – if your field is likely to have negative values, use sint32 instead. | int32 | int | int | int32 | int | integer | Bignum or Fixnum (as required) |
| int64 | Uses variable-length encoding. Inefficient for encoding negative numbers – if your field is likely to have negative values, use sint64 instead. | int64 | long | int/long | int64 | long | integer/string | Bignum |
| uint32 | Uses variable-length encoding. | uint32 | int | int/long | uint32 | uint | integer | Bignum or Fixnum (as required) |
| uint64 | Uses variable-length encoding. | uint64 | long | int/long | uint64 | ulong | integer/string | Bignum or Fixnum (as required) |
| sint32 | Uses variable-length encoding. Signed int value. These more efficiently encode negative numbers than regular int32s. | int32 | int | int | int32 | int | integer | Bignum or Fixnum (as required) |
| sint64 | Uses variable-length encoding. Signed int value. These more efficiently encode negative numbers than regular int64s. | int64 | long | int/long | int64 | long | integer/string | Bignum |
| fixed32 | Always four bytes. More efficient than uint32 if values are often greater than 2^28. | uint32 | int | int | uint32 | uint | integer | Bignum or Fixnum (as required) |
| fixed64 | Always eight bytes. More efficient than uint64 if values are often greater than 2^56. | uint64 | long | int/long | uint64 | ulong | integer/string | Bignum |
| sfixed32 | Always four bytes. | int32 | int | int | int32 | int | integer | Bignum or Fixnum (as required) |
| sfixed64 | Always eight bytes. | int64 | long | int/long | int64 | long | integer/string | Bignum |
| bool | bool | boolean | boolean | bool | bool | boolean | TrueClass/FalseClass | |
| string | A string must always contain UTF-8 encoded or 7-bit ASCII text. | string | String | str/unicode | string | string | string | String (UTF-8) |
| bytes | May contain any arbitrary sequence of bytes. | string | ByteString | str | []byte | ByteString | string | String (ASCII-8BIT) |