HashiCorp Cloud Platform
You are viewing documentation for version 2020-04-20. View latest version.
/snapshots
CreateSnapshot
https:/Link is used to uniquely reference any resource within HashiCorp Cloud. This can be conceptually considered a "foreign key".
Operation represents a single operation.
State is one of the states that an Operation can be in.
The states are purposely coarse grained to make it easy to understand the operation state machine: pending => running => done. Or pending => queued => running => done. No other state transitions are possible. Success/failure can be determined based on the result oneof.
The Status message contains three pieces of data: error code, error
message, and error details. The error code should be an enum value of
[google.rpc.Code][google.rpc.Code], but it may accept additional error codes
if needed. The error message should be a developer-facing English message
that helps developers understand and resolve the error. If a localized
user-facing error message is needed, put the localized message in the error
details or localize it in the client. The optional error details may contain
arbitrary information about the error. There is a predefined set of error
detail types in the package google.rpc that can be used for common error
conditions.
The Status message is the logical representation of the error model, but it
is not necessarily the actual wire format. When the Status message is
exposed in different client libraries and different wire protocols, it can be
mapped differently. For example, it will likely be mapped to some exceptions
in Java, but more likely mapped to some error codes in C.
The error model and the Status message can be used in a variety of
environments, either with or without APIs, to provide a
consistent developer experience across different environments.
Example uses of this error model include:
Partial errors. If a service needs to return partial errors to the client,
it may embed the Status in the normal response to indicate the partial
errors.
Workflow errors. A typical workflow has multiple steps. Each step may
have a Status message for error reporting.
Batch operations. If a client uses batch request and batch response, the
Status message should be used directly inside batch response, one for
each error sub-response.
Asynchronous operations. If an API call embeds asynchronous operation
results in its response, the status of those operations should be
represented directly using the Status message.
Logging. If some API errors are stored in logs, the message Status could
be used directly after any stripping needed for security/privacy reasons.
An arbitrary serialized message. Visit the protobufAny documentation for more information.
A URL/resource name that uniquely identifies the type of the serialized
protocol buffer message. This string must contain at least
one "/" character. The last segment of the URL's path must represent
the fully qualified name of the type (as in
path/google.protobuf.Duration). The name should be in a canonical form
(e.g., leading "." is not accepted).
In practice, teams usually precompile into the binary all types that they
expect it to use in the context of Any. However, for URLs which use the
scheme http, https, or no scheme, one can optionally set up a type
server that maps type URLs to message definitions as follows:
https is assumed.Note: this functionality is not currently available in the official protobuf release, and it is not used for type URLs beginning with type.googleapis.com.
Schemes other than http, https (or the empty scheme) might be
used with implementation specific semantics.
An arbitrary serialized message. Visit the protobufAny documentation for more information.
A URL/resource name that uniquely identifies the type of the serialized
protocol buffer message. This string must contain at least
one "/" character. The last segment of the URL's path must represent
the fully qualified name of the type (as in
path/google.protobuf.Duration). The name should be in a canonical form
(e.g., leading "." is not accepted).
In practice, teams usually precompile into the binary all types that they
expect it to use in the context of Any. However, for URLs which use the
scheme http, https, or no scheme, one can optionally set up a type
server that maps type URLs to message definitions as follows:
https is assumed.Note: this functionality is not currently available in the official protobuf release, and it is not used for type URLs beginning with type.googleapis.com.
Schemes other than http, https (or the empty scheme) might be
used with implementation specific semantics.
Link is used to uniquely reference any resource within HashiCorp Cloud. This can be conceptually considered a "foreign key".
An arbitrary serialized message. Visit the protobufAny documentation for more information.
A URL/resource name that uniquely identifies the type of the serialized
protocol buffer message. This string must contain at least
one "/" character. The last segment of the URL's path must represent
the fully qualified name of the type (as in
path/google.protobuf.Duration). The name should be in a canonical form
(e.g., leading "." is not accepted).
In practice, teams usually precompile into the binary all types that they
expect it to use in the context of Any. However, for URLs which use the
scheme http, https, or no scheme, one can optionally set up a type
server that maps type URLs to message definitions as follows:
https is assumed.Note: this functionality is not currently available in the official protobuf release, and it is not used for type URLs beginning with type.googleapis.com.
Schemes other than http, https (or the empty scheme) might be
used with implementation specific semantics.