types

package module
v1.32.0 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Feb 13, 2025 License: Apache-2.0 Imports: 7 Imported by: 0

README

types

This Go module is a set of common types represented as Google Protocol Buffers.

Status

ci Go GitHub issues GitHub last commit

Usage

To use this module, execute the following command:

go get -u github.com/sixafter/types

In your Go code, you can import the module as follows.

package main

import (
    "github.com/sixafter/types"
)

The use of Go vendoring is RECOMMENDED.

Contributing

Contributions are welcome. See CONTRIBUTING

License

This project is licensed under the Apache 2.0 License. See LICENSE file.

Documentation

Index

Constants

This section is empty.

Variables

View Source 
var (
	GeospatialElevation_GeodeticDatum_name = map[int32]string{
		0: "SEA_LEVEL",
		1: "WGS_84",
	}
	GeospatialElevation_GeodeticDatum_value = map[string]int32{
		"SEA_LEVEL": 0,
		"WGS_84":    1,
	}
)

Enum value maps for GeospatialElevation_GeodeticDatum.

View Source 
var File_compass_heading_proto protoreflect.FileDescriptor
View Source 
var File_country_proto protoreflect.FileDescriptor
View Source 
var File_country_subdivision_proto protoreflect.FileDescriptor
View Source 
var File_email_address_proto protoreflect.FileDescriptor
View Source 
var File_entity_metadata_proto protoreflect.FileDescriptor
View Source 
var File_geofence_proto protoreflect.FileDescriptor
View Source 
var File_geographic_region_proto protoreflect.FileDescriptor
View Source 
var File_geometry_proto protoreflect.FileDescriptor
View Source 
var File_geospatial_coordinate_proto protoreflect.FileDescriptor
View Source 
var File_geospatial_elevation_proto protoreflect.FileDescriptor
View Source 
var File_geospatial_location_proto protoreflect.FileDescriptor
View Source 
var File_map_point_proto protoreflect.FileDescriptor
View Source 
var File_map_polygon_proto protoreflect.FileDescriptor
View Source 
var File_radial_geofence_proto protoreflect.FileDescriptor
View Source 
var File_temporal_range_proto protoreflect.FileDescriptor
View Source 
var File_time_zone_proto protoreflect.FileDescriptor
View Source 
var File_uri_proto protoreflect.FileDescriptor
View Source 
var File_url_proto protoreflect.FileDescriptor
View Source 
var File_version_proto protoreflect.FileDescriptor

Functions

This section is empty.

Types

type CompassHeading 

type CompassHeading struct {

	// The heading (measured in degrees) relative to magnetic north.
	// Values range from 0 to 360, where 0 indicates north, 90 indicates east,
	// 180 indicates south, and 270 indicates west.
	MagneticHeading float32 `protobuf:"fixed32,1,opt,name=magnetic_heading,json=magneticHeading,proto3" json:"magnetic_heading,omitempty"`
	// The heading (measured in degrees) relative to true north.
	// This compensates for the local magnetic declination.
	// Similar to `magnetic_heading`, values range from 0 to 360.
	TrueHeading float32 `protobuf:"fixed32,2,opt,name=true_heading,json=trueHeading,proto3" json:"true_heading,omitempty"`
	// The maximum deviation (measured in degrees) between the reported heading
	// and the true geomagnetic heading. A lower value indicates higher accuracy.
	// This property is essential for assessing the reliability of the heading data.
	HeadingAccuracy float32 `protobuf:"fixed32,3,opt,name=heading_accuracy,json=headingAccuracy,proto3" json:"heading_accuracy,omitempty"`
	// The time at which this heading measurement was taken.
	// This is useful for correlating heading data with other time-based
	// measurements or events.
	Timestamp *timestamppb.Timestamp `protobuf:"bytes,4,opt,name=timestamp,proto3" json:"timestamp,omitempty"`
	// The geomagnetic field strength (measured in microteslas) along the x-axis.
	// This represents the horizontal magnetic component and can be used to derive
	// the magnetic field vector in combination with `y` and `z`.
	X float32 `protobuf:"fixed32,5,opt,name=x,proto3" json:"x,omitempty"`
	// The geomagnetic field strength (measured in microteslas) along the y-axis.
	// This represents the horizontal magnetic component perpendicular to the `x`-axis.
	Y float32 `protobuf:"fixed32,6,opt,name=y,proto3" json:"y,omitempty"`
	// The geomagnetic field strength (measured in microteslas) along the z-axis.
	// This represents the vertical magnetic component and is crucial for
	// determining the three-dimensional magnetic vector.
	Z float32 `protobuf:"fixed32,7,opt,name=z,proto3" json:"z,omitempty"`
	// contains filtered or unexported fields
}

The `CompassHeading` message represents the orientation of an object in the Compass Geodetic System (CGS). This can be used in geolocation systems, navigation tools, or applications requiring orientation data.

func (*CompassHeading) Descriptor deprecated 

func (*CompassHeading) Descriptor() ([]byte, []int)

Deprecated: Use CompassHeading.ProtoReflect.Descriptor instead.

func (*CompassHeading) GetHeadingAccuracy 

func (x *CompassHeading) GetHeadingAccuracy() float32

func (*CompassHeading) GetMagneticHeading 

func (x *CompassHeading) GetMagneticHeading() float32

func (*CompassHeading) GetTimestamp 

func (x *CompassHeading) GetTimestamp() *timestamppb.Timestamp

func (*CompassHeading) GetTrueHeading 

func (x *CompassHeading) GetTrueHeading() float32

func (*CompassHeading) GetX 

func (x *CompassHeading) GetX() float32

func (*CompassHeading) GetY 

func (x *CompassHeading) GetY() float32

func (*CompassHeading) GetZ 

func (x *CompassHeading) GetZ() float32

func (*CompassHeading) ProtoMessage 

func (*CompassHeading) ProtoMessage()

func (*CompassHeading) ProtoReflect 

func (x *CompassHeading) ProtoReflect() protoreflect.Message

func (*CompassHeading) Reset 

func (x *CompassHeading) Reset()

func (*CompassHeading) String 

func (x *CompassHeading) String() string

type Coordinate added in v1.24.0 

type Coordinate struct {

	// The n-dimensional coordinate values.
	Values []*Scalar `protobuf:"bytes,1,rep,name=values,proto3" json:"values,omitempty"`
	// The geometry type (e.g., Euclidean, Hyperbolic).
	GeometryType *GeometryType `protobuf:"bytes,2,opt,name=geometry_type,json=geometryType,proto3" json:"geometry_type,omitempty"`
	// The coordinate system (e.g., Cartesian, Polar).
	CoordinateSystem *CoordinateSystem `protobuf:"bytes,3,opt,name=coordinate_system,json=coordinateSystem,proto3" json:"coordinate_system,omitempty"`
	// contains filtered or unexported fields
}

Represents a coordinate in an n-dimensional space. The coordinate is defined within a specified geometry and coordinate system, using fixed-point numbers for precision.

Examples:

  • A 2D Cartesian coordinate (3.5, -2.1) in Euclidean geometry: geometry_type = EUCLIDEAN coordinate_system = EUCLIDEAN_CARTESIAN values = [{unscaled_value: 35, scale: 1}, {unscaled_value: -21, scale: 1}]

func (*Coordinate) Descriptor deprecated added in v1.24.0 

func (*Coordinate) Descriptor() ([]byte, []int)

Deprecated: Use Coordinate.ProtoReflect.Descriptor instead.

func (*Coordinate) GetCoordinateSystem added in v1.24.0 

func (x *Coordinate) GetCoordinateSystem() *CoordinateSystem

func (*Coordinate) GetGeometryType added in v1.24.0 

func (x *Coordinate) GetGeometryType() *GeometryType

func (*Coordinate) GetValues added in v1.24.0 

