[go: up one dir, main page]

Crate google_cloud_wkt

Source
Expand description

Well-known-types for Google Cloud APIs.

WARNING: this crate is under active development. We expect multiple breaking changes in the upcoming releases. Testing is also incomplete, we do not recommend that you use this crate in production. We welcome feedback about the APIs, documentation, missing features, bugs, etc.

Google Cloud APIs use a number of well-known types. These typically have custom JSON encoding, and may provide conversion functions to and from native or commonly used Rust types.

Modules§

descriptor_proto
Defines additional types related to DescriptorProto.
enum_descriptor_proto
Defines additional types related to EnumDescriptorProto.
extension_range_options
Defines additional types related to ExtensionRangeOptions.
feature_set
Defines additional types related to FeatureSet.
feature_set_defaults
Defines additional types related to FeatureSetDefaults.
field
Defines additional types related to Field.
field_descriptor_proto
Defines additional types related to FieldDescriptorProto.
field_options
Defines additional types related to FieldOptions.
file_options
Defines additional types related to FileOptions.
generated_code_info
Defines additional types related to GeneratedCodeInfo.
message
Define traits required of all messages.
method_options
Defines additional types related to MethodOptions.
source_code_info
Defines additional types related to SourceCodeInfo.
uninterpreted_option
Defines additional types related to UninterpretedOption.

Structs§

Any
Any contains an arbitrary serialized protocol buffer message along with a URL that describes the type of the serialized message.
Api
Api is a light-weight descriptor for an API Interface.
DescriptorProto
Describes a message type.
Duration
Well-known duration representation for Google APIs.
Empty
A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance:
Enum
Enum type definition.
EnumDescriptorProto
Describes an enum type.
EnumOptions
EnumValue
Enum value definition.
EnumValueDescriptorProto
Describes a value within an enum.
EnumValueOptions
ExtensionRangeOptions
FeatureSet
TODO Enums in C++ gencode (and potentially other languages) are not well scoped. This means that each of the feature enums below can clash with each other. The short names we’ve chosen maximize call-site readability, but leave us very open to this scenario. A future feature will be designed and implemented to handle this, hopefully before we ever hit a conflict here.
FeatureSetDefaults
A compiled specification for the defaults of a set of features. These messages are generated from FeatureSet extensions and can be used to seed feature resolution. The resolution with this object becomes a simple search for the closest matching edition, followed by proto merges.
Field
A single field of a message type.
FieldDescriptorProto
Describes a field within a message.
FieldMask
FieldMask represents a set of symbolic field paths.
FieldOptions
FileDescriptorProto
Describes a complete .proto file.
FileDescriptorSet
The protocol compiler can output a FileDescriptorSet containing the .proto files it parses.
FileOptions
GeneratedCodeInfo
Describes the relationship between generated code and its original source file. A GeneratedCodeInfo message is associated with only one generated source file, but may contain references to different source .proto files.
MessageOptions
Method
Method represents a method of an API interface.
MethodDescriptorProto
Describes a method of a service.
MethodOptions
Mixin
Declares an API Interface to be included in this interface. The including interface must redeclare all the methods from the included interface, but documentation and options are inherited as follows:
NullValue
The Google Cloud APIs use google.protobuf.NullValue to represent JSON null values.
OneofDescriptorProto
Describes a oneof.
OneofOptions
Option
A protocol buffer option, which can be attached to a message, field, enumeration, etc.
ServiceDescriptorProto
Describes a service.
ServiceOptions
SourceCodeInfo
Encapsulates information about the original source file from which a FileDescriptorProto was generated.
SourceContext
SourceContext represents information about the source of a protobuf element, like the file in which it is defined.
Timestamp
Well-known point in time representation for Google APIs.
Type
A protocol buffer message type.
UninterpretedOption
A message representing a option the parser does not recognize. This only appears in options protos created by the compiler::Parser class. DescriptorPool resolves these when building Descriptor objects. Therefore, options protos in descriptor objects (e.g. returned by Descriptor::options(), or produced by Descriptor::CopyTo()) will never have UninterpretedOptions in them.

Enums§

AnyError
Indicates a problem trying to use an Any.
DurationError
Represent failures in converting or creating Duration instances.
Edition
The full set of known editions.
Syntax
The syntax in which a protocol buffer element is defined.
TimestampError
Represent failures in converting or creating Timestamp instances.

Type Aliases§

BoolValue
Implements the google.cloud.BoolValue well-known type.
BytesValue
Implements the google.cloud.BytesValue well-known type.
DoubleValue
Implements the google.cloud.DoubleValue well-known type.
FloatValue
Implements the google.cloud.FloatValue well-known type.
Int32Value
Implements the google.cloud.Int32Value well-known type.
Int64Value
Implements the google.cloud.Int64Value well-known type.
ListValue
The Google Cloud APIs use google.protobuf.ListValue to represent JSON to represent lists of JSON values.
StringValue
Implements the google.cloud.StringValue well-known type.
Struct
The Google Cloud APIs use google.protobuf.Struct to represent JSON objects.
UInt32Value
Implements the google.cloud.UInt32Value well-known type.
UInt64Value
Implements the google.cloud.UInt64Value well-known type.
Value
The Google Cloud APIs use google.protobuf.Value to represent JSON values, including objects, lists, and scalars.