func (x *Coordinate) GetValues() []*Scalar

func (*Coordinate) ProtoMessage added in v1.24.0 

func (*Coordinate) ProtoMessage()

func (*Coordinate) ProtoReflect added in v1.24.0 

func (x *Coordinate) ProtoReflect() protoreflect.Message

func (*Coordinate) Reset added in v1.24.0 

func (x *Coordinate) Reset()

func (*Coordinate) String added in v1.24.0 

func (x *Coordinate) String() string

type CoordinateSystem added in v1.24.0 

type CoordinateSystem struct {

	// The name of the coordinate system (e.g., Cartesian, Polar).
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	// Optional parameters defining the coordinate system (e.g., dimensionality, radius for polar systems).
	Parameters map[string]string `` /* 147-byte string literal not displayed */
	// contains filtered or unexported fields
}

Represents a coordinate system used to interpret geometric entities. Example: Cartesian, Polar, Spherical, Homogeneous.

func (*CoordinateSystem) Descriptor deprecated added in v1.24.0 

func (*CoordinateSystem) Descriptor() ([]byte, []int)

Deprecated: Use CoordinateSystem.ProtoReflect.Descriptor instead.

func (*CoordinateSystem) GetName added in v1.24.0 

func (x *CoordinateSystem) GetName() string

func (*CoordinateSystem) GetParameters added in v1.24.0 

func (x *CoordinateSystem) GetParameters() map[string]string

func (*CoordinateSystem) ProtoMessage added in v1.24.0 

func (*CoordinateSystem) ProtoMessage()

func (*CoordinateSystem) ProtoReflect added in v1.24.0 

func (x *CoordinateSystem) ProtoReflect() protoreflect.Message

func (*CoordinateSystem) Reset added in v1.24.0 

func (x *CoordinateSystem) Reset()

func (*CoordinateSystem) String added in v1.24.0 

func (x *CoordinateSystem) String() string

type Country 

type Country struct {

	// The commonly used name of the country.
	// Example: "United States".
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	// The formal or official name of the country.
	// Example: "United States of America".
	FormalName string `protobuf:"bytes,2,opt,name=formal_name,json=formalName,proto3" json:"formal_name,omitempty"`
	// The ISO 3166-1 alpha-2 code for the country.
	// This is a two-letter country code commonly used in international standards and systems.
	// Example: "US" for the United States.
	AlphabeticCode_2 string `protobuf:"bytes,3,opt,name=alphabetic_code_2,json=alphabeticCode2,proto3" json:"alphabetic_code_2,omitempty"`
	// The ISO 3166-1 alpha-3 code for the country.
	// This is a three-letter country code that offers more specificity than the alpha-2 code.
	// Example: "USA" for the United States.
	AlphabeticCode_3 string `protobuf:"bytes,4,opt,name=alphabetic_code_3,json=alphabeticCode3,proto3" json:"alphabetic_code_3,omitempty"`
	// The ISO 3166-1 numeric code for the country.
	// This is a three-digit code that is language-neutral and often used in databases or systems
	// where numeric identifiers are preferred.
	// Example: 840 for the United States.
	NumericCode uint32 `protobuf:"varint,5,opt,name=numeric_code,json=numericCode,proto3" json:"numeric_code,omitempty"`
	// contains filtered or unexported fields
}

The `Country` message represents a country as defined by the ISO-3166-1 standard. It is commonly used for internationalization, geolocation, and regulatory purposes.

func (*Country) Descriptor deprecated 

func (*Country) Descriptor() ([]byte, []int)

Deprecated: Use Country.ProtoReflect.Descriptor instead.

func (*Country) GetAlphabeticCode_2 

func (x *Country) GetAlphabeticCode_2() string

func (*Country) GetAlphabeticCode_3 

func (x *Country) GetAlphabeticCode_3() string

func (*Country) GetFormalName 

func (x *Country) GetFormalName() string

func (*Country) GetName 

func (x *Country) GetName() string

func (*Country) GetNumericCode 

func (x *Country) GetNumericCode() uint32

func (*Country) ProtoMessage 

func (*Country) ProtoMessage()

func (*Country) ProtoReflect 

func (x *Country) ProtoReflect() protoreflect.Message

func (*Country) Reset 

func (x *Country) Reset()

func (*Country) String 

func (x *Country) String() string

type CountrySubdivision 

type CountrySubdivision struct {

	// The name of the subdivision.
	// Example: "Texas".
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	// The ISO 3166-2 code for the subdivision.
	// This is a code that uniquely identifies the subdivision within its country.
	// Example: "US-TX" for Texas in the United States.
	Code string `protobuf:"bytes,2,opt,name=code,proto3" json:"code,omitempty"`
	// contains filtered or unexported fields
}

The `CountrySubdivision` message represents a subdivision of a country, such as a state, province, or territory, as defined by the ISO-3166-2 standard. This is commonly used for addressing, geolocation, and administrative purposes.

func (*CountrySubdivision) Descriptor deprecated 

func (*CountrySubdivision) Descriptor() ([]byte, []int)

Deprecated: Use CountrySubdivision.ProtoReflect.Descriptor instead.

func (*CountrySubdivision) GetCode 

func (x *CountrySubdivision) GetCode() string

func (*CountrySubdivision) GetName 

func (x *CountrySubdivision) GetName() string

func (*CountrySubdivision) ProtoMessage 

func (*CountrySubdivision) ProtoMessage()

func (*CountrySubdivision) ProtoReflect 

func (x *CountrySubdivision) ProtoReflect() protoreflect.Message

func (*CountrySubdivision) Reset 

func (x *CountrySubdivision) Reset()

func (*CountrySubdivision) String 

func (x *CountrySubdivision) String() string

type EmailAddress 

type EmailAddress struct {

	// The local part of the email address.
	// This is the portion of the address before the "@" symbol.
	// Example: "john.doe" in the email address "john.doe@example.com".
	LocalPart string `protobuf:"bytes,1,opt,name=local_part,json=localPart,proto3" json:"local_part,omitempty"`
	// The domain part of the email address.
	// This is the portion of the address after the "@" symbol.
	// It identifies the mail server responsible for accepting emails for the address.
	// Example: "example.com" in the email address "john.doe@example.com".
	DomainPart string `protobuf:"bytes,2,opt,name=domain_part,json=domainPart,proto3" json:"domain_part,omitempty"`
	// contains filtered or unexported fields
}

The `EmailAddress` message represents an electronic mail (email) address as defined by RFC 5322. It separates the email address into its two main components: the local part and the domain part.

func (*EmailAddress) Descriptor deprecated 

func (*EmailAddress) Descriptor() ([]byte, []int)

Deprecated: Use EmailAddress.ProtoReflect.Descriptor instead.

func (*EmailAddress) GetDomainPart 

func (x *EmailAddress) GetDomainPart() string

func (*EmailAddress) GetLocalPart 

func (x *EmailAddress) GetLocalPart() string

func (*EmailAddress) ProtoMessage 

func (*EmailAddress) ProtoMessage()

func (*EmailAddress) ProtoReflect 

func (x *EmailAddress) ProtoReflect() protoreflect.Message

func (*EmailAddress) Reset 

func (x *EmailAddress) Reset()

func (*EmailAddress) String 

func (x *EmailAddress) String() string

type EntityMetadata 

type EntityMetadata struct {

	// The timestamp at which the entity was created.
	// Example: "2024-11-17T12:34:56Z" for an entity created on November 17, 2024.
	CreatedOn *timestamppb.Timestamp `protobuf:"bytes,1,opt,name=created_on,json=createdOn,proto3" json:"created_on,omitempty"`
	// The timestamp at which the entity was last modified.
	// Example: "2024-11-18T08:20:45Z" for an entity last updated on November 18, 2024.
	ModifiedOn *timestamppb.Timestamp `protobuf:"bytes,2,opt,name=modified_on,json=modifiedOn,proto3" json:"modified_on,omitempty"`
	// The timestamp at which the entity was deleted, if applicable.
	// Example: "2024-11-19T15:00:00Z" for an entity marked as deleted on November 19, 2024.
	DeletedOn *timestamppb.Timestamp `protobuf:"bytes,3,opt,name=deleted_on,json=deletedOn,proto3" json:"deleted_on,omitempty"`
	// Indicates whether the entity is ephemeral.
	// An ephemeral entity is temporary and may not be persisted or stored long-term.
	// Example: `true` for a session-based entity.
	IsEphemeral bool `protobuf:"varint,4,opt,name=is_ephemeral,json=isEphemeral,proto3" json:"is_ephemeral,omitempty"`
	// Indicates whether the entity can be replicated with external sources.
	// Example: `true` for an entity designed to synchronize with external systems.
	IsReplicable bool `protobuf:"varint,5,opt,name=is_replicable,json=isReplicable,proto3" json:"is_replicable,omitempty"`
	// Indicates whether the entity is immutable.
	// An immutable entity cannot be modified after creation.
	// Example: `true` for a cryptographic hash record.
	IsImmutable bool `protobuf:"varint,6,opt,name=is_immutable,json=isImmutable,proto3" json:"is_immutable,omitempty"`
	// The Semantic Version v2.0 compliant version of the entity.
	// This provides versioning information for tracking changes and compatibility.
	// Example: Version `1.0.0` for the initial release of the entity.
	Version *Version `protobuf:"bytes,7,opt,name=version,proto3" json:"version,omitempty"`
	// Indicates whether the entity was synthesized (or is synthetic).
	// A synthetic entity is derived or generated, rather than directly created by users.
	// Example: `true` for an entity generated by machine learning algorithms.
	IsSynthetic bool `protobuf:"varint,8,opt,name=is_synthetic,json=isSynthetic,proto3" json:"is_synthetic,omitempty"`
	// A list of tags associated with the entity.
	// Tags provide descriptive labels for categorization or search.
	// Tags must have:
	// - A minimum length of 1 character
	// - A maximum length of 256 characters
	// - A pattern matching "^[a-zA-Z0-9_-]+$" (alphanumeric, underscores, and hyphens).
	// Example: `["finance", "report2024"]` for an entity tagged as a 2024 finance report.
	Tags []string `protobuf:"bytes,9,rep,name=tags,proto3" json:"tags,omitempty"`
	// Custom extensions for additional metadata in key-value format.
	// The keys and values are strings, allowing flexible metadata descriptions.
	// Example: `{"source": "API", "priority": "high"}` for an entity from the API with high priority.
	Extensions map[string]string `` /* 148-byte string literal not displayed */
	// contains filtered or unexported fields
}

The `EntityMetadata` message represents metadata associated with an entity. This includes timestamps, versioning, and additional descriptive properties, providing a comprehensive overview of the entity's lifecycle and characteristics.

func (*EntityMetadata) Descriptor deprecated 

func (*EntityMetadata) Descriptor() ([]byte, []int)

Deprecated: Use EntityMetadata.ProtoReflect.Descriptor instead.

func (*EntityMetadata) GetCreatedOn 

func (x *EntityMetadata) GetCreatedOn() *timestamppb.Timestamp

func (*EntityMetadata) GetDeletedOn added in v1.23.0 

func (x *EntityMetadata) GetDeletedOn() *timestamppb.Timestamp

func (*EntityMetadata) GetExtensions added in v1.23.0 

func (x *EntityMetadata) GetExtensions() map[string]string

func (*EntityMetadata) GetIsEphemeral added in v1.23.0 

func (x *EntityMetadata) GetIsEphemeral() bool

func (*EntityMetadata) GetIsImmutable added in v1.23.0 

func (x *EntityMetadata) GetIsImmutable() bool

func (*EntityMetadata) GetIsReplicable added in v1.23.0 

func (x *EntityMetadata) GetIsReplicable() bool

func (*EntityMetadata) GetIsSynthetic added in v1.23.0 

func (x *EntityMetadata) GetIsSynthetic() bool

func (*EntityMetadata) GetModifiedOn 

func (x *EntityMetadata) GetModifiedOn() *timestamppb.Timestamp

func (*EntityMetadata) GetTags 

func (x *EntityMetadata) GetTags() []string

func (*EntityMetadata) GetVersion 

func (x *EntityMetadata) GetVersion() *Version

func (*EntityMetadata) ProtoMessage 

func (*EntityMetadata) ProtoMessage()

func (*EntityMetadata) ProtoReflect 

func (x *EntityMetadata) ProtoReflect() protoreflect.Message

func (*EntityMetadata) Reset 

func (x *EntityMetadata) Reset()

func (*EntityMetadata) String 

func (x *EntityMetadata) String() string

type Geofence 

type Geofence struct {

	// The name of the geofence.
	// Example: "Campus Zone", "Restricted Area".
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	// The set of polygons that define the geofence.
	// A geofence may consist of one or more polygons, where each polygon represents
	// a distinct area. The polygons can define complex, multi-vertex boundaries.
	// Example: A campus geofence with multiple disconnected zones.
	Polygon []*MapPolygon `protobuf:"bytes,2,rep,name=polygon,proto3" json:"polygon,omitempty"`
	// contains filtered or unexported fields
}

The `Geofence` message represents a virtual boundary around a geographic area. Geofences are used in applications such as location-based services, navigation, and geo-restriction.

func (*Geofence) Descriptor deprecated 

func (*Geofence) Descriptor() ([]byte, []int)

Deprecated: Use Geofence.ProtoReflect.Descriptor instead.

func (*Geofence) GetName 

func (x *Geofence) GetName() string

func (*Geofence) GetPolygon 

func (x *Geofence) GetPolygon() []*MapPolygon

func (*Geofence) ProtoMessage 

func (*Geofence) ProtoMessage()

func (*Geofence) ProtoReflect 

func (x *Geofence) ProtoReflect() protoreflect.Message

func (*Geofence) Reset 

func (x *Geofence) Reset()

func (*Geofence) String 

func (x *Geofence) String() string

type GeographicRegion 

type GeographicRegion struct {

	// The commonly used name of the region.
	// Example: "Texas".
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	// The formal or official name of the region.
	// Example: "State of Texas".
	FormalName string `protobuf:"bytes,2,opt,name=formal_name,json=formalName,proto3" json:"formal_name,omitempty"`
	// The numeric code for the region as defined in the ISO 3166-2 standard.
	// This code is often used in databases or systems where numeric identifiers
	// are preferred for regional classification.
	// Example: 48 (numeric code for Texas in the United States, if applicable).
	NumericCode uint32 `protobuf:"varint,3,opt,name=numeric_code,json=numericCode,proto3" json:"numeric_code,omitempty"`
	// The country to which the region belongs.
	// This should use the ISO 3166-1 alpha-2 code of the country.
	// Example: "US" for the United States.
	Country string `protobuf:"bytes,4,opt,name=country,proto3" json:"country,omitempty"`
	// The country subdivision code for the region.
	// This should use the ISO 3166-2 code for the specific subdivision.
	// Example: "US-TX" for Texas in the United States.
	CountrySubdivision string `protobuf:"bytes,5,opt,name=country_subdivision,json=countrySubdivision,proto3" json:"country_subdivision,omitempty"`
	// contains filtered or unexported fields
}

The `GeographicRegion` message represents a region as defined by the ISO 3166-2 standard. ISO 3166-2 defines codes for identifying the principal subdivisions (e.g., states or provinces) of countries coded in ISO 3166-1. This message can be used in applications requiring geographic or administrative classification.

func (*GeographicRegion) Descriptor deprecated 

func (*GeographicRegion) Descriptor() ([]byte, []int)

Deprecated: Use GeographicRegion.ProtoReflect.Descriptor instead.

func (*GeographicRegion) GetCountry 

func (x *GeographicRegion) GetCountry() string

func (*GeographicRegion) GetCountrySubdivision 

func (x *GeographicRegion) GetCountrySubdivision() string

func (*GeographicRegion) GetFormalName 

func (x *GeographicRegion) GetFormalName() string

func (*GeographicRegion) GetName 

func (x *GeographicRegion) GetName() string

func (*GeographicRegion) GetNumericCode 

func (x *GeographicRegion) GetNumericCode() uint32

func (*GeographicRegion) ProtoMessage 

func (*GeographicRegion) ProtoMessage()

func (*GeographicRegion) ProtoReflect 

func (x *GeographicRegion) ProtoReflect() protoreflect.Message

func (*GeographicRegion) Reset 

func (x *GeographicRegion) Reset()

func (*GeographicRegion) String 

func (x *GeographicRegion) String() string

type GeometryType added in v1.24.0 

type GeometryType struct {

	// The name of the geometry type (e.g., Euclidean, Hyperbolic).
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	// Optional parameters for the geometry (e.g., curvature, dimensionality).
	Parameters map[string]string `` /* 147-byte string literal not displayed */
	// contains filtered or unexported fields
}

Represents the geometry type, abstracting the mathematical space. Example: Euclidean, Hyperbolic, Elliptic.

func (*GeometryType) Descriptor deprecated added in v1.24.0 

func (*GeometryType) Descriptor() ([]byte, []int)

Deprecated: Use GeometryType.ProtoReflect.Descriptor instead.

func (*GeometryType) GetName added in v1.24.0 

func (x *GeometryType) GetName() string

func (*GeometryType) GetParameters added in v1.24.0 

func (x *GeometryType) GetParameters() map[string]string

func (*GeometryType) ProtoMessage added in v1.24.0 

func (*GeometryType) ProtoMessage()

func (*GeometryType) ProtoReflect added in v1.24.0 

func (x *GeometryType) ProtoReflect() protoreflect.Message

func (*GeometryType) Reset added in v1.24.0 

func (x *GeometryType) Reset()

func (*GeometryType) String added in v1.24.0 

func (x *GeometryType) String() string

type GeospatialCoordinate 

type GeospatialCoordinate struct {

	// The latitude of the geospatial coordinate.
	// Latitude measures the distance north or south of the equator and is
	// expressed in degrees ranging from -90 (south) to +90 (north).
	// Example: 32.9829 for Westlake, Texas.
	Latitude float64 `protobuf:"fixed64,1,opt,name=latitude,proto3" json:"latitude,omitempty"`
	// The longitude of the geospatial coordinate.
	// Longitude measures the distance east or west of the prime meridian,
	// expressed in degrees ranging from -180 to +180.
	// Example: -97.1876 for Westlake, Texas.
	Longitude float64 `protobuf:"fixed64,2,opt,name=longitude,proto3" json:"longitude,omitempty"`
	// The elevation of the geospatial coordinate relative to sea level.
	// This includes additional geospatial information such as altitude or height.
	// Example: Elevation of 212 meters for Westlake, Texas.
	Elevation *GeospatialElevation `protobuf:"bytes,3,opt,name=elevation,proto3" json:"elevation,omitempty"`
	// contains filtered or unexported fields
}

The `GeospatialCoordinate` message represents a geospatial location, defined by latitude, longitude, and elevation. This is commonly used in geolocation, navigation, and geographic information systems (GIS).

func (*GeospatialCoordinate) Descriptor deprecated 

func (*GeospatialCoordinate) Descriptor() ([]byte, []int)

Deprecated: Use GeospatialCoordinate.ProtoReflect.Descriptor instead.

func (*GeospatialCoordinate) GetElevation 

func (x *GeospatialCoordinate) GetElevation() *GeospatialElevation

func (*GeospatialCoordinate) GetLatitude 

func (x *GeospatialCoordinate) GetLatitude() float64

func (*GeospatialCoordinate) GetLongitude 

func (x *GeospatialCoordinate) GetLongitude() float64

func (*GeospatialCoordinate) ProtoMessage 

func (*GeospatialCoordinate) ProtoMessage()

func (*GeospatialCoordinate) ProtoReflect 

func (x *GeospatialCoordinate) ProtoReflect() protoreflect.Message

func (*GeospatialCoordinate) Reset 

func (x *GeospatialCoordinate) Reset()

func (*GeospatialCoordinate) String 

func (x *GeospatialCoordinate) String() string

type GeospatialElevation 

type GeospatialElevation struct {

	// The geodetic datum used as the reference point for the elevation measurement.
	// Example: `SEA_LEVEL` for altitude above mean sea level.
	Datum GeospatialElevation_GeodeticDatum `protobuf:"varint,1,opt,name=datum,proto3,enum=sixafter.types.GeospatialElevation_GeodeticDatum" json:"datum,omitempty"`
	// The altitude or vertical elevation of the point, measured in meters.
	// This value can be positive (above the datum) or negative (below the datum).
	// Example: An altitude of 212 meters above sea level for Westlake, Texas.
	Altitude float64 `protobuf:"fixed64,2,opt,name=altitude,proto3" json:"altitude,omitempty"`
	// contains filtered or unexported fields
}

The `GeospatialElevation` message represents the vertical direction or height of a point relative to a specified reference datum. This is commonly used in geolocation, mapping, and geographic information systems (GIS).

func (*GeospatialElevation) Descriptor deprecated 

func (*GeospatialElevation) Descriptor() ([]byte, []int)

Deprecated: Use GeospatialElevation.ProtoReflect.Descriptor instead.

func (*GeospatialElevation) GetAltitude 

func (x *GeospatialElevation) GetAltitude() float64

func (*GeospatialElevation) GetDatum 

func (x *GeospatialElevation) GetDatum() GeospatialElevation_GeodeticDatum

func (*GeospatialElevation) ProtoMessage 

func (*GeospatialElevation) ProtoMessage()

func (*GeospatialElevation) ProtoReflect 

func (x *GeospatialElevation) ProtoReflect() protoreflect.Message

func (*GeospatialElevation) Reset 

func (x *GeospatialElevation) Reset()

func (*GeospatialElevation) String 

func (x *GeospatialElevation) String() string

type GeospatialElevation_GeodeticDatum 

type GeospatialElevation_GeodeticDatum int32

The `GeodeticDatum` enum defines the reference system or surface against which the elevation is measured. These reference systems are approximations of the Earth's surface. 

const (
	// The altitude above mean sea level (MSL), measured in meters.
	// This is a commonly used datum for everyday elevation measurements.
	GeospatialElevation_SEA_LEVEL GeospatialElevation_GeodeticDatum = 0
	// The altitude as a height above the World Geodetic System 1984 (WGS84)
	// ellipsoid, measured in meters. This is commonly used in GPS systems.
	GeospatialElevation_WGS_84 GeospatialElevation_GeodeticDatum = 1
)

func (GeospatialElevation_GeodeticDatum) Descriptor 

func (GeospatialElevation_GeodeticDatum) Descriptor() protoreflect.EnumDescriptor

func (GeospatialElevation_GeodeticDatum) Enum 

func (x GeospatialElevation_GeodeticDatum) Enum() *GeospatialElevation_GeodeticDatum

func (GeospatialElevation_GeodeticDatum) EnumDescriptor deprecated 

func (GeospatialElevation_GeodeticDatum) EnumDescriptor() ([]byte, []int)

Deprecated: Use GeospatialElevation_GeodeticDatum.Descriptor instead.

func (GeospatialElevation_GeodeticDatum) Number 

func (x GeospatialElevation_GeodeticDatum) Number() protoreflect.EnumNumber

func (GeospatialElevation_GeodeticDatum) String 

func (x GeospatialElevation_GeodeticDatum) String() string

func (GeospatialElevation_GeodeticDatum) Type 

func (GeospatialElevation_GeodeticDatum) Type() protoreflect.EnumType

type GeospatialLocation 

type GeospatialLocation struct {

	// The geographical coordinate information of the location.
	// Includes latitude, longitude, and elevation as defined in the `GeospatialCoordinate` message.
	Coordinate *GeospatialCoordinate `protobuf:"bytes,1,opt,name=coordinate,proto3" json:"coordinate,omitempty"`
	// The azimuth (orientation) of the device relative to true or magnetic north.
	// Defined using the `CompassHeading` message, it represents the heading
	// of the device at the time of measurement.
	Heading *CompassHeading `protobuf:"bytes,2,opt,name=heading,proto3" json:"heading,omitempty"`
	// The direction in which the device is traveling, measured in degrees
	// relative to true north (0°). This reflects the course or trajectory
	// of the device's movement.
	//
	// **Note:** Course direction is different from heading. Course measures
	// the direction the device is moving (e.g., forward travel), independent
	// of its physical orientation. Heading reflects the device's orientation.
	// Example: 90° indicates the device is moving east.
	Course float64 `protobuf:"fixed64,3,opt,name=course,proto3" json:"course,omitempty"`
	// The instantaneous speed of the device, measured in meters per second (m/s).
	// Example: A speed of 3.5 m/s (12.6 km/h or 7.8 mph) indicates the device
	// is moving at a walking pace.
	Speed float32 `protobuf:"fixed32,4,opt,name=speed,proto3" json:"speed,omitempty"`
	// The time at which this geospatial location data was recorded.
	// Example: Timestamp of "2024-11-17T15:00:00Z" represents 3:00 PM UTC on November 17, 2024.
	Timestamp *timestamppb.Timestamp `protobuf:"bytes,5,opt,name=timestamp,proto3" json:"timestamp,omitempty"`
	// contains filtered or unexported fields
}

The `GeospatialLocation` message represents a spatial or temporal scale, combining geographical coordinates, heading, movement, and timestamp. It is commonly used in location-based services, navigation systems, and applications requiring geospatial data.

func (*GeospatialLocation) Descriptor deprecated 

func (*GeospatialLocation) Descriptor() ([]byte, []int)

Deprecated: Use GeospatialLocation.ProtoReflect.Descriptor instead.

func (*GeospatialLocation) GetCoordinate 

func (x *GeospatialLocation) GetCoordinate() *GeospatialCoordinate

func (*GeospatialLocation) GetCourse 

func (x *GeospatialLocation) GetCourse() float64

func (*GeospatialLocation) GetHeading 

func (x *GeospatialLocation) GetHeading() *CompassHeading

func (*GeospatialLocation) GetSpeed 

func (x *GeospatialLocation) GetSpeed() float32

func (*GeospatialLocation) GetTimestamp 

func (x *GeospatialLocation) GetTimestamp() *timestamppb.Timestamp

func (*GeospatialLocation) ProtoMessage 

func (*GeospatialLocation) ProtoMessage()

func (*GeospatialLocation) ProtoReflect 

func (x *GeospatialLocation) ProtoReflect() protoreflect.Message

func (*GeospatialLocation) Reset 

func (x *GeospatialLocation) Reset()

func (*GeospatialLocation) String 

func (x *GeospatialLocation) String() string

type Line added in v1.24.0 

type Line struct {

	// The starting point of the line.
	Start *Point `protobuf:"bytes,1,opt,name=start,proto3" json:"start,omitempty"`
	// The ending point of the line.
	End *Point `protobuf:"bytes,2,opt,name=end,proto3" json:"end,omitempty"`
	// contains filtered or unexported fields
}

Represents a line or geodesic in a mathematical space.

Examples:

  • A line between two points in 2D Cartesian space: start.position.values = [{unscaled_value: 0, scale: 0}, {unscaled_value: 0, scale: 0}] end.position.values = [{unscaled_value: 10, scale: 0}, {unscaled_value: 10, scale: 0}]

func (*Line) Descriptor deprecated added in v1.24.0 

func (*Line) Descriptor() ([]byte, []int)

Deprecated: Use Line.ProtoReflect.Descriptor instead.

func (*Line) GetEnd added in v1.24.0 

func (x *Line) GetEnd() *Point

func (*Line) GetStart added in v1.24.0 

func (x *Line) GetStart() *Point

func (*Line) ProtoMessage added in v1.24.0 

func (*Line) ProtoMessage()

func (*Line) ProtoReflect added in v1.24.0 

func (x *Line) ProtoReflect() protoreflect.Message

func (*Line) Reset added in v1.24.0 

func (x *Line) Reset()

func (*Line) String added in v1.24.0 

func (x *Line) String() string

type MapPoint 

type MapPoint struct {

	// The x-coordinate of the map point.
	// Represents the horizontal position on the two-dimensional map.
	// Example: A value of 200.5 could represent a position on a Mercator projection.
	X float32 `protobuf:"fixed32,1,opt,name=x,proto3" json:"x,omitempty"`
	// The y-coordinate of the map point.
	// Represents the vertical position on the two-dimensional map.
	// Example: A value of 150.2 could represent a position on a Mercator projection.
	Y float32 `protobuf:"fixed32,2,opt,name=y,proto3" json:"y,omitempty"`
	// The geospatial coordinate that corresponds to the map point.
	// Provides the latitude, longitude, and elevation information for the point.
	// Example: A map point with `x=200.5` and `y=150.2` could correspond to
	// `latitude=32.9829` and `longitude=-97.1876` for Westlake, Texas.
	Coordinate *GeospatialCoordinate `protobuf:"bytes,3,opt,name=coordinate,proto3" json:"coordinate,omitempty"`
	// contains filtered or unexported fields
}

The `MapPoint` message represents a point on a two-dimensional map, derived from projecting the curved surface of the globe onto a flat surface. This structure is commonly used in mapping, GIS, and location-based applications.

func (*MapPoint) Descriptor deprecated 

func (*MapPoint) Descriptor() ([]byte, []int)

Deprecated: Use MapPoint.ProtoReflect.Descriptor instead.

func (*MapPoint) GetCoordinate 

func (x *MapPoint) GetCoordinate() *GeospatialCoordinate

func (*MapPoint) GetX 

func (x *MapPoint) GetX() float32

func (*MapPoint) GetY 

func (x *MapPoint) GetY() float32

func (*MapPoint) ProtoMessage 

func (*MapPoint) ProtoMessage()

func (*MapPoint) ProtoReflect 

func (x *MapPoint) ProtoReflect() protoreflect.Message

func (*MapPoint) Reset 

func (x *MapPoint) Reset()

func (*MapPoint) String 

func (x *MapPoint) String() string

type MapPolygon added in v1.24.0 

type MapPolygon struct {

	// The set of points that define the polygon.
	// Each point is represented by a `MapPoint` message, which specifies the
	// location on the map. The points should be provided in the order they are
	// connected.
	//
	// Example: A triangle may have three points:
	// - Point 1: `x=0, y=0`
	// - Point 2: `x=10, y=0`
	// - Point 3: `x=5, y=5`
	// The first point is automatically connected to the last point to close the shape.
	Points []*MapPoint `protobuf:"bytes,1,rep,name=points,proto3" json:"points,omitempty"`
	// contains filtered or unexported fields
}

The `MapPolygonPolygon` message represents a closed geometric shape on a map. The shape is defined by a series of points that are connected end-to-end, with the first and last points also connected to form a closed shape. This structure is commonly used in mapping applications, GIS, and geofencing.

func (*MapPolygon) Descriptor deprecated added in v1.24.0 

func (*MapPolygon) Descriptor() ([]byte, []int)

Deprecated: Use MapPolygon.ProtoReflect.Descriptor instead.

func (*MapPolygon) GetPoints added in v1.24.0 

func (x *MapPolygon) GetPoints() []*MapPoint

func (*MapPolygon) ProtoMessage added in v1.24.0 

func (*MapPolygon) ProtoMessage()

func (*MapPolygon) ProtoReflect added in v1.24.0 

func (x *MapPolygon) ProtoReflect() protoreflect.Message

func (*MapPolygon) Reset added in v1.24.0 

func (x *MapPolygon) Reset()

func (*MapPolygon) String added in v1.24.0 

func (x *MapPolygon) String() string

type Point added in v1.24.0 

type Point struct {

	// The coordinate defining the position of the point.
	Position *Coordinate `protobuf:"bytes,1,opt,name=position,proto3" json:"position,omitempty"`
	// contains filtered or unexported fields
}

Represents a point in a mathematical space.

Examples:

  • A point in 3D Euclidean space: position.geometry_type = EUCLIDEAN position.coordinate_system = EUCLIDEAN_CARTESIAN position.values = [{unscaled_value: 10, scale: 0}, {unscaled_value: 0, scale: 0}, {unscaled_value: -5, scale: 0}]

func (*Point) Descriptor deprecated added in v1.24.0 

func (*Point) Descriptor() ([]byte, []int)

Deprecated: Use Point.ProtoReflect.Descriptor instead.

func (*Point) GetPosition added in v1.24.0 

func (x *Point) GetPosition() *Coordinate

func (*Point) ProtoMessage added in v1.24.0 

func (*Point) ProtoMessage()

func (*Point) ProtoReflect added in v1.24.0 

func (x *Point) ProtoReflect() protoreflect.Message

func (*Point) Reset added in v1.24.0 

func (x *Point) Reset()

func (*Point) String added in v1.24.0 

func (x *Point) String() string

type Polygon 

type Polygon struct {

	// The vertices of the polygon.
	Vertices []*Point `protobuf:"bytes,1,rep,name=vertices,proto3" json:"vertices,omitempty"`
	// True if the polygon is explicitly closed.
	IsClosed bool `protobuf:"varint,2,opt,name=is_closed,json=isClosed,proto3" json:"is_closed,omitempty"`
	// contains filtered or unexported fields
}

Represents a polygon in a mathematical space. A polygon is defined by a series of vertices, and it may or may not be closed.

Examples:

  • A triangle in 2D Cartesian space: vertices = [ {position.values = [{unscaled_value: 0, scale: 0}, {unscaled_value: 0, scale: 0}]}, {position.values = [{unscaled_value: 10, scale: 0}, {unscaled_value: 0, scale: 0}]}, {position.values = [{unscaled_value: 5, scale: 0}, {unscaled_value: 10, scale: 0}]} ] is_closed = true

func (*Polygon) Descriptor deprecated 

func (*Polygon) Descriptor() ([]byte, []int)

Deprecated: Use Polygon.ProtoReflect.Descriptor instead.

func (*Polygon) GetIsClosed added in v1.24.0 

func (x *Polygon) GetIsClosed() bool

func (*Polygon) GetVertices added in v1.24.0 

func (x *Polygon) GetVertices() []*Point

func (*Polygon) ProtoMessage 

func (*Polygon) ProtoMessage()

func (*Polygon) ProtoReflect 

func (x *Polygon) ProtoReflect() protoreflect.Message

func (*Polygon) Reset 

func (x *Polygon) Reset()

func (*Polygon) String 

func (x *Polygon) String() string

type RadialGeofence 

type RadialGeofence struct {

	// The name of this geofence.
	// Example: "Warehouse Perimeter", "Restricted Zone".
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	// The geospatial coordinate representing the center of the circular geofence.
	// This is the point around which the radius is applied to form the boundary.
	// Example: The center coordinate for Westlake, Texas, with latitude `32.9829` and longitude `-97.1876`.
	Center *GeospatialCoordinate `protobuf:"bytes,2,opt,name=center,proto3" json:"center,omitempty"`
	// The radius of the circular geofence, measured in meters.
	// This defines the distance from the center point to the boundary of the geofence.
	// Example: A radius of `500` meters creates a circular geofence with a 1-kilometer diameter.
	Radius float64 `protobuf:"fixed64,3,opt,name=radius,proto3" json:"radius,omitempty"`
	// contains filtered or unexported fields
}

The `RadialGeofence` message represents a circular geofence. A geofence is a virtual perimeter defined for a real-world geographic area. The radial geofence is defined by a center point and a radius, forming a circular boundary. It is commonly used in applications like location-based alerts, tracking, and geofencing.

func (*RadialGeofence) Descriptor deprecated 

func (*RadialGeofence) Descriptor() ([]byte, []int)

Deprecated: Use RadialGeofence.ProtoReflect.Descriptor instead.

func (*RadialGeofence) GetCenter 

func (x *RadialGeofence) GetCenter() *GeospatialCoordinate

func (*RadialGeofence) GetName 

func (x *RadialGeofence) GetName() string

func (*RadialGeofence) GetRadius 

func (x *RadialGeofence) GetRadius() float64

func (*RadialGeofence) ProtoMessage 

func (*RadialGeofence) ProtoMessage()

func (*RadialGeofence) ProtoReflect 

func (x *RadialGeofence) ProtoReflect() protoreflect.Message

func (*RadialGeofence) Reset 

func (x *RadialGeofence) Reset()

func (*RadialGeofence) String 

func (x *RadialGeofence) String() string

type Scalar added in v1.24.0 

type Scalar struct {

	// Stores the combined integer and fractional digits without the decimal point.
	UnscaledValue int64 `protobuf:"zigzag64,1,opt,name=unscaled_value,json=unscaledValue,proto3" json:"unscaled_value,omitempty"`
	// Specifies the number of decimal places (digits after the decimal point).
	Scale uint32 `protobuf:"varint,2,opt,name=scale,proto3" json:"scale,omitempty"`
	// contains filtered or unexported fields
}

Represents a scalar number using an unscaled integer value and a scale. The actual value is computed as: 

value = unscaled_value * 10^(-scale)

Examples: - To represent 12.34, set `unscaled_value = 1234` and `scale = 2`. - To represent -0.005, set `unscaled_value = -5` and `scale = 3`.

func (*Scalar) Descriptor deprecated added in v1.24.0 

func (*Scalar) Descriptor() ([]byte, []int)

Deprecated: Use Scalar.ProtoReflect.Descriptor instead.

func (*Scalar) GetScale added in v1.24.0 

func (x *Scalar) GetScale() uint32

func (*Scalar) GetUnscaledValue added in v1.24.0 

func (x *Scalar) GetUnscaledValue() int64

func (*Scalar) ProtoMessage added in v1.24.0 

func (*Scalar) ProtoMessage()

func (*Scalar) ProtoReflect added in v1.24.0 

func (x *Scalar) ProtoReflect() protoreflect.Message

func (*Scalar) Reset added in v1.24.0 

func (x *Scalar) Reset()

func (*Scalar) String added in v1.24.0 

func (x *Scalar) String() string

type TemporalRange 

type TemporalRange struct {

	// The starting point of the temporal range, known as the epoch.
	// This timestamp serves as the reference point from which the duration is
	// measured.
	// Example: "2024-11-17T00:00:00Z" for a midnight reference point in UTC.
	Epoch *timestamppb.Timestamp `protobuf:"bytes,1,opt,name=epoch,proto3" json:"epoch,omitempty"`
	// The duration of the temporal range, measured as the time span from the
	// epoch. This represents the length of the time range.
	// Example: A duration of `3600 seconds` (1 hour) indicates a range lasting
	// one hour from the epoch.
	Duration *durationpb.Duration `protobuf:"bytes,2,opt,name=duration,proto3" json:"duration,omitempty"`
	// contains filtered or unexported fields
}

The `TemporalRange` message represents a time range defined by a starting reference point (epoch) and a duration. It is commonly used in time-based applications such as scheduling, analytics, and temporal data analysis.

func (*TemporalRange) Descriptor deprecated 

func (*TemporalRange) Descriptor() ([]byte, []int)

Deprecated: Use TemporalRange.ProtoReflect.Descriptor instead.

func (*TemporalRange) GetDuration 

func (x *TemporalRange) GetDuration() *durationpb.Duration

func (*TemporalRange) GetEpoch 

func (x *TemporalRange) GetEpoch() *timestamppb.Timestamp

func (*TemporalRange) ProtoMessage 

func (*TemporalRange) ProtoMessage()

func (*TemporalRange) ProtoReflect 

func (x *TemporalRange) ProtoReflect() protoreflect.Message

func (*TemporalRange) Reset 

func (x *TemporalRange) Reset()

func (*TemporalRange) String 

func (x *TemporalRange) String() string

type TimeZone 

type TimeZone struct {

	// The name of the time zone.
	// Example: "America/New_York".
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	// The common abbreviation for the time zone.
	// Example: "EST" for Eastern Standard Time or "EDT" for Eastern Daylight Time.
	Abbreviation string `protobuf:"bytes,2,opt,name=abbreviation,proto3" json:"abbreviation,omitempty"`
	// The Standard Time (STD) offset from UTC, in hours and minutes.
	// This represents the time zone's offset when daylight saving time is not in effect.
	// Example: For "America/New_York", the standard time offset is UTC-5.
	UtcOffsetStd *TimeZone_TimeOffset `protobuf:"bytes,3,opt,name=utc_offset_std,json=utcOffsetStd,proto3" json:"utc_offset_std,omitempty"`
	// The Daylight Saving Time (DST) offset from UTC, in hours and minutes.
	// This represents the time zone's offset when daylight saving time is in effect.
	// Example: For "America/New_York", the daylight saving time offset is UTC-4.
	UtcOffsetDst *TimeZone_TimeOffset `protobuf:"bytes,4,opt,name=utc_offset_dst,json=utcOffsetDst,proto3" json:"utc_offset_dst,omitempty"`
	// contains filtered or unexported fields
}

The `TimeZone` message represents a time zone, which is an area observing a uniform standard time for legal, commercial, and social purposes.

func (*TimeZone) Descriptor deprecated 

func (*TimeZone) Descriptor() ([]byte, []int)

Deprecated: Use TimeZone.ProtoReflect.Descriptor instead.

func (*TimeZone) GetAbbreviation 

func (x *TimeZone) GetAbbreviation() string

func (*TimeZone) GetName 

func (x *TimeZone) GetName() string

func (*TimeZone) GetUtcOffsetDst 

func (x *TimeZone) GetUtcOffsetDst() *TimeZone_TimeOffset

func (*TimeZone) GetUtcOffsetStd 

func (x *TimeZone) GetUtcOffsetStd() *TimeZone_TimeOffset

func (*TimeZone) ProtoMessage 

func (*TimeZone) ProtoMessage()

func (*TimeZone) ProtoReflect 

func (x *TimeZone) ProtoReflect() protoreflect.Message

func (*TimeZone) Reset 

func (x *TimeZone) Reset()

func (*TimeZone) String 

func (x *TimeZone) String() string

type TimeZone_TimeOffset 

type TimeZone_TimeOffset struct {

	// The offset from UTC in whole hours.
	// Example: -5 for UTC-5 (Eastern Standard Time).
	Hours int32 `protobuf:"varint,1,opt,name=hours,proto3" json:"hours,omitempty"`
	// The additional offset from UTC in minutes.
	// Example: 30 for UTC+5:30 (India Standard Time).
	Minutes int32 `protobuf:"varint,2,opt,name=minutes,proto3" json:"minutes,omitempty"`
	// contains filtered or unexported fields
}

The `TimeOffset` message represents a time offset from Coordinated Universal Time (UTC) in terms of hours and minutes.

func (*TimeZone_TimeOffset) Descriptor deprecated 

func (*TimeZone_TimeOffset) Descriptor() ([]byte, []int)

Deprecated: Use TimeZone_TimeOffset.ProtoReflect.Descriptor instead.

func (*TimeZone_TimeOffset) GetHours 

func (x *TimeZone_TimeOffset) GetHours() int32

func (*TimeZone_TimeOffset) GetMinutes 

func (x *TimeZone_TimeOffset) GetMinutes() int32

func (*TimeZone_TimeOffset) ProtoMessage 

func (*TimeZone_TimeOffset) ProtoMessage()

func (*TimeZone_TimeOffset) ProtoReflect 

func (x *TimeZone_TimeOffset) ProtoReflect() protoreflect.Message

func (*TimeZone_TimeOffset) Reset 

func (x *TimeZone_TimeOffset) Reset()

func (*TimeZone_TimeOffset) String 

func (x *TimeZone_TimeOffset) String() string

type Uri 

type Uri struct {

	// The scheme component of the URI.
	// Example: "https", "ftp", or "mailto".
	Scheme string `protobuf:"bytes,1,opt,name=scheme,proto3" json:"scheme,omitempty"`
	// The fragment component of the URI.
	// This is the optional part of the URI that follows a "#" and provides an identifier
	// to a secondary resource.
	// Example: "section1" in "https://example.com/page#section1".
	Fragment string `protobuf:"bytes,2,opt,name=fragment,proto3" json:"fragment,omitempty"`
	// The host component of the URI.
	// This identifies the domain name or IP address of the resource.
	// Example: "example.com" or "192.168.1.1".
	Host string `protobuf:"bytes,3,opt,name=host,proto3" json:"host,omitempty"`
	// The port number of the URI.
	// This is the optional number that specifies the communication port.
	// Example: 443 for HTTPS.
	Port int32 `protobuf:"varint,4,opt,name=port,proto3" json:"port,omitempty"`
	// The query component of the URI.
	// This contains optional parameters appended to the URI, following a "?".
	// Example: "id=123&name=test" in "https://example.com/page?id=123&name=test".
	Query string `protobuf:"bytes,5,opt,name=query,proto3" json:"query,omitempty"`
	// The authority component of the URI.
	// This typically includes the host and port, and optionally the user-information.
	// Example: "user@example.com:8080" in "https://user@example.com:8080/resource".
	Authority string `protobuf:"bytes,6,opt,name=authority,proto3" json:"authority,omitempty"`
	// The user-information component of the URI.
	// This is the optional part before the host that provides user credentials.
	// Example: "user:password" in "https://user:password@example.com".
	UserInfo string `protobuf:"bytes,7,opt,name=user_info,json=userInfo,proto3" json:"user_info,omitempty"`
	// contains filtered or unexported fields
}

The `Uri` message represents a Uniform Resource Identifier (URI) as defined by [RFC 2396: Uniform Resource Identifiers (URI): Generic Syntax](http://www.ietf.org/rfc/rfc2396.txt), amended by [RFC 2732: Format for Literal IPv6 Addresses in URLs](http://www.ietf.org/rfc/rfc2732.txt). A URI is a compact string used to identify a resource in a generic syntax.

func (*Uri) Descriptor deprecated 

func (*Uri) Descriptor() ([]byte, []int)

Deprecated: Use Uri.ProtoReflect.Descriptor instead.

func (*Uri) GetAuthority 

func (x *Uri) GetAuthority() string

func (*Uri) GetFragment 

func (x *Uri) GetFragment() string

func (*Uri) GetHost 

func (x *Uri) GetHost() string

func (*Uri) GetPort 

func (x *Uri) GetPort() int32

func (*Uri) GetQuery 

func (x *Uri) GetQuery() string

func (*Uri) GetScheme 

func (x *Uri) GetScheme() string

func (*Uri) GetUserInfo 

func (x *Uri) GetUserInfo() string

func (*Uri) ProtoMessage 

func (*Uri) ProtoMessage()

func (*Uri) ProtoReflect 

func (x *Uri) ProtoReflect() protoreflect.Message

func (*Uri) Reset 

func (x *Uri) Reset()

func (*Uri) String 

func (x *Uri) String() string

type Url 

type Url struct {

	// The protocol (or scheme) component of the URL.
	// Example: "https", "http", or "ftp".
	Protocol string `protobuf:"bytes,1,opt,name=protocol,proto3" json:"protocol,omitempty"`
	// The host component of the URL.
	// This specifies the domain name or IP address of the resource.
	// Example: "example.com" or "192.168.1.1".
	Host string `protobuf:"bytes,2,opt,name=host,proto3" json:"host,omitempty"`
	// The path component of the URL.
	// This represents the hierarchical location of the resource on the host.
	// Example: "/resources/images" in "https://example.com/resources/images".
	Path string `protobuf:"bytes,3,opt,name=path,proto3" json:"path,omitempty"`
	// The port number of the URL.
	// This specifies the communication port for the connection.
	// Example: 443 for HTTPS, 80 for HTTP.
	Port int32 `protobuf:"varint,4,opt,name=port,proto3" json:"port,omitempty"`
	// The file component of the URL.
	// This is the specific file or resource being requested.
	// Example: "image.png" in "https://example.com/resources/image.png".
	File string `protobuf:"bytes,5,opt,name=file,proto3" json:"file,omitempty"`
	// The query component of the URL.
	// This contains optional parameters appended to the URL, following a "?".
	// Example: "id=123&name=test" in "https://example.com/page?id=123&name=test".
	Query string `protobuf:"bytes,6,opt,name=query,proto3" json:"query,omitempty"`
	// The authority component of the URL.
	// This typically includes the host, port, and optionally the user-information.
	// Example: "user@example.com:8080" in "https://user@example.com:8080/resource".
	Authority string `protobuf:"bytes,7,opt,name=authority,proto3" json:"authority,omitempty"`
	// The user-information component of the URL.
	// This is the optional part before the host that provides user credentials.
	// Example: "user:password" in "https://user:password@example.com".
	UserInfo string `protobuf:"bytes,8,opt,name=user_info,json=userInfo,proto3" json:"user_info,omitempty"`
	// The ref (also known as anchor) component of the URL.
	// This identifies a secondary resource within the primary resource.
	// Example: "section1" in "https://example.com/page#section1".
	Ref string `protobuf:"bytes,9,opt,name=ref,proto3" json:"ref,omitempty"`
	// contains filtered or unexported fields
}

The `Url` message represents a Uniform Resource Locator (URL), which is a specific type of Uniform Resource Identifier (URI) used to locate resources on the web. A URL consists of various components like protocol, host, path, query, and more.

func (*Url) Descriptor deprecated 

func (*Url) Descriptor() ([]byte, []int)

Deprecated: Use Url.ProtoReflect.Descriptor instead.

func (*Url) GetAuthority 

func (x *Url) GetAuthority() string

func (*Url) GetFile 

func (x *Url) GetFile() string

func (*Url) GetHost 

func (x *Url) GetHost() string

func (*Url) GetPath 

func (x *Url) GetPath() string

func (*Url) GetPort 

func (x *Url) GetPort() int32

func (*Url) GetProtocol 

func (x *Url) GetProtocol() string

func (*Url) GetQuery 

func (x *Url) GetQuery() string

func (*Url) GetRef 

func (x *Url) GetRef() string

func (*Url) GetUserInfo 

func (x *Url) GetUserInfo() string

func (*Url) ProtoMessage 

func (*Url) ProtoMessage()

func (*Url) ProtoReflect 

func (x *Url) ProtoReflect() protoreflect.Message

func (*Url) Reset 

func (x *Url) Reset()

func (*Url) String 

func (x *Url) String() string

type Version 

type Version struct {

	// The major version number.
	//
	// Major version zero (0.y.z) is for initial development. Anything MAY change
	// at any time. The public API SHOULD NOT be considered stable.
	Major uint32 `protobuf:"varint,1,opt,name=major,proto3" json:"major,omitempty"`
	// Minor version number.
	//
	// Minor version Y (x.Y.z | x > 0) MUST be incremented if new, backwards compatible
	// functionality is introduced to the public API. It MUST be incremented if any
	// public API functionality is marked as deprecated. It MAY be incremented if
	// substantial new functionality or improvements are introduced within the private
	// code. It MAY include patch level changes. Patch version MUST be reset to 0 when
	// minor version is incremented.
	Minor uint32 `protobuf:"varint,2,opt,name=minor,proto3" json:"minor,omitempty"`
	// Patch version number.
	//
	// Patch version Z (x.y.Z | x > 0) MUST be incremented if only backwards compatible
	// bug fixes are introduced. A bug fix is defined as an internal change that fixes
	// incorrect behavior.
	Patch uint32 `protobuf:"varint,3,opt,name=patch,proto3" json:"patch,omitempty"`
	// The pre-release version identifier.
	//
	// A pre-release version MAY be denoted by appending a hyphen and a series of dot
	// separated identifiers immediately following the patch version. Identifiers MUST
	// comprise only ASCII alphanumerics and hyphens [0-9A-Za-z-]. Identifiers MUST NOT
	// be empty. Numeric identifiers MUST NOT include leading zeroes. Pre-release
	// versions have a lower precedence than the associated normal version.
	//
	// A pre-release version indicates that the version is unstable and might not satisfy
	// the intended compatibility requirements as denoted by its associated normal version.
	//
	// Examples: 1.0.0-alpha, 1.0.0-alpha.1, 1.0.0-0.3.7, 1.0.0-x.7.z.92, 1.0.0-x-y-z.–.
	Prerelease string `protobuf:"bytes,4,opt,name=prerelease,proto3" json:"prerelease,omitempty"`
	// The build metadata identifier.
	//
	// Build metadata MAY be denoted by appending a plus sign and a series of dot separated
	// identifiers immediately following the patch or pre-release version. Identifiers MUST
	// comprise only ASCII alphanumerics and hyphens [0-9A-Za-z-]. Identifiers MUST NOT be
	// empty.
	//
	// Build metadata MUST be ignored when determining version precedence. Thus two
	// versions that differ only in the build metadata, have the same precedence.
	//
	// Examples: 1.0.0-alpha+001, 1.0.0+20130313144700, 1.0.0-beta+exp.sha.5114f85,
	// 1.0.0+21AF26D3—-117B344092BD.
	BuildMetadata string `protobuf:"bytes,5,opt,name=build_metadata,json=buildMetadata,proto3" json:"build_metadata,omitempty"`
	// contains filtered or unexported fields
}

The `Version` message represents a Semantic Versioning 2.0.0 compliant version number. For details, see: https://semver.org

func (*Version) Descriptor deprecated 

func (*Version) Descriptor() ([]byte, []int)

Deprecated: Use Version.ProtoReflect.Descriptor instead.

func (*Version) GetBuildMetadata 

func (x *Version) GetBuildMetadata() string

func (*Version) GetMajor 

func (x *Version) GetMajor() uint32

func (*Version) GetMinor 

func (x *Version) GetMinor() uint32

func (*Version) GetPatch 

func (x *Version) GetPatch() uint32

func (*Version) GetPrerelease 

func (x *Version) GetPrerelease() string

func (*Version) ProtoMessage 

func (*Version) ProtoMessage()

func (*Version) ProtoReflect 

func (x *Version) ProtoReflect() protoreflect.Message

func (*Version) Reset 

func (x *Version) Reset()

func (*Version) String 

func (x *Version) String() string

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.