proto

package
v1.20.3 Latest Latest
Warning

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

 Go to latest Published: Jun 14, 2021 License: Apache-2.0 Imports: 10 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

View Source 
var File_mixer_proto protoreflect.FileDescriptor
View Source 
var File_stat_proto protoreflect.FileDescriptor

Functions

func RegisterMixerServer 

func RegisterMixerServer(s *grpc.Server, srv MixerServer)

Types

type ChartStore 

type ChartStore struct {

	// Types that are assignable to Val:
	//	*ChartStore_ObsTimeSeries
	//	*ChartStore_ObsCollection
	Val isChartStore_Val `protobuf_oneof:"val"`
	// contains filtered or unexported fields
}

Wrapper for observation data.

func (*ChartStore) Descriptor deprecated 

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

Deprecated: Use ChartStore.ProtoReflect.Descriptor instead.

func (*ChartStore) GetObsCollection 

func (x *ChartStore) GetObsCollection() *ObsCollection

func (*ChartStore) GetObsTimeSeries 

func (x *ChartStore) GetObsTimeSeries() *ObsTimeSeries

func (*ChartStore) GetVal 

func (m *ChartStore) GetVal() isChartStore_Val

func (*ChartStore) ProtoMessage 

func (*ChartStore) ProtoMessage()

func (*ChartStore) ProtoReflect 

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

func (*ChartStore) Reset 

func (x *ChartStore) Reset()

func (*ChartStore) String 

func (x *ChartStore) String() string

type ChartStore_ObsCollection 

type ChartStore_ObsCollection struct {
	ObsCollection *ObsCollection `protobuf:"bytes,2,opt,name=obs_collection,json=obsCollection,proto3,oneof"`
}

type ChartStore_ObsTimeSeries 

type ChartStore_ObsTimeSeries struct {
	ObsTimeSeries *ObsTimeSeries `protobuf:"bytes,1,opt,name=obs_time_series,json=obsTimeSeries,proto3,oneof"`
}

type ContainedInPlaceRelation 

type ContainedInPlaceRelation struct {
	ParentId   string `protobuf:"bytes,1,opt,name=parent_id,json=parentId,proto3" json:"parent_id,omitempty"`
	ParentType string `protobuf:"bytes,2,opt,name=parent_type,json=parentType,proto3" json:"parent_type,omitempty"`
	ChildId    string `protobuf:"bytes,3,opt,name=child_id,json=childId,proto3" json:"child_id,omitempty"`
	ChildType  string `protobuf:"bytes,4,opt,name=child_type,json=childType,proto3" json:"child_type,omitempty"`
	// contains filtered or unexported fields
}

A pair of entities linked by containedInPlace.

func (*ContainedInPlaceRelation) Descriptor deprecated 

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

Deprecated: Use ContainedInPlaceRelation.ProtoReflect.Descriptor instead.

func (*ContainedInPlaceRelation) GetChildId 

func (x *ContainedInPlaceRelation) GetChildId() string

func (*ContainedInPlaceRelation) GetChildType 

func (x *ContainedInPlaceRelation) GetChildType() string

func (*ContainedInPlaceRelation) GetParentId 

func (x *ContainedInPlaceRelation) GetParentId() string

func (*ContainedInPlaceRelation) GetParentType 

func (x *ContainedInPlaceRelation) GetParentType() string

func (*ContainedInPlaceRelation) ProtoMessage 

func (*ContainedInPlaceRelation) ProtoMessage()

func (*ContainedInPlaceRelation) ProtoReflect 

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

func (*ContainedInPlaceRelation) Reset 

func (x *ContainedInPlaceRelation) Reset()

func (*ContainedInPlaceRelation) String 

func (x *ContainedInPlaceRelation) String() string

type DateList 

type DateList struct {
	Dates []string `protobuf:"bytes,1,rep,name=dates,proto3" json:"dates,omitempty"`
	// contains filtered or unexported fields
}

func (*DateList) Descriptor deprecated 

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

Deprecated: Use DateList.ProtoReflect.Descriptor instead.

func (*DateList) GetDates 

func (x *DateList) GetDates() []string

func (*DateList) ProtoMessage 

func (*DateList) ProtoMessage()

func (*DateList) ProtoReflect 

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

func (*DateList) Reset 

func (x *DateList) Reset()

func (*DateList) String 

func (x *DateList) String() string

type EntityInfo 

type EntityInfo struct {
	Name         string   `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	Types        []string `protobuf:"bytes,2,rep,name=types,proto3" json:"types,omitempty"`
	Dcid         string   `protobuf:"bytes,3,opt,name=dcid,proto3" json:"dcid,omitempty"`
	ProvenanceId string   `protobuf:"bytes,4,opt,name=provenance_id,json=provenanceId,proto3" json:"provenance_id,omitempty"`
	Value        string   `protobuf:"bytes,5,opt,name=value,proto3" json:"value,omitempty"` // Only for object value.
	// contains filtered or unexported fields
}

Basic info for an entity (subject or object).

func (*EntityInfo) Descriptor deprecated 

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

Deprecated: Use EntityInfo.ProtoReflect.Descriptor instead.

func (*EntityInfo) GetDcid 

func (x *EntityInfo) GetDcid() string

func (*EntityInfo) GetName 

func (x *EntityInfo) GetName() string

func (*EntityInfo) GetProvenanceId 

func (x *EntityInfo) GetProvenanceId() string

func (*EntityInfo) GetTypes 

func (x *EntityInfo) GetTypes() []string

func (*EntityInfo) GetValue 

func (x *EntityInfo) GetValue() string

func (*EntityInfo) ProtoMessage 

func (*EntityInfo) ProtoMessage()

func (*EntityInfo) ProtoReflect 

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

func (*EntityInfo) Reset 

func (x *EntityInfo) Reset()

func (*EntityInfo) String 

func (x *EntityInfo) String() string

type EntityInfoCollection 

type EntityInfoCollection struct {
	Entities   []*EntityInfo `protobuf:"bytes,1,rep,name=entities,proto3" json:"entities,omitempty"`
	TotalCount int64         `protobuf:"varint,2,opt,name=total_count,json=totalCount,proto3" json:"total_count,omitempty"` // Before potential truncation.
	// contains filtered or unexported fields
}

Basic info for a collection of entities.

func (*EntityInfoCollection) Descriptor deprecated 

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

Deprecated: Use EntityInfoCollection.ProtoReflect.Descriptor instead.

func (*EntityInfoCollection) GetEntities 

func (x *EntityInfoCollection) GetEntities() []*EntityInfo

func (*EntityInfoCollection) GetTotalCount 

func (x *EntityInfoCollection) GetTotalCount() int64

func (*EntityInfoCollection) ProtoMessage 

func (*EntityInfoCollection) ProtoMessage()

func (*EntityInfoCollection) ProtoReflect 

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

func (*EntityInfoCollection) Reset 

func (x *EntityInfoCollection) Reset()

func (*EntityInfoCollection) String 

func (x *EntityInfoCollection) String() string

type GetLandingPageDataRequest 

type GetLandingPageDataRequest struct {

	// The dcid of the place.
	Place string `protobuf:"bytes,1,opt,name=place,proto3" json:"place,omitempty"`
	// A list of additional stat vars need to be fetched in addition to the
	// data in cache. This is to be used in local development, where new chart is
	// added to chart config but data is not added to cache (delay from cache
	// build).
	NewStatVars []string `protobuf:"bytes,4,rep,name=new_stat_vars,json=newStatVars,proto3" json:"new_stat_vars,omitempty"`
	// Seed value for random selection. Used by test to get deterministic result.
	Seed int64 `protobuf:"varint,3,opt,name=seed,proto3" json:"seed,omitempty"`
	// contains filtered or unexported fields
}

Request to get all stat data in landing page for a place.

func (*GetLandingPageDataRequest) Descriptor deprecated 

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

Deprecated: Use GetLandingPageDataRequest.ProtoReflect.Descriptor instead.

func (*GetLandingPageDataRequest) GetNewStatVars added in v1.20.3 

func (x *GetLandingPageDataRequest) GetNewStatVars() []string

func (*GetLandingPageDataRequest) GetPlace 

func (x *GetLandingPageDataRequest) GetPlace() string

func (*GetLandingPageDataRequest) GetSeed 

func (x *GetLandingPageDataRequest) GetSeed() int64

func (*GetLandingPageDataRequest) ProtoMessage 

func (*GetLandingPageDataRequest) ProtoMessage()

func (*GetLandingPageDataRequest) ProtoReflect 

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

func (*GetLandingPageDataRequest) Reset 

func (x *GetLandingPageDataRequest) Reset()

func (*GetLandingPageDataRequest) String 

func (x *GetLandingPageDataRequest) String() string

type GetLandingPageDataResponse 

type GetLandingPageDataResponse struct {

	// Keyed by place dcid.
	StatVarSeries   map[string]*StatVarSeries `` /* 190-byte string literal not displayed */
	AllChildPlaces  map[string]*Places        `` /* 193-byte string literal not displayed */
	ChildPlacesType string                    `protobuf:"bytes,3,opt,name=child_places_type,json=childPlacesType,proto3" json:"child_places_type,omitempty"`
	ChildPlaces     []string                  `protobuf:"bytes,4,rep,name=child_places,json=childPlaces,proto3" json:"child_places,omitempty"`
	ParentPlaces    []string                  `protobuf:"bytes,5,rep,name=parent_places,json=parentPlaces,proto3" json:"parent_places,omitempty"`
	SimilarPlaces   []string                  `protobuf:"bytes,6,rep,name=similar_places,json=similarPlaces,proto3" json:"similar_places,omitempty"`
	NearbyPlaces    []string                  `protobuf:"bytes,7,rep,name=nearby_places,json=nearbyPlaces,proto3" json:"nearby_places,omitempty"`
	// contains filtered or unexported fields
}

Response to get landing page info for a place.

func (*GetLandingPageDataResponse) Descriptor deprecated 

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

Deprecated: Use GetLandingPageDataResponse.ProtoReflect.Descriptor instead.

func (*GetLandingPageDataResponse) GetAllChildPlaces added in v1.20.3 

func (x *GetLandingPageDataResponse) GetAllChildPlaces() map[string]*Places

func (*GetLandingPageDataResponse) GetChildPlaces added in v1.20.3 

func (x *GetLandingPageDataResponse) GetChildPlaces() []string

func (*GetLandingPageDataResponse) GetChildPlacesType added in v1.20.3 

func (x *GetLandingPageDataResponse) GetChildPlacesType() string

func (*GetLandingPageDataResponse) GetNearbyPlaces added in v1.20.3 

func (x *GetLandingPageDataResponse) GetNearbyPlaces() []string

func (*GetLandingPageDataResponse) GetParentPlaces added in v1.20.3 

func (x *GetLandingPageDataResponse) GetParentPlaces() []string

func (*GetLandingPageDataResponse) GetSimilarPlaces added in v1.20.3 

func (x *GetLandingPageDataResponse) GetSimilarPlaces() []string

func (*GetLandingPageDataResponse) GetStatVarSeries added in v1.20.3 

func (x *GetLandingPageDataResponse) GetStatVarSeries() map[string]*StatVarSeries

func (*GetLandingPageDataResponse) ProtoMessage 

func (*GetLandingPageDataResponse) ProtoMessage()

func (*GetLandingPageDataResponse) ProtoReflect 

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

func (*GetLandingPageDataResponse) Reset 

func (x *GetLandingPageDataResponse) Reset()

func (*GetLandingPageDataResponse) String 

func (x *GetLandingPageDataResponse) String() string

type GetLocationsRankingsRequest 

type GetLocationsRankingsRequest struct {
	StatVarDcids []string `protobuf:"bytes,1,rep,name=stat_var_dcids,json=statVarDcids,proto3" json:"stat_var_dcids,omitempty"`
	// Place type to get rankings for.
	PlaceType string `protobuf:"bytes,2,opt,name=place_type,json=placeType,proto3" json:"place_type,omitempty"`
	// (Optional) Whether to require all related places under the same ancestor.
	WithinPlace string `protobuf:"bytes,3,opt,name=within_place,json=withinPlace,proto3" json:"within_place,omitempty"`
	// (Optional) Whether the computation needs to be based on per capita.
	IsPerCapita bool `protobuf:"varint,4,opt,name=is_per_capita,json=isPerCapita,proto3" json:"is_per_capita,omitempty"`
	// contains filtered or unexported fields
}

Request to get rankings of locations for given stat var DCIDs.

func (*GetLocationsRankingsRequest) Descriptor deprecated 

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

Deprecated: Use GetLocationsRankingsRequest.ProtoReflect.Descriptor instead.

func (*GetLocationsRankingsRequest) GetIsPerCapita 

func (x *GetLocationsRankingsRequest) GetIsPerCapita() bool

func (*GetLocationsRankingsRequest) GetPlaceType 

func (x *GetLocationsRankingsRequest) GetPlaceType() string

func (*GetLocationsRankingsRequest) GetStatVarDcids 

func (x *GetLocationsRankingsRequest) GetStatVarDcids() []string

func (*GetLocationsRankingsRequest) GetWithinPlace 

func (x *GetLocationsRankingsRequest) GetWithinPlace() string

func (*GetLocationsRankingsRequest) ProtoMessage 

func (*GetLocationsRankingsRequest) ProtoMessage()

func (*GetLocationsRankingsRequest) ProtoReflect 

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

func (*GetLocationsRankingsRequest) Reset 

func (x *GetLocationsRankingsRequest) Reset()

func (*GetLocationsRankingsRequest) String 

func (x *GetLocationsRankingsRequest) String() string

type GetLocationsRankingsResponse 

type GetLocationsRankingsResponse struct {
	Payload map[string]*RelatedPlacesInfo `` /* 155-byte string literal not displayed */
	// contains filtered or unexported fields
}

func (*GetLocationsRankingsResponse) Descriptor deprecated 

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

Deprecated: Use GetLocationsRankingsResponse.ProtoReflect.Descriptor instead.

func (*GetLocationsRankingsResponse) GetPayload 

func (x *GetLocationsRankingsResponse) GetPayload() map[string]*RelatedPlacesInfo

func (*GetLocationsRankingsResponse) ProtoMessage 

func (*GetLocationsRankingsResponse) ProtoMessage()

func (*GetLocationsRankingsResponse) ProtoReflect 

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

func (*GetLocationsRankingsResponse) Reset 

func (x *GetLocationsRankingsResponse) Reset()

func (*GetLocationsRankingsResponse) String 

func (x *GetLocationsRankingsResponse) String() string

type GetPlaceObsRequest 

type GetPlaceObsRequest struct {

	// The type of the place.
	PlaceType string `protobuf:"bytes,1,opt,name=place_type,json=placeType,proto3" json:"place_type,omitempty"`
	// The stat var dcid.
	StatVar string `protobuf:"bytes,2,opt,name=stat_var,json=statVar,proto3" json:"stat_var,omitempty"`
	// Observation date.
	Date string `protobuf:"bytes,3,opt,name=date,proto3" json:"date,omitempty"`
	// contains filtered or unexported fields
}

Requests to get observation for all place.

func (*GetPlaceObsRequest) Descriptor deprecated 

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

Deprecated: Use GetPlaceObsRequest.ProtoReflect.Descriptor instead.

func (*GetPlaceObsRequest) GetDate added in v1.19.1 

func (x *GetPlaceObsRequest) GetDate() string

func (*GetPlaceObsRequest) GetPlaceType 

func (x *GetPlaceObsRequest) GetPlaceType() string

func (*GetPlaceObsRequest) GetStatVar added in v1.19.1 

func (x *GetPlaceObsRequest) GetStatVar() string

func (*GetPlaceObsRequest) ProtoMessage 

func (*GetPlaceObsRequest) ProtoMessage()

func (*GetPlaceObsRequest) ProtoReflect 

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

func (*GetPlaceObsRequest) Reset 

func (x *GetPlaceObsRequest) Reset()

func (*GetPlaceObsRequest) String 

func (x *GetPlaceObsRequest) String() string

type GetPlaceStatDateWithinPlaceRequest 

type GetPlaceStatDateWithinPlaceRequest struct {
	AncestorPlace string   `protobuf:"bytes,1,opt,name=ancestor_place,json=ancestorPlace,proto3" json:"ancestor_place,omitempty"`
	PlaceType     string   `protobuf:"bytes,2,opt,name=place_type,json=placeType,proto3" json:"place_type,omitempty"`
	StatVars      []string `protobuf:"bytes,3,rep,name=stat_vars,json=statVars,proto3" json:"stat_vars,omitempty"`
	// contains filtered or unexported fields
}

func (*GetPlaceStatDateWithinPlaceRequest) Descriptor deprecated 

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

Deprecated: Use GetPlaceStatDateWithinPlaceRequest.ProtoReflect.Descriptor instead.

func (*GetPlaceStatDateWithinPlaceRequest) GetAncestorPlace 

func (x *GetPlaceStatDateWithinPlaceRequest) GetAncestorPlace() string

func (*GetPlaceStatDateWithinPlaceRequest) GetPlaceType 

func (x *GetPlaceStatDateWithinPlaceRequest) GetPlaceType() string

func (*GetPlaceStatDateWithinPlaceRequest) GetStatVars 

func (x *GetPlaceStatDateWithinPlaceRequest) GetStatVars() []string

func (*GetPlaceStatDateWithinPlaceRequest) ProtoMessage 

func (*GetPlaceStatDateWithinPlaceRequest) ProtoMessage()

func (*GetPlaceStatDateWithinPlaceRequest) ProtoReflect 

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

func (*GetPlaceStatDateWithinPlaceRequest) Reset 

func (x *GetPlaceStatDateWithinPlaceRequest) Reset()

func (*GetPlaceStatDateWithinPlaceRequest) String 

func (x *GetPlaceStatDateWithinPlaceRequest) String() string

type GetPlaceStatDateWithinPlaceResponse 

type GetPlaceStatDateWithinPlaceResponse struct {

	// Keyed by statVar.
	Data map[string]*DateList `` /* 149-byte string literal not displayed */
	// contains filtered or unexported fields
}

func (*GetPlaceStatDateWithinPlaceResponse) Descriptor deprecated 

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

Deprecated: Use GetPlaceStatDateWithinPlaceResponse.ProtoReflect.Descriptor instead.

func (*GetPlaceStatDateWithinPlaceResponse) GetData 

func (x *GetPlaceStatDateWithinPlaceResponse) GetData() map[string]*DateList

func (*GetPlaceStatDateWithinPlaceResponse) ProtoMessage 

func (*GetPlaceStatDateWithinPlaceResponse) ProtoMessage()

func (*GetPlaceStatDateWithinPlaceResponse) ProtoReflect 

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

func (*GetPlaceStatDateWithinPlaceResponse) Reset 

func (x *GetPlaceStatDateWithinPlaceResponse) Reset()

func (*GetPlaceStatDateWithinPlaceResponse) String 

func (x *GetPlaceStatDateWithinPlaceResponse) String() string

type GetPlaceStatVarsRequest 

type GetPlaceStatVarsRequest struct {

	// DCIDs of the places.
	Dcids []string `protobuf:"bytes,1,rep,name=dcids,proto3" json:"dcids,omitempty"`
	// contains filtered or unexported fields
}

Request message for GetPlaceStatVars API.

func (*GetPlaceStatVarsRequest) Descriptor deprecated 

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

Deprecated: Use GetPlaceStatVarsRequest.ProtoReflect.Descriptor instead.

func (*GetPlaceStatVarsRequest) GetDcids 

func (x *GetPlaceStatVarsRequest) GetDcids() []string

func (*GetPlaceStatVarsRequest) ProtoMessage 

func (*GetPlaceStatVarsRequest) ProtoMessage()

func (*GetPlaceStatVarsRequest) ProtoReflect 

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

func (*GetPlaceStatVarsRequest) Reset 

func (x *GetPlaceStatVarsRequest) Reset()

func (*GetPlaceStatVarsRequest) String 

func (x *GetPlaceStatVarsRequest) String() string

type GetPlaceStatVarsResponse 

type GetPlaceStatVarsResponse struct {

	// A map from place dcid to a list of statistical variable dcids.
	Places map[string]*StatVars `` /* 153-byte string literal not displayed */
	// contains filtered or unexported fields
}

Response message for GetPlaceStatVars API.

func (*GetPlaceStatVarsResponse) Descriptor deprecated 

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

Deprecated: Use GetPlaceStatVarsResponse.ProtoReflect.Descriptor instead.

func (*GetPlaceStatVarsResponse) GetPlaces 

func (x *GetPlaceStatVarsResponse) GetPlaces() map[string]*StatVars

func (*GetPlaceStatVarsResponse) ProtoMessage 

func (*GetPlaceStatVarsResponse) ProtoMessage()

func (*GetPlaceStatVarsResponse) ProtoReflect 

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

func (*GetPlaceStatVarsResponse) Reset 

func (x *GetPlaceStatVarsResponse) Reset()

func (*GetPlaceStatVarsResponse) String 

func (x *GetPlaceStatVarsResponse) String() string

type GetPlaceStatVarsUnionRequest 

type GetPlaceStatVarsUnionRequest struct {

	// DCIDs of the places.
	Dcids []string `protobuf:"bytes,1,rep,name=dcids,proto3" json:"dcids,omitempty"`
	// contains filtered or unexported fields
}

Request message for GetPlaceStatVarsUnion API.

func (*GetPlaceStatVarsUnionRequest) Descriptor deprecated 

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

Deprecated: Use GetPlaceStatVarsUnionRequest.ProtoReflect.Descriptor instead.

func (*GetPlaceStatVarsUnionRequest) GetDcids 

func (x *GetPlaceStatVarsUnionRequest) GetDcids() []string

func (*GetPlaceStatVarsUnionRequest) ProtoMessage 

func (*GetPlaceStatVarsUnionRequest) ProtoMessage()

func (*GetPlaceStatVarsUnionRequest) ProtoReflect 

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

func (*GetPlaceStatVarsUnionRequest) Reset 

func (x *GetPlaceStatVarsUnionRequest) Reset()

func (*GetPlaceStatVarsUnionRequest) String 

func (x *GetPlaceStatVarsUnionRequest) String() string

type GetPlaceStatVarsUnionResponse 

type GetPlaceStatVarsUnionResponse struct {
	StatVars *StatVars `protobuf:"bytes,1,opt,name=stat_vars,json=statVars,proto3" json:"stat_vars,omitempty"`
	// contains filtered or unexported fields
}

TODO(shifucun): remove this when GetPlaceStatVarsUnionV1 is live. Response message for GetPlaceStatVarsUnion API.

func (*GetPlaceStatVarsUnionResponse) Descriptor deprecated 

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

Deprecated: Use GetPlaceStatVarsUnionResponse.ProtoReflect.Descriptor instead.

func (*GetPlaceStatVarsUnionResponse) GetStatVars 

func (x *GetPlaceStatVarsUnionResponse) GetStatVars() *StatVars

func (*GetPlaceStatVarsUnionResponse) ProtoMessage 

func (*GetPlaceStatVarsUnionResponse) ProtoMessage()

func (*GetPlaceStatVarsUnionResponse) ProtoReflect 

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

func (*GetPlaceStatVarsUnionResponse) Reset 

func (x *GetPlaceStatVarsUnionResponse) Reset()

func (*GetPlaceStatVarsUnionResponse) String 

func (x *GetPlaceStatVarsUnionResponse) String() string

type GetPlaceStatVarsUnionResponseV1 added in v1.20.3 

type GetPlaceStatVarsUnionResponseV1 struct {
	StatVars []string `protobuf:"bytes,1,rep,name=stat_vars,json=statVars,proto3" json:"stat_vars,omitempty"`
	// contains filtered or unexported fields
}

Response message for GetPlaceStatVarsUnionV1 API.

func (*GetPlaceStatVarsUnionResponseV1) Descriptor deprecated added in v1.20.3 

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

Deprecated: Use GetPlaceStatVarsUnionResponseV1.ProtoReflect.Descriptor instead.

func (*GetPlaceStatVarsUnionResponseV1) GetStatVars added in v1.20.3 

func (x *GetPlaceStatVarsUnionResponseV1) GetStatVars() []string

func (*GetPlaceStatVarsUnionResponseV1) ProtoMessage added in v1.20.3 

func (*GetPlaceStatVarsUnionResponseV1) ProtoMessage()

func (*GetPlaceStatVarsUnionResponseV1) ProtoReflect added in v1.20.3 

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

func (*GetPlaceStatVarsUnionResponseV1) Reset added in v1.20.3 

func (x *GetPlaceStatVarsUnionResponseV1) Reset()

func (*GetPlaceStatVarsUnionResponseV1) String added in v1.20.3 

func (x *GetPlaceStatVarsUnionResponseV1) String() string

type GetPlaceStatsVarRequest 

type GetPlaceStatsVarRequest struct {

	// DCIDs of the places.
	Dcids []string `protobuf:"bytes,1,rep,name=dcids,proto3" json:"dcids,omitempty"`
	// contains filtered or unexported fields
}

Request message for GetPlaceStats API.

func (*GetPlaceStatsVarRequest) Descriptor deprecated 

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

Deprecated: Use GetPlaceStatsVarRequest.ProtoReflect.Descriptor instead.

func (*GetPlaceStatsVarRequest) GetDcids 

func (x *GetPlaceStatsVarRequest) GetDcids() []string

func (*GetPlaceStatsVarRequest) ProtoMessage 

func (*GetPlaceStatsVarRequest) ProtoMessage()

func (*GetPlaceStatsVarRequest) ProtoReflect 

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

func (*GetPlaceStatsVarRequest) Reset 

func (x *GetPlaceStatsVarRequest) Reset()

func (*GetPlaceStatsVarRequest) String 

func (x *GetPlaceStatsVarRequest) String() string

type GetPlaceStatsVarResponse 

type GetPlaceStatsVarResponse struct {

	// A map from place dcid to a list of statistical variable dcids.
	Places map[string]*StatsVars `` /* 153-byte string literal not displayed */
	// contains filtered or unexported fields
}

Response message for GetPlaceStats API.

func (*GetPlaceStatsVarResponse) Descriptor deprecated 

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

Deprecated: Use GetPlaceStatsVarResponse.ProtoReflect.Descriptor instead.

func (*GetPlaceStatsVarResponse) GetPlaces 

func (x *GetPlaceStatsVarResponse) GetPlaces() map[string]*StatsVars

func (*GetPlaceStatsVarResponse) ProtoMessage 

func (*GetPlaceStatsVarResponse) ProtoMessage()

func (*GetPlaceStatsVarResponse) ProtoReflect 

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

func (*GetPlaceStatsVarResponse) Reset 

func (x *GetPlaceStatsVarResponse) Reset()

func (*GetPlaceStatsVarResponse) String 

func (x *GetPlaceStatsVarResponse) String() string

type GetPlacesInRequest 

type GetPlacesInRequest struct {

	// The parent place dcids.
	Dcids []string `protobuf:"bytes,1,rep,name=dcids,proto3" json:"dcids,omitempty"`
	// The child place type.
	PlaceType string `protobuf:"bytes,2,opt,name=place_type,json=placeType,proto3" json:"place_type,omitempty"`
	// contains filtered or unexported fields
}

Request to get places that are contained in parent places.

func (*GetPlacesInRequest) Descriptor deprecated 

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

Deprecated: Use GetPlacesInRequest.ProtoReflect.Descriptor instead.

func (*GetPlacesInRequest) GetDcids 

func (x *GetPlacesInRequest) GetDcids() []string

func (*GetPlacesInRequest) GetPlaceType 

func (x *GetPlacesInRequest) GetPlaceType() string

func (*GetPlacesInRequest) ProtoMessage 

func (*GetPlacesInRequest) ProtoMessage()

func (*GetPlacesInRequest) ProtoReflect 

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

func (*GetPlacesInRequest) Reset 

func (x *GetPlacesInRequest) Reset()

func (*GetPlacesInRequest) String 

func (x *GetPlacesInRequest) String() string

type GetPlacesInResponse 

type GetPlacesInResponse struct {

	// The JSON payload.
	Payload string `protobuf:"bytes,1,opt,name=payload,proto3" json:"payload,omitempty"`
	// contains filtered or unexported fields
}

Response of GetPlacesIn.

func (*GetPlacesInResponse) Descriptor deprecated 

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

Deprecated: Use GetPlacesInResponse.ProtoReflect.Descriptor instead.

func (*GetPlacesInResponse) GetPayload 

func (x *GetPlacesInResponse) GetPayload() string

func (*GetPlacesInResponse) ProtoMessage 

func (*GetPlacesInResponse) ProtoMessage()

func (*GetPlacesInResponse) ProtoReflect 

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

func (*GetPlacesInResponse) Reset 

func (x *GetPlacesInResponse) Reset()

func (*GetPlacesInResponse) String 

func (x *GetPlacesInResponse) String() string

type GetPropertyLabelsRequest 

type GetPropertyLabelsRequest struct {

	// The dcids of nodes.
	Dcids []string `protobuf:"bytes,1,rep,name=dcids,proto3" json:"dcids,omitempty"`
	// contains filtered or unexported fields
}

Request to get property labels.

func (*GetPropertyLabelsRequest) Descriptor deprecated 

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

Deprecated: Use GetPropertyLabelsRequest.ProtoReflect.Descriptor instead.

func (*GetPropertyLabelsRequest) GetDcids 

func (x *GetPropertyLabelsRequest) GetDcids() []string

func (*GetPropertyLabelsRequest) ProtoMessage 

func (*GetPropertyLabelsRequest) ProtoMessage()

func (*GetPropertyLabelsRequest) ProtoReflect 

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

func (*GetPropertyLabelsRequest) Reset 

func (x *GetPropertyLabelsRequest) Reset()

func (*GetPropertyLabelsRequest) String 

func (x *GetPropertyLabelsRequest) String() string

type GetPropertyLabelsResponse 

type GetPropertyLabelsResponse struct {

	// The JSON payload.
	Payload string `protobuf:"bytes,1,opt,name=payload,proto3" json:"payload,omitempty"`
	// contains filtered or unexported fields
}

Response returned by GetPropertyLabels.

func (*GetPropertyLabelsResponse) Descriptor deprecated 

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

Deprecated: Use GetPropertyLabelsResponse.ProtoReflect.Descriptor instead.

func (*GetPropertyLabelsResponse) GetPayload 

func (x *GetPropertyLabelsResponse) GetPayload() string

func (*GetPropertyLabelsResponse) ProtoMessage 

func (*GetPropertyLabelsResponse) ProtoMessage()

func (*GetPropertyLabelsResponse) ProtoReflect 

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

func (*GetPropertyLabelsResponse) Reset 

func (x *GetPropertyLabelsResponse) Reset()

func (*GetPropertyLabelsResponse) String 

func (x *GetPropertyLabelsResponse) String() string

type GetPropertyValuesRequest 

type GetPropertyValuesRequest struct {

	// The dcids of nodes to query for.
	Dcids []string `protobuf:"bytes,1,rep,name=dcids,proto3" json:"dcids,omitempty"`
	// The type of the neighboring node to query for.
	ValueType string `protobuf:"bytes,2,opt,name=value_type,json=valueType,proto3" json:"value_type,omitempty"`
	// The property to get adjacent nodes for.
	Property string `protobuf:"bytes,3,opt,name=property,proto3" json:"property,omitempty"`
	// Maximum number of nodes to query for.
	Limit int32 `protobuf:"varint,4,opt,name=limit,proto3" json:"limit,omitempty"`
	// Direction, "in" or "out", default to "out".
	Direction string `protobuf:"bytes,5,opt,name=direction,proto3" json:"direction,omitempty"`
	// contains filtered or unexported fields
}

Request to get all neighboring nodes along an edge labeled by a property.

func (*GetPropertyValuesRequest) Descriptor deprecated 

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

Deprecated: Use GetPropertyValuesRequest.ProtoReflect.Descriptor instead.

func (*GetPropertyValuesRequest) GetDcids 

func (x *GetPropertyValuesRequest) GetDcids() []string

func (*GetPropertyValuesRequest) GetDirection 

func (x *GetPropertyValuesRequest) GetDirection() string

func (*GetPropertyValuesRequest) GetLimit 

func (x *GetPropertyValuesRequest) GetLimit() int32

func (*GetPropertyValuesRequest) GetProperty 

func (x *GetPropertyValuesRequest) GetProperty() string

func (*GetPropertyValuesRequest) GetValueType 

func (x *GetPropertyValuesRequest) GetValueType() string

func (*GetPropertyValuesRequest) ProtoMessage 

func (*GetPropertyValuesRequest) ProtoMessage()

func (*GetPropertyValuesRequest) ProtoReflect 

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

func (*GetPropertyValuesRequest) Reset 

func (x *GetPropertyValuesRequest) Reset()

func (*GetPropertyValuesRequest) String 

func (x *GetPropertyValuesRequest) String() string

type GetPropertyValuesResponse 

type GetPropertyValuesResponse struct {

	// The JSON payload.
	Payload string `protobuf:"bytes,1,opt,name=payload,proto3" json:"payload,omitempty"`
	// contains filtered or unexported fields
}

Response returned by GetPropertyValues.

func (*GetPropertyValuesResponse) Descriptor deprecated 

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

Deprecated: Use GetPropertyValuesResponse.ProtoReflect.Descriptor instead.

func (*GetPropertyValuesResponse) GetPayload 

func (x *GetPropertyValuesResponse) GetPayload() string

func (*GetPropertyValuesResponse) ProtoMessage 

func (*GetPropertyValuesResponse) ProtoMessage()

func (*GetPropertyValuesResponse) ProtoReflect 

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

func (*GetPropertyValuesResponse) Reset 

func (x *GetPropertyValuesResponse) Reset()

func (*GetPropertyValuesResponse) String 

func (x *GetPropertyValuesResponse) String() string

type GetRelatedLocationsRequest 

type GetRelatedLocationsRequest struct {

	// Place DCID.
	Dcid         string   `protobuf:"bytes,1,opt,name=dcid,proto3" json:"dcid,omitempty"`
	StatVarDcids []string `protobuf:"bytes,2,rep,name=stat_var_dcids,json=statVarDcids,proto3" json:"stat_var_dcids,omitempty"`
	// (Optional) Whether to require all related places under the same ancestor.
	WithinPlace string `protobuf:"bytes,4,opt,name=within_place,json=withinPlace,proto3" json:"within_place,omitempty"`
	// (Optional) Whether the computation needs to be based on per capita.
	IsPerCapita bool `protobuf:"varint,5,opt,name=is_per_capita,json=isPerCapita,proto3" json:"is_per_capita,omitempty"`
	// contains filtered or unexported fields
}

Request to get related locations of a place for given stat var DCIDs.

func (*GetRelatedLocationsRequest) Descriptor deprecated 

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

Deprecated: Use GetRelatedLocationsRequest.ProtoReflect.Descriptor instead.

func (*GetRelatedLocationsRequest) GetDcid 

func (x *GetRelatedLocationsRequest) GetDcid() string

func (*GetRelatedLocationsRequest) GetIsPerCapita 

func (x *GetRelatedLocationsRequest) GetIsPerCapita() bool

func (*GetRelatedLocationsRequest) GetStatVarDcids 

func (x *GetRelatedLocationsRequest) GetStatVarDcids() []string

func (*GetRelatedLocationsRequest) GetWithinPlace 

func (x *GetRelatedLocationsRequest) GetWithinPlace() string

func (*GetRelatedLocationsRequest) ProtoMessage 

func (*GetRelatedLocationsRequest) ProtoMessage()

func (*GetRelatedLocationsRequest) ProtoReflect 

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

func (*GetRelatedLocationsRequest) Reset 

func (x *GetRelatedLocationsRequest) Reset()

func (*GetRelatedLocationsRequest) String 

func (x *GetRelatedLocationsRequest) String() string

type GetRelatedLocationsResponse 

type GetRelatedLocationsResponse struct {

	// The JSON payload.
	Payload string `protobuf:"bytes,1,opt,name=payload,proto3" json:"payload,omitempty"`
	// contains filtered or unexported fields
}

Response of GetRelatedLocations request.

func (*GetRelatedLocationsResponse) Descriptor deprecated 

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

Deprecated: Use GetRelatedLocationsResponse.ProtoReflect.Descriptor instead.

func (*GetRelatedLocationsResponse) GetPayload 

func (x *GetRelatedLocationsResponse) GetPayload() string

func (*GetRelatedLocationsResponse) ProtoMessage 

func (*GetRelatedLocationsResponse) ProtoMessage()

func (*GetRelatedLocationsResponse) ProtoReflect 

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

func (*GetRelatedLocationsResponse) Reset 

func (x *GetRelatedLocationsResponse) Reset()

func (*GetRelatedLocationsResponse) String 

func (x *GetRelatedLocationsResponse) String() string

type GetStatAllRequest 

type GetStatAllRequest struct {

	// dcids of the place.
	Places []string `protobuf:"bytes,1,rep,name=places,proto3" json:"places,omitempty"`
	// dcids of the stat var.
	StatVars []string `protobuf:"bytes,2,rep,name=stat_vars,json=statVars,proto3" json:"stat_vars,omitempty"`
	// contains filtered or unexported fields
}

Request for GetStatAll service.

func (*GetStatAllRequest) Descriptor deprecated 

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

Deprecated: Use GetStatAllRequest.ProtoReflect.Descriptor instead.

func (*GetStatAllRequest) GetPlaces 

func (x *GetStatAllRequest) GetPlaces() []string

func (*GetStatAllRequest) GetStatVars 

func (x *GetStatAllRequest) GetStatVars() []string

func (*GetStatAllRequest) ProtoMessage 

func (*GetStatAllRequest) ProtoMessage()

func (*GetStatAllRequest) ProtoReflect 

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

func (*GetStatAllRequest) Reset 

func (x *GetStatAllRequest) Reset()

func (*GetStatAllRequest) String 

func (x *GetStatAllRequest) String() string

type GetStatAllResponse 

type GetStatAllResponse struct {
	PlaceData map[string]*PlaceStat `` /* 176-byte string literal not displayed */
	// contains filtered or unexported fields
}

Response for GetStatAll service.

The response is a two level map, with the first level keyed by place dcid, and the second level keyed by the stat var dcid. Each leaf object contains multiple source series with <date, value> object and observation metadata.

The response is transcoded by esp: https://cloud.google.com/endpoints/docs/grpc/grpc-service-config Example response after esp transcoding is like below. 

{
  placeData: {
    "geoId/01": {
      statVarData: {
        "statvar1": {
          "placeName": "City of Mountain View",
          "sourceSeries": [
            {
              "val": {
                "2008": 2116,
                "2009": 2155,
                "2010": 1633,
                "2011": 1509,
                "2012": 1581,
                "2013": 1867,
                "2014": 1770,
                "2015": 2201,
                "2016": 1913,
                "2017": 2138
              },
              "observationPeriod": "P1Y",
              "importName": "FBIGovCrime",
              "provenanceDomain": "fbi.gov"
            }
          ]
        },
      }
    },
    "geoId/02": {
      statVarData: {
        "statvar3": {...},
      }
    }
  }
}

func (*GetStatAllResponse) Descriptor deprecated 

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

Deprecated: Use GetStatAllResponse.ProtoReflect.Descriptor instead.

func (*GetStatAllResponse) GetPlaceData 

func (x *GetStatAllResponse) GetPlaceData() map[string]*PlaceStat

func (*GetStatAllResponse) ProtoMessage 

func (*GetStatAllResponse) ProtoMessage()

func (*GetStatAllResponse) ProtoReflect 

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

func (*GetStatAllResponse) Reset 

func (x *GetStatAllResponse) Reset()

func (*GetStatAllResponse) String 

func (x *GetStatAllResponse) String() string

type GetStatSeriesRequest 

type GetStatSeriesRequest struct {

	// dcid of the place.
	Place string `protobuf:"bytes,1,opt,name=place,proto3" json:"place,omitempty"`
	// dcid of the stat var.
	StatVar string `protobuf:"bytes,2,opt,name=stat_var,json=statVar,proto3" json:"stat_var,omitempty"`
	// (optional) measurement method of the observation, ex: "CensusACS5yrSurvey".
	MeasurementMethod string `protobuf:"bytes,3,opt,name=measurement_method,json=measurementMethod,proto3" json:"measurement_method,omitempty"`
	// (optional) observation period of the observation, ex: "P1Y".
	ObservationPeriod string `protobuf:"bytes,4,opt,name=observation_period,json=observationPeriod,proto3" json:"observation_period,omitempty"`
	// (optional) unit of the observation.
	Unit string `protobuf:"bytes,5,opt,name=unit,proto3" json:"unit,omitempty"`
	// (optional) scaling factor of the observation.
	ScalingFactor string `protobuf:"bytes,6,opt,name=scaling_factor,json=scalingFactor,proto3" json:"scaling_factor,omitempty"`
	// contains filtered or unexported fields
}

Request for GetStatSeries service.

func (*GetStatSeriesRequest) Descriptor deprecated 

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

Deprecated: Use GetStatSeriesRequest.ProtoReflect.Descriptor instead.

func (*GetStatSeriesRequest) GetMeasurementMethod 

func (x *GetStatSeriesRequest) GetMeasurementMethod() string

func (*GetStatSeriesRequest) GetObservationPeriod 

func (x *GetStatSeriesRequest) GetObservationPeriod() string

func (*GetStatSeriesRequest) GetPlace 

func (x *GetStatSeriesRequest) GetPlace() string

func (*GetStatSeriesRequest) GetScalingFactor 

func (x *GetStatSeriesRequest) GetScalingFactor() string

func (*GetStatSeriesRequest) GetStatVar 

func (x *GetStatSeriesRequest) GetStatVar() string

func (*GetStatSeriesRequest) GetUnit 

func (x *GetStatSeriesRequest) GetUnit() string

func (*GetStatSeriesRequest) ProtoMessage 

func (*GetStatSeriesRequest) ProtoMessage()

func (*GetStatSeriesRequest) ProtoReflect 

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

func (*GetStatSeriesRequest) Reset 

func (x *GetStatSeriesRequest) Reset()

func (*GetStatSeriesRequest) String 

func (x *GetStatSeriesRequest) String() string

type GetStatSeriesResponse 

type GetStatSeriesResponse struct {

	// A map from ISO date to stat value.
	Series map[string]float64 `` /* 155-byte string literal not displayed */
	// contains filtered or unexported fields
}

Response for GetStatSeries service.

func (*GetStatSeriesResponse) Descriptor deprecated 

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

Deprecated: Use GetStatSeriesResponse.ProtoReflect.Descriptor instead.

func (*GetStatSeriesResponse) GetSeries 

func (x *GetStatSeriesResponse) GetSeries() map[string]float64

func (*GetStatSeriesResponse) ProtoMessage 

func (*GetStatSeriesResponse) ProtoMessage()

func (*GetStatSeriesResponse) ProtoReflect 

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

func (*GetStatSeriesResponse) Reset 

func (x *GetStatSeriesResponse) Reset()

func (*GetStatSeriesResponse) String 

func (x *GetStatSeriesResponse) String() string

type GetStatSetRequest 

type GetStatSetRequest struct {

	// A list of place DCIDs.
	Places []string `protobuf:"bytes,1,rep,name=places,proto3" json:"places,omitempty"`
	// A list of statistical variable DCIDs.
	StatVars []string `protobuf:"bytes,2,rep,name=stat_vars,json=statVars,proto3" json:"stat_vars,omitempty"`
	// (Optional) date of the stat.
	// If not sepcified, the latest stat of a chosen source will be returned.
	Date string `protobuf:"bytes,3,opt,name=date,proto3" json:"date,omitempty"`
	// contains filtered or unexported fields
}

func (*GetStatSetRequest) Descriptor deprecated 

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

Deprecated: Use GetStatSetRequest.ProtoReflect.Descriptor instead.

func (*GetStatSetRequest) GetDate 

func (x *GetStatSetRequest) GetDate() string

func (*GetStatSetRequest) GetPlaces 

func (x *GetStatSetRequest) GetPlaces() []string

func (*GetStatSetRequest) GetStatVars 

func (x *GetStatSetRequest) GetStatVars() []string

func (*GetStatSetRequest) ProtoMessage 

func (*GetStatSetRequest) ProtoMessage()

func (*GetStatSetRequest) ProtoReflect 

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

func (*GetStatSetRequest) Reset 

func (x *GetStatSetRequest) Reset()

func (*GetStatSetRequest) String 

func (x *GetStatSetRequest) String() string

type GetStatSetResponse 

type GetStatSetResponse struct {

	// Keyed by statVar.
	Data map[string]*PlacePointStat `` /* 149-byte string literal not displayed */
	// contains filtered or unexported fields
}

func (*GetStatSetResponse) Descriptor deprecated 

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

Deprecated: Use GetStatSetResponse.ProtoReflect.Descriptor instead.

func (*GetStatSetResponse) GetData 

func (x *GetStatSetResponse) GetData() map[string]*PlacePointStat

func (*GetStatSetResponse) ProtoMessage 

func (*GetStatSetResponse) ProtoMessage()

func (*GetStatSetResponse) ProtoReflect 

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

func (*GetStatSetResponse) Reset 

func (x *GetStatSetResponse) Reset()

func (*GetStatSetResponse) String 

func (x *GetStatSetResponse) String() string

type GetStatSetSeriesRequest added in v1.14.0 

type GetStatSetSeriesRequest struct {

	// The dcids of the place.
	Places []string `protobuf:"bytes,1,rep,name=places,proto3" json:"places,omitempty"`
	// The dcids of the statistical variables.
	StatVars []string `protobuf:"bytes,2,rep,name=stat_vars,json=statVars,proto3" json:"stat_vars,omitempty"`
	// contains filtered or unexported fields
}

Request for GetStatSetSeries API. TODO(shifucun): Deprecate GetStats() once all clients are switched to use this API. Request message for GetStatSetSeries.

func (*GetStatSetSeriesRequest) Descriptor deprecated added in v1.14.0 

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

Deprecated: Use GetStatSetSeriesRequest.ProtoReflect.Descriptor instead.

func (*GetStatSetSeriesRequest) GetPlaces added in v1.14.0 

func (x *GetStatSetSeriesRequest) GetPlaces() []string

func (*GetStatSetSeriesRequest) GetStatVars added in v1.14.0 

func (x *GetStatSetSeriesRequest) GetStatVars() []string

func (*GetStatSetSeriesRequest) ProtoMessage added in v1.14.0 

func (*GetStatSetSeriesRequest) ProtoMessage()

func (*GetStatSetSeriesRequest) ProtoReflect added in v1.14.0 

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

func (*GetStatSetSeriesRequest) Reset added in v1.14.0 

func (x *GetStatSetSeriesRequest) Reset()

func (*GetStatSetSeriesRequest) String added in v1.14.0 

func (x *GetStatSetSeriesRequest) String() string

type GetStatSetSeriesResponse added in v1.14.0 

type GetStatSetSeriesResponse struct {

	// A map from place dcid to series map.
	Data map[string]*SeriesMap `` /* 149-byte string literal not displayed */
	// contains filtered or unexported fields
}

Response of GetStatSetSeries

func (*GetStatSetSeriesResponse) Descriptor deprecated added in v1.14.0 

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

Deprecated: Use GetStatSetSeriesResponse.ProtoReflect.Descriptor instead.

func (*GetStatSetSeriesResponse) GetData added in v1.14.0 

func (x *GetStatSetSeriesResponse) GetData() map[string]*SeriesMap

func (*GetStatSetSeriesResponse) ProtoMessage added in v1.14.0 

func (*GetStatSetSeriesResponse) ProtoMessage()

func (*GetStatSetSeriesResponse) ProtoReflect added in v1.14.0 

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

func (*GetStatSetSeriesResponse) Reset added in v1.14.0 

func (x *GetStatSetSeriesResponse) Reset()

func (*GetStatSetSeriesResponse) String added in v1.14.0 

func (x *GetStatSetSeriesResponse) String() string

type GetStatSetWithinPlaceRequest added in v1.19.1 

type GetStatSetWithinPlaceRequest struct {

	// Parent place dcid.
	ParentPlace string `protobuf:"bytes,1,opt,name=parent_place,json=parentPlace,proto3" json:"parent_place,omitempty"`
	// Child place type.
	ChildType string `protobuf:"bytes,2,opt,name=child_type,json=childType,proto3" json:"child_type,omitempty"`
	// Dcid of the stat var.
	StatVars []string `protobuf:"bytes,3,rep,name=stat_vars,json=statVars,proto3" json:"stat_vars,omitempty"`
	// [Optional] Date for the stat in ISO format.
	// If the date is not given, then the latest observation for each place is
	// returned, where they could be from different sources.
	Date string `protobuf:"bytes,4,opt,name=date,proto3" json:"date,omitempty"`
	// contains filtered or unexported fields
}

func (*GetStatSetWithinPlaceRequest) Descriptor deprecated added in v1.19.1 

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

Deprecated: Use GetStatSetWithinPlaceRequest.ProtoReflect.Descriptor instead.

func (*GetStatSetWithinPlaceRequest) GetChildType added in v1.19.1 

func (x *GetStatSetWithinPlaceRequest) GetChildType() string

func (*GetStatSetWithinPlaceRequest) GetDate added in v1.19.1 

func (x *GetStatSetWithinPlaceRequest) GetDate() string

func (*GetStatSetWithinPlaceRequest) GetParentPlace added in v1.19.1 

func (x *GetStatSetWithinPlaceRequest) GetParentPlace() string

func (*GetStatSetWithinPlaceRequest) GetStatVars added in v1.19.1 

func (x *GetStatSetWithinPlaceRequest) GetStatVars() []string

func (*GetStatSetWithinPlaceRequest) ProtoMessage added in v1.19.1 

func (*GetStatSetWithinPlaceRequest) ProtoMessage()

func (*GetStatSetWithinPlaceRequest) ProtoReflect added in v1.19.1 

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

func (*GetStatSetWithinPlaceRequest) Reset added in v1.19.1 

func (x *GetStatSetWithinPlaceRequest) Reset()

func (*GetStatSetWithinPlaceRequest) String added in v1.19.1 

func (x *GetStatSetWithinPlaceRequest) String() string

type GetStatValueRequest 

type GetStatValueRequest struct {

	// dcid of the place.
	Place string `protobuf:"bytes,1,opt,name=place,proto3" json:"place,omitempty"`
	// dcid of the stat var.
	StatVar string `protobuf:"bytes,2,opt,name=stat_var,json=statVar,proto3" json:"stat_var,omitempty"`
	// (optional) date of the stat. The latest date will be used if unspecified.
	Date string `protobuf:"bytes,3,opt,name=date,proto3" json:"date,omitempty"`
	// (optional) measurement method of the observation, ex: "CensusACS5yrSurvey".
	MeasurementMethod string `protobuf:"bytes,4,opt,name=measurement_method,json=measurementMethod,proto3" json:"measurement_method,omitempty"`
	// (optional) observation period of the observation, ex: "P1Y".
	ObservationPeriod string `protobuf:"bytes,5,opt,name=observation_period,json=observationPeriod,proto3" json:"observation_period,omitempty"`
	// (optional) unit of the observation.
	Unit string `protobuf:"bytes,6,opt,name=unit,proto3" json:"unit,omitempty"`
	// (optional) scaling factor of the observation.
	ScalingFactor string `protobuf:"bytes,7,opt,name=scaling_factor,json=scalingFactor,proto3" json:"scaling_factor,omitempty"`
	// contains filtered or unexported fields
}

Request for GetStat service.

func (*GetStatValueRequest) Descriptor deprecated 

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

Deprecated: Use GetStatValueRequest.ProtoReflect.Descriptor instead.

func (*GetStatValueRequest) GetDate 

func (x *GetStatValueRequest) GetDate() string

func (*GetStatValueRequest) GetMeasurementMethod 

func (x *GetStatValueRequest) GetMeasurementMethod() string

func (*GetStatValueRequest) GetObservationPeriod 

func (x *GetStatValueRequest) GetObservationPeriod() string

func (*GetStatValueRequest) GetPlace 

func (x *GetStatValueRequest) GetPlace() string

func (*GetStatValueRequest) GetScalingFactor 

func (x *GetStatValueRequest) GetScalingFactor() string

func (*GetStatValueRequest) GetStatVar 

func (x *GetStatValueRequest) GetStatVar() string

func (*GetStatValueRequest) GetUnit 

func (x *GetStatValueRequest) GetUnit() string

func (*GetStatValueRequest) ProtoMessage 

func (*GetStatValueRequest) ProtoMessage()

func (*GetStatValueRequest) ProtoReflect 

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

func (*GetStatValueRequest) Reset 

func (x *GetStatValueRequest) Reset()

func (*GetStatValueRequest) String 

func (x *GetStatValueRequest) String() string

type GetStatValueResponse 

type GetStatValueResponse struct {
	Value float64 `protobuf:"fixed64,1,opt,name=value,proto3" json:"value,omitempty"`
	// contains filtered or unexported fields
}

func (*GetStatValueResponse) Descriptor deprecated 

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

Deprecated: Use GetStatValueResponse.ProtoReflect.Descriptor instead.

func (*GetStatValueResponse) GetValue 

func (x *GetStatValueResponse) GetValue() float64

func (*GetStatValueResponse) ProtoMessage 

func (*GetStatValueResponse) ProtoMessage()

func (*GetStatValueResponse) ProtoReflect 

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

func (*GetStatValueResponse) Reset 

func (x *GetStatValueResponse) Reset()

func (*GetStatValueResponse) String 

func (x *GetStatValueResponse) String() string

type GetStatVarGroupRequest added in v1.18.0 

type GetStatVarGroupRequest struct {
	Places []string `protobuf:"bytes,2,rep,name=places,proto3" json:"places,omitempty"`
	// contains filtered or unexported fields
}

func (*GetStatVarGroupRequest) Descriptor deprecated added in v1.18.0 

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

Deprecated: Use GetStatVarGroupRequest.ProtoReflect.Descriptor instead.

func (*GetStatVarGroupRequest) GetPlaces added in v1.20.0 

func (x *GetStatVarGroupRequest) GetPlaces() []string

func (*GetStatVarGroupRequest) ProtoMessage added in v1.18.0 

func (*GetStatVarGroupRequest) ProtoMessage()

func (*GetStatVarGroupRequest) ProtoReflect added in v1.18.0 

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

func (*GetStatVarGroupRequest) Reset added in v1.18.0 

func (x *GetStatVarGroupRequest) Reset()

func (*GetStatVarGroupRequest) String added in v1.18.0 

func (x *GetStatVarGroupRequest) String() string

type GetStatsRequest 

type GetStatsRequest struct {

	// The dcids of the place.
	Place []string `protobuf:"bytes,1,rep,name=place,proto3" json:"place,omitempty"`
	// The dcid of the StatisticalVariable.
	StatsVar string `protobuf:"bytes,2,opt,name=stats_var,json=statsVar,proto3" json:"stats_var,omitempty"`
	// (Optional) The measurement method of the observation. If not specified,
	// stats series with any measurement methods could be returned.
	MeasurementMethod string `protobuf:"bytes,4,opt,name=measurement_method,json=measurementMethod,proto3" json:"measurement_method,omitempty"`
	// (Optional) The unit of the observation. If not specified, stats series with
	// any unit could be returned.
	Unit string `protobuf:"bytes,5,opt,name=unit,proto3" json:"unit,omitempty"`
	// (Optional) The observation period of the observation. If not specified,
	// stats series with any observation period could be returned.
	ObservationPeriod string `protobuf:"bytes,6,opt,name=observation_period,json=observationPeriod,proto3" json:"observation_period,omitempty"`
	// contains filtered or unexported fields
}

Request message for GetStats.

func (*GetStatsRequest) Descriptor deprecated 

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

Deprecated: Use GetStatsRequest.ProtoReflect.Descriptor instead.

func (*GetStatsRequest) GetMeasurementMethod 

func (x *GetStatsRequest) GetMeasurementMethod() string

func (*GetStatsRequest) GetObservationPeriod 

func (x *GetStatsRequest) GetObservationPeriod() string

func (*GetStatsRequest) GetPlace 

func (x *GetStatsRequest) GetPlace() []string

func (*GetStatsRequest) GetStatsVar 

func (x *GetStatsRequest) GetStatsVar() string

func (*GetStatsRequest) GetUnit 

func (x *GetStatsRequest) GetUnit() string

func (*GetStatsRequest) ProtoMessage 

func (*GetStatsRequest) ProtoMessage()

func (*GetStatsRequest) ProtoReflect 

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

func (*GetStatsRequest) Reset 

func (x *GetStatsRequest) Reset()

func (*GetStatsRequest) String 

func (x *GetStatsRequest) String() string

type GetStatsResponse 

type GetStatsResponse struct {

	// The JSON payload.
	Payload string `protobuf:"bytes,2,opt,name=payload,proto3" json:"payload,omitempty"`
	// contains filtered or unexported fields
}

Response of GetStats

func (*GetStatsResponse) Descriptor deprecated 

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

Deprecated: Use GetStatsResponse.ProtoReflect.Descriptor instead.

func (*GetStatsResponse) GetPayload 

func (x *GetStatsResponse) GetPayload() string

func (*GetStatsResponse) ProtoMessage 

func (*GetStatsResponse) ProtoMessage()

func (*GetStatsResponse) ProtoReflect 

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

func (*GetStatsResponse) Reset 

func (x *GetStatsResponse) Reset()

func (*GetStatsResponse) String 

func (x *GetStatsResponse) String() string

type GetTriplesRequest 

type GetTriplesRequest struct {

	// The dcids of the nodes to query for.
	Dcids []string `protobuf:"bytes,1,rep,name=dcids,proto3" json:"dcids,omitempty"`
	// Maximum number of triples for each property and type of the neighbor.
	Limit int32 `protobuf:"varint,2,opt,name=limit,proto3" json:"limit,omitempty"`
	// contains filtered or unexported fields
}

Request to get all triples linking to the given nodes.

func (*GetTriplesRequest) Descriptor deprecated 

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

Deprecated: Use GetTriplesRequest.ProtoReflect.Descriptor instead.

func (*GetTriplesRequest) GetDcids 

func (x *GetTriplesRequest) GetDcids() []string

func (*GetTriplesRequest) GetLimit 

func (x *GetTriplesRequest) GetLimit() int32

func (*GetTriplesRequest) ProtoMessage 

func (*GetTriplesRequest) ProtoMessage()

func (*GetTriplesRequest) ProtoReflect 

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

func (*GetTriplesRequest) Reset 

func (x *GetTriplesRequest) Reset()

func (*GetTriplesRequest) String 

func (x *GetTriplesRequest) String() string

type GetTriplesResponse 

type GetTriplesResponse struct {

	// The JSON payload.
	Payload string `protobuf:"bytes,1,opt,name=payload,proto3" json:"payload,omitempty"`
	// contains filtered or unexported fields
}

Response returned by GetTriples.

func (*GetTriplesResponse) Descriptor deprecated 

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

Deprecated: Use GetTriplesResponse.ProtoReflect.Descriptor instead.

func (*GetTriplesResponse) GetPayload 

func (x *GetTriplesResponse) GetPayload() string

func (*GetTriplesResponse) ProtoMessage 

func (*GetTriplesResponse) ProtoMessage()

func (*GetTriplesResponse) ProtoReflect 

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

func (*GetTriplesResponse) Reset 

func (x *GetTriplesResponse) Reset()

func (*GetTriplesResponse) String 

func (x *GetTriplesResponse) String() string

type GetVersionRequest added in v1.18.0 

type GetVersionRequest struct {
	// contains filtered or unexported fields
}

Etmpty request to get version information.

func (*GetVersionRequest) Descriptor deprecated added in v1.18.0 

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

Deprecated: Use GetVersionRequest.ProtoReflect.Descriptor instead.

func (*GetVersionRequest) ProtoMessage added in v1.18.0 

func (*GetVersionRequest) ProtoMessage()

func (*GetVersionRequest) ProtoReflect added in v1.18.0 

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

func (*GetVersionRequest) Reset added in v1.18.0 

func (x *GetVersionRequest) Reset()

func (*GetVersionRequest) String added in v1.18.0 

func (x *GetVersionRequest) String() string

type GetVersionResponse added in v1.18.0 

type GetVersionResponse struct {

	// Store project
	Store string `protobuf:"bytes,1,opt,name=store,proto3" json:"store,omitempty"`
	// Big Query dataset
	BigQuery string `protobuf:"bytes,2,opt,name=big_query,json=bigQuery,proto3" json:"big_query,omitempty"`
	// Bigtable instance
	BigTable string `protobuf:"bytes,3,opt,name=big_table,json=bigTable,proto3" json:"big_table,omitempty"`
	// Github commit hash
	GitHash string `protobuf:"bytes,4,opt,name=git_hash,json=gitHash,proto3" json:"git_hash,omitempty"`
	// contains filtered or unexported fields
}

Get version response.

func (*GetVersionResponse) Descriptor deprecated added in v1.18.0 

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

Deprecated: Use GetVersionResponse.ProtoReflect.Descriptor instead.

func (*GetVersionResponse) GetBigQuery added in v1.18.0 

func (x *GetVersionResponse) GetBigQuery() string

func (*GetVersionResponse) GetBigTable added in v1.18.0 

func (x *GetVersionResponse) GetBigTable() string

func (*GetVersionResponse) GetGitHash added in v1.18.0 

func (x *GetVersionResponse) GetGitHash() string

func (*GetVersionResponse) GetStore added in v1.18.0 

func (x *GetVersionResponse) GetStore() string

func (*GetVersionResponse) ProtoMessage added in v1.18.0 

func (*GetVersionResponse) ProtoMessage()

func (*GetVersionResponse) ProtoReflect added in v1.18.0 

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

func (*GetVersionResponse) Reset added in v1.18.0 

func (x *GetVersionResponse) Reset()

func (*GetVersionResponse) String added in v1.18.0 

func (x *GetVersionResponse) String() string

type MixerClient 

type MixerClient interface {
	// Query DataCommons Graph with Sparql.
	Query(ctx context.Context, in *QueryRequest, opts ...grpc.CallOption) (*QueryResponse, error)
	// Fetch property labels adjacent of nodes
	GetPropertyLabels(ctx context.Context, in *GetPropertyLabelsRequest, opts ...grpc.CallOption) (*GetPropertyLabelsResponse, error)
	// Fetch nodes that linked to source nodes with a given property.
	GetPropertyValues(ctx context.Context, in *GetPropertyValuesRequest, opts ...grpc.CallOption) (*GetPropertyValuesResponse, error)
	// Fetch triples that have the given nodes as subject or object.
	GetTriples(ctx context.Context, in *GetTriplesRequest, opts ...grpc.CallOption) (*GetTriplesResponse, error)
	// Get places contained in parent places.
	GetPlacesIn(ctx context.Context, in *GetPlacesInRequest, opts ...grpc.CallOption) (*GetPlacesInResponse, error)
	// Get observation data for a list of places, given place type, population
	// type, and population constraining properties.
	GetPlaceObs(ctx context.Context, in *GetPlaceObsRequest, opts ...grpc.CallOption) (*SVOCollection, error)
	// Get stats of places by StatisticalVariable. If multiple time series data
	// are avaialable, the highest ranked one by measurement method and import
	// will be returned.
	GetStats(ctx context.Context, in *GetStatsRequest, opts ...grpc.CallOption) (*GetStatsResponse, error)
	// Get stat of a set of places and statistical variables.
	//
	// If multiple time series data are avaialable, the highest ranked one by
	// measurement method, scaling factor and import will be returned.
	// This is a newer version of GetStats() that takes multiple stat vars and
	// returns protobuf field instead of "payload" of json string.
	GetStatSetSeries(ctx context.Context, in *GetStatSetSeriesRequest, opts ...grpc.CallOption) (*GetStatSetSeriesResponse, error)
	// Get a single stat value given a place, a statistical variable and a date.
	// If no date is given, the latest statistical variable will be returned.
	GetStatValue(ctx context.Context, in *GetStatValueRequest, opts ...grpc.CallOption) (*GetStatValueResponse, error)
	// Get a series of stat value with dates, given the place and statistical
	// variable.
	GetStatSeries(ctx context.Context, in *GetStatSeriesRequest, opts ...grpc.CallOption) (*GetStatSeriesResponse, error)
	// Get all stat series given a list of places and a list of statistical
	// variables.
	GetStatAll(ctx context.Context, in *GetStatAllRequest, opts ...grpc.CallOption) (*GetStatAllResponse, error)
	// Get the stat value for children places of certain place type at a given
	// date.
	GetStatSetWithinPlace(ctx context.Context, in *GetStatSetWithinPlaceRequest, opts ...grpc.CallOption) (*GetStatSetResponse, error)
	// Get the stat value for given places and stat vars. If date is not given,
	// then the latest value for each <place, stat var> is returned.
	GetStatSet(ctx context.Context, in *GetStatSetRequest, opts ...grpc.CallOption) (*GetStatSetResponse, error)
	// Get rankings for given stat var DCIDs.
	GetLocationsRankings(ctx context.Context, in *GetLocationsRankingsRequest, opts ...grpc.CallOption) (*GetLocationsRankingsResponse, error)
	// Get related locations for given stat var DCIDs.
	GetRelatedLocations(ctx context.Context, in *GetRelatedLocationsRequest, opts ...grpc.CallOption) (*GetRelatedLocationsResponse, error)
	// Get landing page info for a place.
	GetLandingPageData(ctx context.Context, in *GetLandingPageDataRequest, opts ...grpc.CallOption) (*GetLandingPageDataResponse, error)
	// Translate Sparql Query into translation results.
	Translate(ctx context.Context, in *TranslateRequest, opts ...grpc.CallOption) (*TranslateResponse, error)
	// Given a text search query, return all entities matching the query.
	Search(ctx context.Context, in *SearchRequest, opts ...grpc.CallOption) (*SearchResponse, error)
	// Retrieves the version metadata.
	GetVersion(ctx context.Context, in *GetVersionRequest, opts ...grpc.CallOption) (*GetVersionResponse, error)
	// Give a list of place dcids, return all the statistical variables for each
	// place.
	GetPlaceStatsVar(ctx context.Context, in *GetPlaceStatsVarRequest, opts ...grpc.CallOption) (*GetPlaceStatsVarResponse, error)
	// Give a list of place dcids, return all the statistical variables for each
	// place.
	// TODO(shifucun): Deprecate GetPlaceStatsVar when all internal clients are migrated.
	GetPlaceStatVars(ctx context.Context, in *GetPlaceStatVarsRequest, opts ...grpc.CallOption) (*GetPlaceStatVarsResponse, error)
	// Given a list of place dcids, returns the union of available
	// statistical variables for the places.
	GetPlaceStatVarsUnionV1(ctx context.Context, in *GetPlaceStatVarsUnionRequest, opts ...grpc.CallOption) (*GetPlaceStatVarsUnionResponseV1, error)
	// TODO(shifucun): Deprecate this one after GetPlaceStatVarsUnion is live
	GetPlaceStatVarsUnion(ctx context.Context, in *GetPlaceStatVarsUnionRequest, opts ...grpc.CallOption) (*GetPlaceStatVarsUnionResponse, error)
	// Given ancestor place, child place type and stat vars, return the dates that have
	// data for each stat var across all child places.
	GetPlaceStatDateWithinPlace(ctx context.Context, in *GetPlaceStatDateWithinPlaceRequest, opts ...grpc.CallOption) (*GetPlaceStatDateWithinPlaceResponse, error)
	// Given a place, get the statvar group for stat vars that have data for it.
	GetStatVarGroup(ctx context.Context, in *GetStatVarGroupRequest, opts ...grpc.CallOption) (*StatVarGroups, error)
}

MixerClient is the client API for Mixer service.

For semantics around ctx use and closing/ending streaming RPCs, please refer to https://pkg.go.dev/google.golang.org/grpc/?tab=doc#ClientConn.NewStream.

func NewMixerClient 

func NewMixerClient(cc grpc.ClientConnInterface) MixerClient

type MixerServer 

type MixerServer interface {
	// Query DataCommons Graph with Sparql.
	Query(context.Context, *QueryRequest) (*QueryResponse, error)
	// Fetch property labels adjacent of nodes
	GetPropertyLabels(context.Context, *GetPropertyLabelsRequest) (*GetPropertyLabelsResponse, error)
	// Fetch nodes that linked to source nodes with a given property.
	GetPropertyValues(context.Context, *GetPropertyValuesRequest) (*GetPropertyValuesResponse, error)
	// Fetch triples that have the given nodes as subject or object.
	GetTriples(context.Context, *GetTriplesRequest) (*GetTriplesResponse, error)
	// Get places contained in parent places.
	GetPlacesIn(context.Context, *GetPlacesInRequest) (*GetPlacesInResponse, error)
	// Get observation data for a list of places, given place type, population
	// type, and population constraining properties.
	GetPlaceObs(context.Context, *GetPlaceObsRequest) (*SVOCollection, error)
	// Get stats of places by StatisticalVariable. If multiple time series data
	// are avaialable, the highest ranked one by measurement method and import
	// will be returned.
	GetStats(context.Context, *GetStatsRequest) (*GetStatsResponse, error)
	// Get stat of a set of places and statistical variables.
	//
	// If multiple time series data are avaialable, the highest ranked one by
	// measurement method, scaling factor and import will be returned.
	// This is a newer version of GetStats() that takes multiple stat vars and
	// returns protobuf field instead of "payload" of json string.
	GetStatSetSeries(context.Context, *GetStatSetSeriesRequest) (*GetStatSetSeriesResponse, error)
	// Get a single stat value given a place, a statistical variable and a date.
	// If no date is given, the latest statistical variable will be returned.
	GetStatValue(context.Context, *GetStatValueRequest) (*GetStatValueResponse, error)
	// Get a series of stat value with dates, given the place and statistical
	// variable.
	GetStatSeries(context.Context, *GetStatSeriesRequest) (*GetStatSeriesResponse, error)
	// Get all stat series given a list of places and a list of statistical
	// variables.
	GetStatAll(context.Context, *GetStatAllRequest) (*GetStatAllResponse, error)
	// Get the stat value for children places of certain place type at a given
	// date.
	GetStatSetWithinPlace(context.Context, *GetStatSetWithinPlaceRequest) (*GetStatSetResponse, error)
	// Get the stat value for given places and stat vars. If date is not given,
	// then the latest value for each <place, stat var> is returned.
	GetStatSet(context.Context, *GetStatSetRequest) (*GetStatSetResponse, error)
	// Get rankings for given stat var DCIDs.
	GetLocationsRankings(context.Context, *GetLocationsRankingsRequest) (*GetLocationsRankingsResponse, error)
	// Get related locations for given stat var DCIDs.
	GetRelatedLocations(context.Context, *GetRelatedLocationsRequest) (*GetRelatedLocationsResponse, error)
	// Get landing page info for a place.
	GetLandingPageData(context.Context, *GetLandingPageDataRequest) (*GetLandingPageDataResponse, error)
	// Translate Sparql Query into translation results.
	Translate(context.Context, *TranslateRequest) (*TranslateResponse, error)
	// Given a text search query, return all entities matching the query.
	Search(context.Context, *SearchRequest) (*SearchResponse, error)
	// Retrieves the version metadata.
	GetVersion(context.Context, *GetVersionRequest) (*GetVersionResponse, error)
	// Give a list of place dcids, return all the statistical variables for each
	// place.
	GetPlaceStatsVar(context.Context, *GetPlaceStatsVarRequest) (*GetPlaceStatsVarResponse, error)
	// Give a list of place dcids, return all the statistical variables for each
	// place.
	// TODO(shifucun): Deprecate GetPlaceStatsVar when all internal clients are migrated.
	GetPlaceStatVars(context.Context, *GetPlaceStatVarsRequest) (*GetPlaceStatVarsResponse, error)
	// Given a list of place dcids, returns the union of available
	// statistical variables for the places.
	GetPlaceStatVarsUnionV1(context.Context, *GetPlaceStatVarsUnionRequest) (*GetPlaceStatVarsUnionResponseV1, error)
	// TODO(shifucun): Deprecate this one after GetPlaceStatVarsUnion is live
	GetPlaceStatVarsUnion(context.Context, *GetPlaceStatVarsUnionRequest) (*GetPlaceStatVarsUnionResponse, error)
	// Given ancestor place, child place type and stat vars, return the dates that have
	// data for each stat var across all child places.
	GetPlaceStatDateWithinPlace(context.Context, *GetPlaceStatDateWithinPlaceRequest) (*GetPlaceStatDateWithinPlaceResponse, error)
	// Given a place, get the statvar group for stat vars that have data for it.
	GetStatVarGroup(context.Context, *GetStatVarGroupRequest) (*StatVarGroups, error)
}

MixerServer is the server API for Mixer service. All implementations should embed UnimplementedMixerServer for forward compatibility

type ObsCollection 

type ObsCollection struct {
	SourceCohorts []*SourceSeries `protobuf:"bytes,2,rep,name=source_cohorts,json=sourceCohorts,proto3" json:"source_cohorts,omitempty"`
	// contains filtered or unexported fields
}

A collection of observation values for various places with the same parent and place type, for given measured property, observation period, stat type, observation date, pop type, and an optional list of pop PVs.

func (*ObsCollection) Descriptor deprecated 

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

Deprecated: Use ObsCollection.ProtoReflect.Descriptor instead.

func (*ObsCollection) GetSourceCohorts 

func (x *ObsCollection) GetSourceCohorts() []*SourceSeries

func (*ObsCollection) ProtoMessage 

func (*ObsCollection) ProtoMessage()

func (*ObsCollection) ProtoReflect 

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

func (*ObsCollection) Reset 

func (x *ObsCollection) Reset()

func (*ObsCollection) String 

func (x *ObsCollection) String() string

type ObsTimeSeries 

type ObsTimeSeries struct {
	Data map[string]float64 `` // Date to value.
	/* 151-byte string literal not displayed */
	PlaceName        string          `protobuf:"bytes,3,opt,name=place_name,json=placeName,proto3" json:"place_name,omitempty"`
	PlaceDcid        string          `protobuf:"bytes,5,opt,name=place_dcid,json=placeDcid,proto3" json:"place_dcid,omitempty"` // Only set if the key uses mid.
	SourceSeries     []*SourceSeries `protobuf:"bytes,6,rep,name=source_series,json=sourceSeries,proto3" json:"source_series,omitempty"`
	ProvenanceDomain string          `protobuf:"bytes,7,opt,name=provenance_domain,json=provenanceDomain,proto3" json:"provenance_domain,omitempty"`
	ProvenanceUrl    string          `protobuf:"bytes,8,opt,name=provenance_url,json=provenanceUrl,proto3" json:"provenance_url,omitempty"`
	// contains filtered or unexported fields
}

Represents observation time series data.

func (*ObsTimeSeries) Descriptor deprecated 

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

Deprecated: Use ObsTimeSeries.ProtoReflect.Descriptor instead.

func (*ObsTimeSeries) GetData 

func (x *ObsTimeSeries) GetData() map[string]float64

func (*ObsTimeSeries) GetPlaceDcid 

func (x *ObsTimeSeries) GetPlaceDcid() string

func (*ObsTimeSeries) GetPlaceName 

func (x *ObsTimeSeries) GetPlaceName() string

func (*ObsTimeSeries) GetProvenanceDomain 

func (x *ObsTimeSeries) GetProvenanceDomain() string

func (*ObsTimeSeries) GetProvenanceUrl 

func (x *ObsTimeSeries) GetProvenanceUrl() string

func (*ObsTimeSeries) GetSourceSeries 

func (x *ObsTimeSeries) GetSourceSeries() []*SourceSeries

func (*ObsTimeSeries) ProtoMessage 

func (*ObsTimeSeries) ProtoMessage()

func (*ObsTimeSeries) ProtoReflect 

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

func (*ObsTimeSeries) Reset 

func (x *ObsTimeSeries) Reset()

func (*ObsTimeSeries) String 

func (x *ObsTimeSeries) String() string

type Place added in v1.20.3 

type Place struct {
	Dcid string `protobuf:"bytes,1,opt,name=dcid,proto3" json:"dcid,omitempty"`
	Name string `protobuf:"bytes,2,opt,name=name,proto3" json:"name,omitempty"`
	Pop  int32  `protobuf:"varint,3,opt,name=pop,proto3" json:"pop,omitempty"`
	// contains filtered or unexported fields
}

func (*Place) Descriptor deprecated added in v1.20.3 

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

Deprecated: Use Place.ProtoReflect.Descriptor instead.

func (*Place) GetDcid added in v1.20.3 

func (x *Place) GetDcid() string

func (*Place) GetName added in v1.20.3 

func (x *Place) GetName() string

func (*Place) GetPop added in v1.20.3 

func (x *Place) GetPop() int32

func (*Place) ProtoMessage added in v1.20.3 

func (*Place) ProtoMessage()

func (*Place) ProtoReflect added in v1.20.3 

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

func (*Place) Reset added in v1.20.3 

func (x *Place) Reset()

func (*Place) String added in v1.20.3 

func (x *Place) String() string

type PlacePointStat 

type PlacePointStat struct {

	// Keyed by place DCID.
	Stat map[string]*PointStat `` /* 149-byte string literal not displayed */
	// Keyed by import name.
	Metadata map[string]*StatMetadata `` /* 157-byte string literal not displayed */
	// contains filtered or unexported fields
}

func (*PlacePointStat) Descriptor deprecated 

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

Deprecated: Use PlacePointStat.ProtoReflect.Descriptor instead.

func (*PlacePointStat) GetMetadata added in v1.19.1 

func (x *PlacePointStat) GetMetadata() map[string]*StatMetadata

func (*PlacePointStat) GetStat 

func (x *PlacePointStat) GetStat() map[string]*PointStat

func (*PlacePointStat) ProtoMessage 

func (*PlacePointStat) ProtoMessage()

func (*PlacePointStat) ProtoReflect 

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

func (*PlacePointStat) Reset 

func (x *PlacePointStat) Reset()

func (*PlacePointStat) String 

func (x *PlacePointStat) String() string

type PlaceStat 

type PlaceStat struct {

	// Key is stat var dcid.
	StatVarData map[string]*ObsTimeSeries `` /* 184-byte string literal not displayed */
	// contains filtered or unexported fields
}

TODO(shifucun): deprecate this and use StatVarSeries when migrating /stat/all to v1.

func (*PlaceStat) Descriptor deprecated 

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

Deprecated: Use PlaceStat.ProtoReflect.Descriptor instead.

func (*PlaceStat) GetStatVarData 

func (x *PlaceStat) GetStatVarData() map[string]*ObsTimeSeries

func (*PlaceStat) ProtoMessage 

func (*PlaceStat) ProtoMessage()

func (*PlaceStat) ProtoReflect 

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

func (*PlaceStat) Reset 

func (x *PlaceStat) Reset()

func (*PlaceStat) String 

func (x *PlaceStat) String() string

type Places added in v1.20.3 

type Places struct {
	Places []*Place `protobuf:"bytes,1,rep,name=places,proto3" json:"places,omitempty"`
	// contains filtered or unexported fields
}

func (*Places) Descriptor deprecated added in v1.20.3 

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

Deprecated: Use Places.ProtoReflect.Descriptor instead.

func (*Places) GetPlaces added in v1.20.3 

func (x *Places) GetPlaces() []*Place

func (*Places) ProtoMessage added in v1.20.3 

func (*Places) ProtoMessage()

func (*Places) ProtoReflect added in v1.20.3 

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

func (*Places) Reset added in v1.20.3 

func (x *Places) Reset()

func (*Places) String added in v1.20.3 

func (x *Places) String() string

type PointStat 

type PointStat struct {

	// date in IOS-8601 format
	Date     string        `protobuf:"bytes,1,opt,name=date,proto3" json:"date,omitempty"`
	Value    float64       `protobuf:"fixed64,2,opt,name=value,proto3" json:"value,omitempty"`
	Metadata *StatMetadata `protobuf:"bytes,3,opt,name=metadata,proto3" json:"metadata,omitempty"`
	// contains filtered or unexported fields
}

func (*PointStat) Descriptor deprecated 

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

Deprecated: Use PointStat.ProtoReflect.Descriptor instead.

func (*PointStat) GetDate 

func (x *PointStat) GetDate() string

func (*PointStat) GetMetadata 

func (x *PointStat) GetMetadata() *StatMetadata

func (*PointStat) GetValue 

func (x *PointStat) GetValue() float64

func (*PointStat) ProtoMessage 

func (*PointStat) ProtoMessage()

func (*PointStat) ProtoReflect 

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

func (*PointStat) Reset 

func (x *PointStat) Reset()

func (*PointStat) String 

func (x *PointStat) String() string

type PropertyLabels 

type PropertyLabels struct {
	InLabels  []string `protobuf:"bytes,1,rep,name=in_labels,json=inLabels,proto3" json:"in_labels,omitempty"`
	OutLabels []string `protobuf:"bytes,2,rep,name=out_labels,json=outLabels,proto3" json:"out_labels,omitempty"`
	// contains filtered or unexported fields
}

Full lists of in and out labels for a given node ID.

func (*PropertyLabels) Descriptor deprecated 

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

Deprecated: Use PropertyLabels.ProtoReflect.Descriptor instead.

func (*PropertyLabels) GetInLabels 

func (x *PropertyLabels) GetInLabels() []string

func (*PropertyLabels) GetOutLabels 

func (x *PropertyLabels) GetOutLabels() []string

func (*PropertyLabels) ProtoMessage 

func (*PropertyLabels) ProtoMessage()

func (*PropertyLabels) ProtoReflect 

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

func (*PropertyLabels) Reset 

func (x *PropertyLabels) Reset()

func (*PropertyLabels) String 

func (x *PropertyLabels) String() string

type PropertyValue 

type PropertyValue struct {

	// The property schema
	Property string `protobuf:"bytes,1,opt,name=property,proto3" json:"property,omitempty"`
	// The value in string.
	Value string `protobuf:"bytes,2,opt,name=value,proto3" json:"value,omitempty"`
	// contains filtered or unexported fields
}

Represents a property value pair.

func (*PropertyValue) Descriptor deprecated 

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

Deprecated: Use PropertyValue.ProtoReflect.Descriptor instead.

func (*PropertyValue) GetProperty 

func (x *PropertyValue) GetProperty() string

func (*PropertyValue) GetValue 

func (x *PropertyValue) GetValue() string

func (*PropertyValue) ProtoMessage 

func (*PropertyValue) ProtoMessage()

func (*PropertyValue) ProtoReflect 

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

func (*PropertyValue) Reset 

func (x *PropertyValue) Reset()

func (*PropertyValue) String 

func (x *PropertyValue) String() string

type ProvenanceInfo 

type ProvenanceInfo struct {
	ProvenanceId string `protobuf:"bytes,1,opt,name=provenance_id,json=provenanceId,proto3" json:"provenance_id,omitempty"`
	// Domain is obtained from the source of the provenance.
	Domain     string `protobuf:"bytes,2,opt,name=domain,proto3" json:"domain,omitempty"`
	ImportName string `protobuf:"bytes,3,opt,name=import_name,json=importName,proto3" json:"import_name,omitempty"`
	// contains filtered or unexported fields
}

Essential provenance information.

func (*ProvenanceInfo) Descriptor deprecated 

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

Deprecated: Use ProvenanceInfo.ProtoReflect.Descriptor instead.

func (*ProvenanceInfo) GetDomain 

func (x *ProvenanceInfo) GetDomain() string

func (*ProvenanceInfo) GetImportName 

func (x *ProvenanceInfo) GetImportName() string

func (*ProvenanceInfo) GetProvenanceId 

func (x *ProvenanceInfo) GetProvenanceId() string

func (*ProvenanceInfo) ProtoMessage 

func (*ProvenanceInfo) ProtoMessage()

func (*ProvenanceInfo) ProtoReflect 

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

func (*ProvenanceInfo) Reset 

func (x *ProvenanceInfo) Reset()

func (*ProvenanceInfo) String 

func (x *ProvenanceInfo) String() string

type Provenances 

type Provenances struct {
	Provenances []*ProvenanceInfo `protobuf:"bytes,1,rep,name=provenances,proto3" json:"provenances,omitempty"`
	// contains filtered or unexported fields
}

A full list of provenances.

func (*Provenances) Descriptor deprecated 

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

Deprecated: Use Provenances.ProtoReflect.Descriptor instead.

func (*Provenances) GetProvenances 

func (x *Provenances) GetProvenances() []*ProvenanceInfo

func (*Provenances) ProtoMessage 

func (*Provenances) ProtoMessage()

func (*Provenances) ProtoReflect 

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

func (*Provenances) Reset 

func (x *Provenances) Reset()

func (*Provenances) String 

func (x *Provenances) String() string

type QueryRequest 

type QueryRequest struct {

	// Sparql query string.
	Sparql string `protobuf:"bytes,1,opt,name=sparql,proto3" json:"sparql,omitempty"`
	// contains filtered or unexported fields
}

A graph query request in Sparql query language.

func (*QueryRequest) Descriptor deprecated 

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

Deprecated: Use QueryRequest.ProtoReflect.Descriptor instead.

func (*QueryRequest) GetSparql 

func (x *QueryRequest) GetSparql() string

func (*QueryRequest) ProtoMessage 

func (*QueryRequest) ProtoMessage()

func (*QueryRequest) ProtoReflect 

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

func (*QueryRequest) Reset 

func (x *QueryRequest) Reset()

func (*QueryRequest) String 

func (x *QueryRequest) String() string

type QueryResponse 

type QueryResponse struct {

	// Identifier for selected variable. Size of the header is the same as number
	// of cells for each row.
	Header []string `protobuf:"bytes,1,rep,name=header,proto3" json:"header,omitempty"`
	// Query results, with each row containing cells corresponding to header
	// variable order.
	Rows []*QueryResponseRow `protobuf:"bytes,2,rep,name=rows,proto3" json:"rows,omitempty"`
	// contains filtered or unexported fields
}

Graph query response.

func (*QueryResponse) Descriptor deprecated 

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

Deprecated: Use QueryResponse.ProtoReflect.Descriptor instead.

func (*QueryResponse) GetHeader 

func (x *QueryResponse) GetHeader() []string

func (*QueryResponse) GetRows 

func (x *QueryResponse) GetRows() []*QueryResponseRow

func (*QueryResponse) ProtoMessage 

func (*QueryResponse) ProtoMessage()

func (*QueryResponse) ProtoReflect 

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

func (*QueryResponse) Reset 

func (x *QueryResponse) Reset()

func (*QueryResponse) String 

func (x *QueryResponse) String() string

type QueryResponseCell 

type QueryResponseCell struct {

	// Cell value.
	Value string `protobuf:"bytes,1,opt,name=value,proto3" json:"value,omitempty"`
	// Provenance ID.
	ProvenanceId string `protobuf:"bytes,2,opt,name=provenance_id,json=provenanceId,proto3" json:"provenance_id,omitempty"`
	// contains filtered or unexported fields
}

Cell in the QueryResponse

func (*QueryResponseCell) Descriptor deprecated 

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

Deprecated: Use QueryResponseCell.ProtoReflect.Descriptor instead.

func (*QueryResponseCell) GetProvenanceId 

func (x *QueryResponseCell) GetProvenanceId() string

func (*QueryResponseCell) GetValue 

func (x *QueryResponseCell) GetValue() string

func (*QueryResponseCell) ProtoMessage 

func (*QueryResponseCell) ProtoMessage()

func (*QueryResponseCell) ProtoReflect 

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

func (*QueryResponseCell) Reset 

func (x *QueryResponseCell) Reset()

func (*QueryResponseCell) String 

func (x *QueryResponseCell) String() string

type QueryResponseRow 

type QueryResponseRow struct {

	// A list of QueryResponseCell.
	Cells []*QueryResponseCell `protobuf:"bytes,1,rep,name=cells,proto3" json:"cells,omitempty"`
	// contains filtered or unexported fields
}

A graph query response row corresponding to the query variables in graph query.

func (*QueryResponseRow) Descriptor deprecated 

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

Deprecated: Use QueryResponseRow.ProtoReflect.Descriptor instead.

func (*QueryResponseRow) GetCells 

func (x *QueryResponseRow) GetCells() []*QueryResponseCell

func (*QueryResponseRow) ProtoMessage 

func (*QueryResponseRow) ProtoMessage()

func (*QueryResponseRow) ProtoReflect 

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

func (*QueryResponseRow) Reset 

func (x *QueryResponseRow) Reset()

func (*QueryResponseRow) String 

func (x *QueryResponseRow) String() string

type RelatedPlacesInfo 

type RelatedPlacesInfo struct {

	// The following 3 fields are set only when place is not empty.
	RelatedPlaces  []string `protobuf:"bytes,1,rep,name=related_places,json=relatedPlaces,proto3" json:"related_places,omitempty"`
	RankFromTop    int32    `protobuf:"varint,2,opt,name=rank_from_top,json=rankFromTop,proto3" json:"rank_from_top,omitempty"`          // Starting from 1.
	RankFromBottom int32    `protobuf:"varint,3,opt,name=rank_from_bottom,json=rankFromBottom,proto3" json:"rank_from_bottom,omitempty"` // Starting from 1.
	// The following 3 fields are set only when place is empty.
	RankAll         *RelatedPlacesInfo_Ranking `protobuf:"bytes,7,opt,name=rank_all,json=rankAll,proto3" json:"rank_all,omitempty"`
	RankTop_1000    *RelatedPlacesInfo_Ranking `protobuf:"bytes,8,opt,name=rank_top_1000,json=rankTop1000,proto3" json:"rank_top_1000,omitempty"`
	RankBottom_1000 *RelatedPlacesInfo_Ranking `protobuf:"bytes,9,opt,name=rank_bottom_1000,json=rankBottom1000,proto3" json:"rank_bottom_1000,omitempty"`
	// contains filtered or unexported fields
}

Related places info for a given place and condition.

func (*RelatedPlacesInfo) Descriptor deprecated 

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

Deprecated: Use RelatedPlacesInfo.ProtoReflect.Descriptor instead.

func (*RelatedPlacesInfo) GetRankAll 

func (x *RelatedPlacesInfo) GetRankAll() *RelatedPlacesInfo_Ranking

func (*RelatedPlacesInfo) GetRankBottom_1000 

func (x *RelatedPlacesInfo) GetRankBottom_1000() *RelatedPlacesInfo_Ranking

func (*RelatedPlacesInfo) GetRankFromBottom 

func (x *RelatedPlacesInfo) GetRankFromBottom() int32

func (*RelatedPlacesInfo) GetRankFromTop 

func (x *RelatedPlacesInfo) GetRankFromTop() int32

func (*RelatedPlacesInfo) GetRankTop_1000 

func (x *RelatedPlacesInfo) GetRankTop_1000() *RelatedPlacesInfo_Ranking

func (*RelatedPlacesInfo) GetRelatedPlaces 

func (x *RelatedPlacesInfo) GetRelatedPlaces() []string

func (*RelatedPlacesInfo) ProtoMessage 

func (*RelatedPlacesInfo) ProtoMessage()

func (*RelatedPlacesInfo) ProtoReflect 

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

func (*RelatedPlacesInfo) Reset 

func (x *RelatedPlacesInfo) Reset()

func (*RelatedPlacesInfo) String 

func (x *RelatedPlacesInfo) String() string

type RelatedPlacesInfo_Ranking 

type RelatedPlacesInfo_Ranking struct {
	Info []*RelatedPlacesInfo_Ranking_RankInfo `protobuf:"bytes,1,rep,name=info,proto3" json:"info,omitempty"`
	// contains filtered or unexported fields
}

func (*RelatedPlacesInfo_Ranking) Descriptor deprecated 

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

Deprecated: Use RelatedPlacesInfo_Ranking.ProtoReflect.Descriptor instead.

func (*RelatedPlacesInfo_Ranking) GetInfo 

func (x *RelatedPlacesInfo_Ranking) GetInfo() []*RelatedPlacesInfo_Ranking_RankInfo

func (*RelatedPlacesInfo_Ranking) ProtoMessage 

func (*RelatedPlacesInfo_Ranking) ProtoMessage()

func (*RelatedPlacesInfo_Ranking) ProtoReflect 

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

func (*RelatedPlacesInfo_Ranking) Reset 

func (x *RelatedPlacesInfo_Ranking) Reset()

func (*RelatedPlacesInfo_Ranking) String 

func (x *RelatedPlacesInfo_Ranking) String() string

type RelatedPlacesInfo_Ranking_RankInfo 

type RelatedPlacesInfo_Ranking_RankInfo struct {
	Rank      int32   `protobuf:"varint,1,opt,name=rank,proto3" json:"rank,omitempty"`
	Value     float64 `protobuf:"fixed64,2,opt,name=value,proto3" json:"value,omitempty"`
	PlaceDcid string  `protobuf:"bytes,3,opt,name=place_dcid,json=placeDcid,proto3" json:"place_dcid,omitempty"`
	// contains filtered or unexported fields
}

func (*RelatedPlacesInfo_Ranking_RankInfo) Descriptor deprecated 

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

Deprecated: Use RelatedPlacesInfo_Ranking_RankInfo.ProtoReflect.Descriptor instead.

func (*RelatedPlacesInfo_Ranking_RankInfo) GetPlaceDcid 

func (x *RelatedPlacesInfo_Ranking_RankInfo) GetPlaceDcid() string

func (*RelatedPlacesInfo_Ranking_RankInfo) GetRank 

func (x *RelatedPlacesInfo_Ranking_RankInfo) GetRank() int32

func (*RelatedPlacesInfo_Ranking_RankInfo) GetValue 

func (x *RelatedPlacesInfo_Ranking_RankInfo) GetValue() float64

func (*RelatedPlacesInfo_Ranking_RankInfo) ProtoMessage 

func (*RelatedPlacesInfo_Ranking_RankInfo) ProtoMessage()

func (*RelatedPlacesInfo_Ranking_RankInfo) ProtoReflect 

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

func (*RelatedPlacesInfo_Ranking_RankInfo) Reset 

func (x *RelatedPlacesInfo_Ranking_RankInfo) Reset()

func (*RelatedPlacesInfo_Ranking_RankInfo) String 

func (x *RelatedPlacesInfo_Ranking_RankInfo) String() string

type SVOCollection added in v1.19.1 

type SVOCollection struct {
	Places []*SVOPlace `protobuf:"bytes,1,rep,name=places,proto3" json:"places,omitempty"`
	// contains filtered or unexported fields
}

SVOCollection holds information for multiple SVOPlace instances.

func (*SVOCollection) Descriptor deprecated added in v1.19.1 

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

Deprecated: Use SVOCollection.ProtoReflect.Descriptor instead.

func (*SVOCollection) GetPlaces added in v1.19.1 

func (x *SVOCollection) GetPlaces() []*SVOPlace

func (*SVOCollection) ProtoMessage added in v1.19.1 

func (*SVOCollection) ProtoMessage()

func (*SVOCollection) ProtoReflect added in v1.19.1 

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

func (*SVOCollection) Reset added in v1.19.1 

func (x *SVOCollection) Reset()

func (*SVOCollection) String added in v1.19.1 

func (x *SVOCollection) String() string

type SVOObservation added in v1.19.1 

type SVOObservation struct {
	Dcid              string `protobuf:"bytes,1,opt,name=dcid,proto3" json:"dcid,omitempty"`
	ObservationDate   string `protobuf:"bytes,2,opt,name=observation_date,json=observationDate,proto3" json:"observation_date,omitempty"`
	ObservationPeriod string `protobuf:"bytes,3,opt,name=observation_period,json=observationPeriod,proto3" json:"observation_period,omitempty"`
	MeasurementMethod string `protobuf:"bytes,4,opt,name=measurement_method,json=measurementMethod,proto3" json:"measurement_method,omitempty"`
	Unit              string `protobuf:"bytes,5,opt,name=unit,proto3" json:"unit,omitempty"`
	ScalingFactor     string `protobuf:"bytes,6,opt,name=scaling_factor,json=scalingFactor,proto3" json:"scaling_factor,omitempty"`
	ProvenanceId      string `protobuf:"bytes,7,opt,name=provenance_id,json=provenanceId,proto3" json:"provenance_id,omitempty"`
	// Types that are assignable to Val:
	//	*SVOObservation_StrValue
	//	*SVOObservation_DblValue
	Val  isSVOObservation_Val `protobuf_oneof:"val"`
	Temp *SVOObservation_Temp `protobuf:"bytes,10,opt,name=temp,proto3" json:"temp,omitempty"`
	// contains filtered or unexported fields
}

Stores a StatVarObservation node.

NOTE: Equivalent to legacy PopObsObservation.

func (*SVOObservation) Descriptor deprecated added in v1.19.1 

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

Deprecated: Use SVOObservation.ProtoReflect.Descriptor instead.

func (*SVOObservation) GetDblValue added in v1.19.1 

func (x *SVOObservation) GetDblValue() float64

func (*SVOObservation) GetDcid added in v1.19.1 

func (x *SVOObservation) GetDcid() string

func (*SVOObservation) GetMeasurementMethod added in v1.19.1 

func (x *SVOObservation) GetMeasurementMethod() string

func (*SVOObservation) GetObservationDate added in v1.19.1 

func (x *SVOObservation) GetObservationDate() string

func (*SVOObservation) GetObservationPeriod added in v1.19.1 

func (x *SVOObservation) GetObservationPeriod() string

func (*SVOObservation) GetProvenanceId added in v1.19.1 

func (x *SVOObservation) GetProvenanceId() string

func (*SVOObservation) GetScalingFactor added in v1.19.1 

func (x *SVOObservation) GetScalingFactor() string

func (*SVOObservation) GetStrValue added in v1.19.1 

func (x *SVOObservation) GetStrValue() string

func (*SVOObservation) GetTemp added in v1.19.1 

func (x *SVOObservation) GetTemp() *SVOObservation_Temp

func (*SVOObservation) GetUnit added in v1.19.1 

func (x *SVOObservation) GetUnit() string

func (*SVOObservation) GetVal added in v1.19.1 

func (m *SVOObservation) GetVal() isSVOObservation_Val

func (*SVOObservation) ProtoMessage added in v1.19.1 

func (*SVOObservation) ProtoMessage()

func (*SVOObservation) ProtoReflect added in v1.19.1 

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

func (*SVOObservation) Reset added in v1.19.1 

func (x *SVOObservation) Reset()

func (*SVOObservation) String added in v1.19.1 

func (x *SVOObservation) String() string

type SVOObservation_DblValue added in v1.19.1 

type SVOObservation_DblValue struct {
	// Represents value for statType != "measurementResult"
	DblValue float64 `protobuf:"fixed64,9,opt,name=dbl_value,json=dblValue,proto3,oneof"`
}

type SVOObservation_StrValue added in v1.19.1 

type SVOObservation_StrValue struct {
	// Represents value for statType == "measurementResult"
	StrValue string `protobuf:"bytes,8,opt,name=str_value,json=strValue,proto3,oneof"`
}

type SVOObservation_Temp added in v1.19.1 

type SVOObservation_Temp struct {
	ObservationAbout string `protobuf:"bytes,1,opt,name=observation_about,json=observationAbout,proto3" json:"observation_about,omitempty"`
	VariableMeasured string `protobuf:"bytes,2,opt,name=variable_measured,json=variableMeasured,proto3" json:"variable_measured,omitempty"`
	ImportName       string `protobuf:"bytes,3,opt,name=import_name,json=importName,proto3" json:"import_name,omitempty"`
	// contains filtered or unexported fields
}

Not persisted in cache.

func (*SVOObservation_Temp) Descriptor deprecated added in v1.19.1 

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

Deprecated: Use SVOObservation_Temp.ProtoReflect.Descriptor instead.

func (*SVOObservation_Temp) GetImportName added in v1.19.1 

func (x *SVOObservation_Temp) GetImportName() string

func (*SVOObservation_Temp) GetObservationAbout added in v1.19.1 

func (x *SVOObservation_Temp) GetObservationAbout() string

func (*SVOObservation_Temp) GetVariableMeasured added in v1.19.1 

func (x *SVOObservation_Temp) GetVariableMeasured() string

func (*SVOObservation_Temp) ProtoMessage added in v1.19.1 

func (*SVOObservation_Temp) ProtoMessage()

func (*SVOObservation_Temp) ProtoReflect added in v1.19.1 

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

func (*SVOObservation_Temp) Reset added in v1.19.1 

func (x *SVOObservation_Temp) Reset()

func (*SVOObservation_Temp) String added in v1.19.1 

func (x *SVOObservation_Temp) String() string

type SVOPlace added in v1.19.1 

type SVOPlace struct {
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	Type string `protobuf:"bytes,2,opt,name=type,proto3" json:"type,omitempty"`
	Dcid string `protobuf:"bytes,3,opt,name=dcid,proto3" json:"dcid,omitempty"`
	// All StatVarObservations associated with the place.
	Observations []*SVOObservation `protobuf:"bytes,4,rep,name=observations,proto3" json:"observations,omitempty"`
	ProvenanceId string            `protobuf:"bytes,5,opt,name=provenance_id,json=provenanceId,proto3" json:"provenance_id,omitempty"`
	Temp         *SVOPlace_Temp    `protobuf:"bytes,6,opt,name=temp,proto3" json:"temp,omitempty"`
	// contains filtered or unexported fields
}

SVOPlace holds basic information about a DC place along with its associated StatVarObservations.

NOTE: Equivalent to legacy PopObsPlace.

func (*SVOPlace) Descriptor deprecated added in v1.19.1 

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

Deprecated: Use SVOPlace.ProtoReflect.Descriptor instead.

func (*SVOPlace) GetDcid added in v1.19.1 

func (x *SVOPlace) GetDcid() string

func (*SVOPlace) GetName added in v1.19.1 

func (x *SVOPlace) GetName() string

func (*SVOPlace) GetObservations added in v1.19.1 

func (x *SVOPlace) GetObservations() []*SVOObservation

func (*SVOPlace) GetProvenanceId added in v1.19.1 

func (x *SVOPlace) GetProvenanceId() string

func (*SVOPlace) GetTemp added in v1.19.1 

func (x *SVOPlace) GetTemp() *SVOPlace_Temp

func (*SVOPlace) GetType added in v1.19.1 

func (x *SVOPlace) GetType() string

func (*SVOPlace) ProtoMessage added in v1.19.1 

func (*SVOPlace) ProtoMessage()

func (*SVOPlace) ProtoReflect added in v1.19.1 

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

func (*SVOPlace) Reset added in v1.19.1 

func (x *SVOPlace) Reset()

func (*SVOPlace) String added in v1.19.1 

func (x *SVOPlace) String() string

type SVOPlace_Temp added in v1.19.1 

type SVOPlace_Temp struct {
	ChildPlaces []string `protobuf:"bytes,2,rep,name=child_places,json=childPlaces,proto3" json:"child_places,omitempty"`
	Mids        []string `protobuf:"bytes,3,rep,name=mids,proto3" json:"mids,omitempty"`
	// contains filtered or unexported fields
}

Not persisted in cache.

func (*SVOPlace_Temp) Descriptor deprecated added in v1.19.1 

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

Deprecated: Use SVOPlace_Temp.ProtoReflect.Descriptor instead.

func (*SVOPlace_Temp) GetChildPlaces added in v1.19.1 

func (x *SVOPlace_Temp) GetChildPlaces() []string

func (*SVOPlace_Temp) GetMids added in v1.19.1 

func (x *SVOPlace_Temp) GetMids() []string

func (*SVOPlace_Temp) ProtoMessage added in v1.19.1 

func (*SVOPlace_Temp) ProtoMessage()

func (*SVOPlace_Temp) ProtoReflect added in v1.19.1 

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

func (*SVOPlace_Temp) Reset added in v1.19.1 

func (x *SVOPlace_Temp) Reset()

func (*SVOPlace_Temp) String added in v1.19.1 

func (x *SVOPlace_Temp) String() string

type SearchEntityResult 

type SearchEntityResult struct {

	// DCID of the entity.
	Dcid string `protobuf:"bytes,1,opt,name=dcid,proto3" json:"dcid,omitempty"`
	// Name of the entity.
	Name string `protobuf:"bytes,2,opt,name=name,proto3" json:"name,omitempty"`
	// contains filtered or unexported fields
}

Data for a single entity returned by the search endpoint.

func (*SearchEntityResult) Descriptor deprecated 

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

Deprecated: Use SearchEntityResult.ProtoReflect.Descriptor instead.

func (*SearchEntityResult) GetDcid 

func (x *SearchEntityResult) GetDcid() string

func (*SearchEntityResult) GetName 

func (x *SearchEntityResult) GetName() string

func (*SearchEntityResult) ProtoMessage 

func (*SearchEntityResult) ProtoMessage()

func (*SearchEntityResult) ProtoReflect 

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

func (*SearchEntityResult) Reset 

func (x *SearchEntityResult) Reset()

func (*SearchEntityResult) String 

func (x *SearchEntityResult) String() string

type SearchRequest 

type SearchRequest struct {

	// Search query which is just a plain text string, e.g. "california".
	// This is not a datalog query, but a plain text query. The mixer is free
	// to choose an interpretation of the query, e.g. using NLP or just plain
	// keyword search and return relevant entities from the graph.
	Query string `protobuf:"bytes,1,opt,name=query,proto3" json:"query,omitempty"`
	// Maximum number of entities to return.
	MaxResults int32 `protobuf:"varint,2,opt,name=max_results,json=maxResults,proto3" json:"max_results,omitempty"`
	// contains filtered or unexported fields
}

Search request sent to the mixer.

func (*SearchRequest) Descriptor deprecated 

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

Deprecated: Use SearchRequest.ProtoReflect.Descriptor instead.

func (*SearchRequest) GetMaxResults 

func (x *SearchRequest) GetMaxResults() int32

func (*SearchRequest) GetQuery 

func (x *SearchRequest) GetQuery() string

func (*SearchRequest) ProtoMessage 

func (*SearchRequest) ProtoMessage()

func (*SearchRequest) ProtoReflect 

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

func (*SearchRequest) Reset 

func (x *SearchRequest) Reset()

func (*SearchRequest) String 

func (x *SearchRequest) String() string

type SearchResponse 

type SearchResponse struct {

	// Matching entities broken down by type.
	Section []*SearchResultSection `protobuf:"bytes,1,rep,name=section,proto3" json:"section,omitempty"`
	// contains filtered or unexported fields
}

Search response from mixer.

func (*SearchResponse) Descriptor deprecated 

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

Deprecated: Use SearchResponse.ProtoReflect.Descriptor instead.

func (*SearchResponse) GetSection 

func (x *SearchResponse) GetSection() []*SearchResultSection

func (*SearchResponse) ProtoMessage 

func (*SearchResponse) ProtoMessage()

func (*SearchResponse) ProtoReflect 

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

func (*SearchResponse) Reset 

func (x *SearchResponse) Reset()

func (*SearchResponse) String 

func (x *SearchResponse) String() string

type SearchResultSection 

type SearchResultSection struct {

	// Type of entities in this section.
	TypeName string `protobuf:"bytes,1,opt,name=type_name,json=typeName,proto3" json:"type_name,omitempty"`
	// List of entities in this section.
	Entity []*SearchEntityResult `protobuf:"bytes,2,rep,name=entity,proto3" json:"entity,omitempty"`
	// contains filtered or unexported fields
}

Wrapper for all entities returned from search which belong to a single type.

func (*SearchResultSection) Descriptor deprecated 

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

Deprecated: Use SearchResultSection.ProtoReflect.Descriptor instead.

func (*SearchResultSection) GetEntity 

func (x *SearchResultSection) GetEntity() []*SearchEntityResult

func (*SearchResultSection) GetTypeName 

func (x *SearchResultSection) GetTypeName() string

func (*SearchResultSection) ProtoMessage 

func (*SearchResultSection) ProtoMessage()

func (*SearchResultSection) ProtoReflect 

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

func (*SearchResultSection) Reset 

func (x *SearchResultSection) Reset()

func (*SearchResultSection) String 

func (x *SearchResultSection) String() string

type Series added in v1.14.0 

type Series struct {

	// Map from date to stat value.
	Val map[string]float64 `` /* 149-byte string literal not displayed */
	// Series metadata.
	Metadata *StatMetadata `protobuf:"bytes,2,opt,name=metadata,proto3" json:"metadata,omitempty"`
	// contains filtered or unexported fields
}

Represents a time series from a source.

func (*Series) Descriptor deprecated added in v1.14.0 

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

Deprecated: Use Series.ProtoReflect.Descriptor instead.

func (*Series) GetMetadata added in v1.14.0 

func (x *Series) GetMetadata() *StatMetadata

func (*Series) GetVal added in v1.14.0 

func (x *Series) GetVal() map[string]float64

func (*Series) ProtoMessage added in v1.14.0 

func (*Series) ProtoMessage()

func (*Series) ProtoReflect added in v1.14.0 

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

func (*Series) Reset added in v1.14.0 

func (x *Series) Reset()

func (*Series) String added in v1.14.0 

func (x *Series) String() string

type SeriesMap added in v1.14.0 

type SeriesMap struct {

	// A wrapper proto for a map of series.
	Data map[string]*Series `` /* 149-byte string literal not displayed */
	// contains filtered or unexported fields
}

func (*SeriesMap) Descriptor deprecated added in v1.14.0 

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

Deprecated: Use SeriesMap.ProtoReflect.Descriptor instead.

func (*SeriesMap) GetData added in v1.14.0 

func (x *SeriesMap) GetData() map[string]*Series

func (*SeriesMap) ProtoMessage added in v1.14.0 

func (*SeriesMap) ProtoMessage()

func (*SeriesMap) ProtoReflect added in v1.14.0 

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

func (*SeriesMap) Reset added in v1.14.0 

func (x *SeriesMap) Reset()

func (*SeriesMap) String added in v1.14.0 

func (x *SeriesMap) String() string

type SourceSeries 

type SourceSeries struct {
	Val               map[string]float64 `` /* 149-byte string literal not displayed */
	MeasurementMethod string             `protobuf:"bytes,2,opt,name=measurement_method,json=measurementMethod,proto3" json:"measurement_method,omitempty"`
	ObservationPeriod string             `protobuf:"bytes,3,opt,name=observation_period,json=observationPeriod,proto3" json:"observation_period,omitempty"`
	ImportName        string             `protobuf:"bytes,4,opt,name=import_name,json=importName,proto3" json:"import_name,omitempty"`
	ProvenanceDomain  string             `protobuf:"bytes,5,opt,name=provenance_domain,json=provenanceDomain,proto3" json:"provenance_domain,omitempty"`
	Unit              string             `protobuf:"bytes,6,opt,name=unit,proto3" json:"unit,omitempty"`
	ScalingFactor     string             `protobuf:"bytes,7,opt,name=scaling_factor,json=scalingFactor,proto3" json:"scaling_factor,omitempty"`
	IsDcAggregate     bool               `protobuf:"varint,8,opt,name=is_dc_aggregate,json=isDcAggregate,proto3" json:"is_dc_aggregate,omitempty"`
	ProvenanceUrl     string             `protobuf:"bytes,9,opt,name=provenance_url,json=provenanceUrl,proto3" json:"provenance_url,omitempty"`
	// contains filtered or unexported fields
}

func (*SourceSeries) Descriptor deprecated 

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

Deprecated: Use SourceSeries.ProtoReflect.Descriptor instead.

func (*SourceSeries) GetImportName 

func (x *SourceSeries) GetImportName() string

func (*SourceSeries) GetIsDcAggregate 

func (x *SourceSeries) GetIsDcAggregate() bool

func (*SourceSeries) GetMeasurementMethod 

func (x *SourceSeries) GetMeasurementMethod() string

func (*SourceSeries) GetObservationPeriod 

func (x *SourceSeries) GetObservationPeriod() string

func (*SourceSeries) GetProvenanceDomain 

func (x *SourceSeries) GetProvenanceDomain() string

func (*SourceSeries) GetProvenanceUrl 

func (x *SourceSeries) GetProvenanceUrl() string

func (*SourceSeries) GetScalingFactor 

func (x *SourceSeries) GetScalingFactor() string

func (*SourceSeries) GetUnit 

func (x *SourceSeries) GetUnit() string

func (*SourceSeries) GetVal 

func (x *SourceSeries) GetVal() map[string]float64

func (*SourceSeries) ProtoMessage 

func (*SourceSeries) ProtoMessage()

func (*SourceSeries) ProtoReflect 

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

func (*SourceSeries) Reset 

func (x *SourceSeries) Reset()

func (*SourceSeries) String 

func (x *SourceSeries) String() string

type StatMetadata 

type StatMetadata struct {
	ImportName        string `protobuf:"bytes,1,opt,name=import_name,json=importName,proto3" json:"import_name,omitempty"`
	ProvenanceUrl     string `protobuf:"bytes,2,opt,name=provenance_url,json=provenanceUrl,proto3" json:"provenance_url,omitempty"`
	MeasurementMethod string `protobuf:"bytes,3,opt,name=measurement_method,json=measurementMethod,proto3" json:"measurement_method,omitempty"`
	ObservationPeriod string `protobuf:"bytes,4,opt,name=observation_period,json=observationPeriod,proto3" json:"observation_period,omitempty"`
	ScalingFactor     string `protobuf:"bytes,5,opt,name=scaling_factor,json=scalingFactor,proto3" json:"scaling_factor,omitempty"`
	Unit              string `protobuf:"bytes,6,opt,name=unit,proto3" json:"unit,omitempty"`
	// contains filtered or unexported fields
}

StatMetadata contains the source and measurement information for a statistical observation.

func (*StatMetadata) Descriptor deprecated 

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

Deprecated: Use StatMetadata.ProtoReflect.Descriptor instead.

func (*StatMetadata) GetImportName 

func (x *StatMetadata) GetImportName() string

func (*StatMetadata) GetMeasurementMethod 

func (x *StatMetadata) GetMeasurementMethod() string

func (*StatMetadata) GetObservationPeriod 

func (x *StatMetadata) GetObservationPeriod() string

func (*StatMetadata) GetProvenanceUrl 

func (x *StatMetadata) GetProvenanceUrl() string

func (*StatMetadata) GetScalingFactor 

func (x *StatMetadata) GetScalingFactor() string

func (*StatMetadata) GetUnit 

func (x *StatMetadata) GetUnit() string

func (*StatMetadata) ProtoMessage 

func (*StatMetadata) ProtoMessage()

func (*StatMetadata) ProtoReflect 

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

func (*StatMetadata) Reset 

func (x *StatMetadata) Reset()

func (*StatMetadata) String 

func (x *StatMetadata) String() string

type StatVarGroupNode added in v1.18.0 

type StatVarGroupNode struct {

	// Absolute name of StatVarGroup. Typically used only for root nodes.
	AbsoluteName string `protobuf:"bytes,1,opt,name=absolute_name,json=absoluteName,proto3" json:"absolute_name,omitempty"`
	// List of children StatVar IDs directly attached to this group. If there are
	// auto-generated and curated IDs for a StatVar, we'll prefer the curated.
	ChildStatVars []*StatVarGroupNode_ChildSV `protobuf:"bytes,2,rep,name=child_stat_vars,json=childStatVars,proto3" json:"child_stat_vars,omitempty"`
	// List of children StatVarGroups that are immediate specializations.
	ChildStatVarGroups []*StatVarGroupNode_ChildSVG `protobuf:"bytes,3,rep,name=child_stat_var_groups,json=childStatVarGroups,proto3" json:"child_stat_var_groups,omitempty"`
	// contains filtered or unexported fields
}

func (*StatVarGroupNode) Descriptor deprecated added in v1.18.0 

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

Deprecated: Use StatVarGroupNode.ProtoReflect.Descriptor instead.

func (*StatVarGroupNode) GetAbsoluteName added in v1.18.0 

func (x *StatVarGroupNode) GetAbsoluteName() string

func (*StatVarGroupNode) GetChildStatVarGroups added in v1.18.0 

func (x *StatVarGroupNode) GetChildStatVarGroups() []*StatVarGroupNode_ChildSVG

func (*StatVarGroupNode) GetChildStatVars added in v1.18.0 

func (x *StatVarGroupNode) GetChildStatVars() []*StatVarGroupNode_ChildSV

func (*StatVarGroupNode) ProtoMessage added in v1.18.0 

func (*StatVarGroupNode) ProtoMessage()

func (*StatVarGroupNode) ProtoReflect added in v1.18.0 

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

func (*StatVarGroupNode) Reset added in v1.18.0 

func (x *StatVarGroupNode) Reset()

func (*StatVarGroupNode) String added in v1.18.0 

func (x *StatVarGroupNode) String() string

type StatVarGroupNode_ChildSV added in v1.18.0 

type StatVarGroupNode_ChildSV struct {

	// StatVar ID.
	Id string `protobuf:"bytes,1,opt,name=id,proto3" json:"id,omitempty"`
	// Name suitable for search.
	SearchName string `protobuf:"bytes,2,opt,name=search_name,json=searchName,proto3" json:"search_name,omitempty"`
	// Name suitable for display in tree.
	DisplayName string `protobuf:"bytes,3,opt,name=display_name,json=displayName,proto3" json:"display_name,omitempty"`
	// contains filtered or unexported fields
}

func (*StatVarGroupNode_ChildSV) Descriptor deprecated added in v1.18.0 

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

Deprecated: Use StatVarGroupNode_ChildSV.ProtoReflect.Descriptor instead.

func (*StatVarGroupNode_ChildSV) GetDisplayName added in v1.18.0 

func (x *StatVarGroupNode_ChildSV) GetDisplayName() string

func (*StatVarGroupNode_ChildSV) GetId added in v1.18.0 

func (x *StatVarGroupNode_ChildSV) GetId() string

func (*StatVarGroupNode_ChildSV) GetSearchName added in v1.18.0 

func (x *StatVarGroupNode_ChildSV) GetSearchName() string

func (*StatVarGroupNode_ChildSV) ProtoMessage added in v1.18.0 

func (*StatVarGroupNode_ChildSV) ProtoMessage()

func (*StatVarGroupNode_ChildSV) ProtoReflect added in v1.18.0 

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

func (*StatVarGroupNode_ChildSV) Reset added in v1.18.0 

func (x *StatVarGroupNode_ChildSV) Reset()

func (*StatVarGroupNode_ChildSV) String added in v1.18.0 

func (x *StatVarGroupNode_ChildSV) String() string

type StatVarGroupNode_ChildSVG added in v1.18.0 

type StatVarGroupNode_ChildSVG struct {

	// StatVarGroup ID.
	Id string `protobuf:"bytes,1,opt,name=id,proto3" json:"id,omitempty"`
	// The specialized entity of the child StatVarGroup relative to the parent.
	// This can be used for naming when the child appears in the hierarchy.
	SpecializedEntity string `protobuf:"bytes,2,opt,name=specialized_entity,json=specializedEntity,proto3" json:"specialized_entity,omitempty"`
	// contains filtered or unexported fields
}

func (*StatVarGroupNode_ChildSVG) Descriptor deprecated added in v1.18.0 

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

Deprecated: Use StatVarGroupNode_ChildSVG.ProtoReflect.Descriptor instead.

func (*StatVarGroupNode_ChildSVG) GetId added in v1.18.0 

func (x *StatVarGroupNode_ChildSVG) GetId() string

func (*StatVarGroupNode_ChildSVG) GetSpecializedEntity added in v1.18.0 

func (x *StatVarGroupNode_ChildSVG) GetSpecializedEntity() string

func (*StatVarGroupNode_ChildSVG) ProtoMessage added in v1.18.0 

func (*StatVarGroupNode_ChildSVG) ProtoMessage()

func (*StatVarGroupNode_ChildSVG) ProtoReflect added in v1.18.0 

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

func (*StatVarGroupNode_ChildSVG) Reset added in v1.18.0 

func (x *StatVarGroupNode_ChildSVG) Reset()

func (*StatVarGroupNode_ChildSVG) String added in v1.18.0 

func (x *StatVarGroupNode_ChildSVG) String() string

type StatVarGroups added in v1.18.0 

type StatVarGroups struct {

	// Key is StatVarGroup ID.
	StatVarGroups map[string]*StatVarGroupNode `` /* 190-byte string literal not displayed */
	// contains filtered or unexported fields
}

func (*StatVarGroups) Descriptor deprecated added in v1.18.0 

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

Deprecated: Use StatVarGroups.ProtoReflect.Descriptor instead.

func (*StatVarGroups) GetStatVarGroups added in v1.18.0 

func (x *StatVarGroups) GetStatVarGroups() map[string]*StatVarGroupNode

func (*StatVarGroups) ProtoMessage added in v1.18.0 

func (*StatVarGroups) ProtoMessage()

func (*StatVarGroups) ProtoReflect added in v1.18.0 

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

func (*StatVarGroups) Reset added in v1.18.0 

func (x *StatVarGroups) Reset()

func (*StatVarGroups) String added in v1.18.0 

func (x *StatVarGroups) String() string

type StatVarObsSeries added in v1.20.3 

type StatVarObsSeries struct {

	// Key is stat var dcid.
	Data map[string]*ObsTimeSeries `` /* 149-byte string literal not displayed */
	// contains filtered or unexported fields
}

This is effectively the same proto as PlaceStat with different field name. This is used to match the landing page cache data.

func (*StatVarObsSeries) Descriptor deprecated added in v1.20.3 

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

Deprecated: Use StatVarObsSeries.ProtoReflect.Descriptor instead.

func (*StatVarObsSeries) GetData added in v1.20.3 

func (x *StatVarObsSeries) GetData() map[string]*ObsTimeSeries

func (*StatVarObsSeries) ProtoMessage added in v1.20.3 

func (*StatVarObsSeries) ProtoMessage()

func (*StatVarObsSeries) ProtoReflect added in v1.20.3 

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

func (*StatVarObsSeries) Reset added in v1.20.3 

func (x *StatVarObsSeries) Reset()

func (*StatVarObsSeries) String added in v1.20.3 

func (x *StatVarObsSeries) String() string

type StatVarSeries added in v1.20.3 

type StatVarSeries struct {

	// Key is stat var dcid.
	Data map[string]*Series `` /* 149-byte string literal not displayed */
	// contains filtered or unexported fields
}

Hold mapping from stat var id to Series struct. This is different from StatVarObsSeries that the "Series" is processed time series with metadata while "ObsTimeSeries" is the raw series from cache.

func (*StatVarSeries) Descriptor deprecated added in v1.20.3 

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

Deprecated: Use StatVarSeries.ProtoReflect.Descriptor instead.

func (*StatVarSeries) GetData added in v1.20.3 

func (x *StatVarSeries) GetData() map[string]*Series

func (*StatVarSeries) ProtoMessage added in v1.20.3 

func (*StatVarSeries) ProtoMessage()

func (*StatVarSeries) ProtoReflect added in v1.20.3 

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

func (*StatVarSeries) Reset added in v1.20.3 

func (x *StatVarSeries) Reset()

func (*StatVarSeries) String added in v1.20.3 

func (x *StatVarSeries) String() string

type StatVars 

type StatVars struct {
	StatVars []string `protobuf:"bytes,1,rep,name=stat_vars,json=statVars,proto3" json:"stat_vars,omitempty"`
	// contains filtered or unexported fields
}

StatVars represent a list of statistical variable dcids.

func (*StatVars) Descriptor deprecated 

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

Deprecated: Use StatVars.ProtoReflect.Descriptor instead.

func (*StatVars) GetStatVars 

func (x *StatVars) GetStatVars() []string

func (*StatVars) ProtoMessage 

func (*StatVars) ProtoMessage()

func (*StatVars) ProtoReflect 

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

func (*StatVars) Reset 

func (x *StatVars) Reset()

func (*StatVars) String 

func (x *StatVars) String() string

type StatsVars 

type StatsVars struct {
	StatsVars []string `protobuf:"bytes,1,rep,name=statsVars,proto3" json:"statsVars,omitempty"`
	// contains filtered or unexported fields
}

StatsVars represent a list of statistical variable dcids.

func (*StatsVars) Descriptor deprecated 

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

Deprecated: Use StatsVars.ProtoReflect.Descriptor instead.

func (*StatsVars) GetStatsVars 

func (x *StatsVars) GetStatsVars() []string

func (*StatsVars) ProtoMessage 

func (*StatsVars) ProtoMessage()

func (*StatsVars) ProtoReflect 

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

func (*StatsVars) Reset 

func (x *StatsVars) Reset()

func (*StatsVars) String 

func (x *StatsVars) String() string

type TranslateRequest 

type TranslateRequest struct {

	// String representaion of schema mappings used to translate.
	SchemaMapping string `protobuf:"bytes,1,opt,name=schema_mapping,json=schemaMapping,proto3" json:"schema_mapping,omitempty"`
	// String representation of sparql query.
	Sparql string `protobuf:"bytes,2,opt,name=sparql,proto3" json:"sparql,omitempty"`
	// contains filtered or unexported fields
}

Request to translate a graph query.

func (*TranslateRequest) Descriptor deprecated 

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

Deprecated: Use TranslateRequest.ProtoReflect.Descriptor instead.

func (*TranslateRequest) GetSchemaMapping 

func (x *TranslateRequest) GetSchemaMapping() string

func (*TranslateRequest) GetSparql 

func (x *TranslateRequest) GetSparql() string

func (*TranslateRequest) ProtoMessage 

func (*TranslateRequest) ProtoMessage()

func (*TranslateRequest) ProtoReflect 

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

func (*TranslateRequest) Reset 

func (x *TranslateRequest) Reset()

func (*TranslateRequest) String 

func (x *TranslateRequest) String() string

type TranslateResponse 

type TranslateResponse struct {

	// The translated sql.
	Sql string `protobuf:"bytes,1,opt,name=sql,proto3" json:"sql,omitempty"`
	// Serialized json string of the translation result
	Translation string `protobuf:"bytes,2,opt,name=translation,proto3" json:"translation,omitempty"`
	// contains filtered or unexported fields
}

Response of a translate request.

func (*TranslateResponse) Descriptor deprecated 

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

Deprecated: Use TranslateResponse.ProtoReflect.Descriptor instead.

func (*TranslateResponse) GetSql 

func (x *TranslateResponse) GetSql() string

func (*TranslateResponse) GetTranslation 

func (x *TranslateResponse) GetTranslation() string

func (*TranslateResponse) ProtoMessage 

func (*TranslateResponse) ProtoMessage()

func (*TranslateResponse) ProtoReflect 

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

func (*TranslateResponse) Reset 

func (x *TranslateResponse) Reset()

func (*TranslateResponse) String 

func (x *TranslateResponse) String() string

type Triple 

type Triple struct {
	SubjectId    string   `protobuf:"bytes,1,opt,name=subject_id,json=subjectId,proto3" json:"subject_id,omitempty"`
	Predicate    string   `protobuf:"bytes,2,opt,name=predicate,proto3" json:"predicate,omitempty"`
	ObjectId     string   `protobuf:"bytes,3,opt,name=object_id,json=objectId,proto3" json:"object_id,omitempty"`
	ObjectName   string   `protobuf:"bytes,4,opt,name=object_name,json=objectName,proto3" json:"object_name,omitempty"` // Only when object_id is set.
	ObjectValue  string   `protobuf:"bytes,5,opt,name=object_value,json=objectValue,proto3" json:"object_value,omitempty"`
	ProvenanceId string   `protobuf:"bytes,6,opt,name=provenance_id,json=provenanceId,proto3" json:"provenance_id,omitempty"`
	SubjectName  string   `protobuf:"bytes,7,opt,name=subject_name,json=subjectName,proto3" json:"subject_name,omitempty"`    // Only for in arcs.
	SubjectTypes []string `protobuf:"bytes,8,rep,name=subject_types,json=subjectTypes,proto3" json:"subject_types,omitempty"` // Only for in arcs.
	ObjectTypes  []string `protobuf:"bytes,10,rep,name=object_types,json=objectTypes,proto3" json:"object_types,omitempty"`   // Only when object_id is set.
	// contains filtered or unexported fields
}

Triple.

func (*Triple) Descriptor deprecated 

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

Deprecated: Use Triple.ProtoReflect.Descriptor instead.

func (*Triple) GetObjectId 

func (x *Triple) GetObjectId() string

func (*Triple) GetObjectName 

func (x *Triple) GetObjectName() string

func (*Triple) GetObjectTypes 

func (x *Triple) GetObjectTypes() []string

func (*Triple) GetObjectValue 

func (x *Triple) GetObjectValue() string

func (*Triple) GetPredicate 

func (x *Triple) GetPredicate() string

func (*Triple) GetProvenanceId 

func (x *Triple) GetProvenanceId() string

func (*Triple) GetSubjectId 

func (x *Triple) GetSubjectId() string

func (*Triple) GetSubjectName 

func (x *Triple) GetSubjectName() string

func (*Triple) GetSubjectTypes 

func (x *Triple) GetSubjectTypes() []string

func (*Triple) ProtoMessage 

func (*Triple) ProtoMessage()

func (*Triple) ProtoReflect 

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

func (*Triple) Reset 

func (x *Triple) Reset()

func (*Triple) String 

func (x *Triple) String() string

type Triples 

type Triples struct {
	Triples    []*Triple `protobuf:"bytes,1,rep,name=triples,proto3" json:"triples,omitempty"`
	TotalCount int64     `protobuf:"varint,2,opt,name=total_count,json=totalCount,proto3" json:"total_count,omitempty"` // Before potential truncation.
	// contains filtered or unexported fields
}

A collection of triples.

func (*Triples) Descriptor deprecated 

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

Deprecated: Use Triples.ProtoReflect.Descriptor instead.

func (*Triples) GetTotalCount 

func (x *Triples) GetTotalCount() int64

func (*Triples) GetTriples 

func (x *Triples) GetTriples() []*Triple

func (*Triples) ProtoMessage 

func (*Triples) ProtoMessage()

func (*Triples) ProtoReflect 

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

func (*Triples) Reset 

func (x *Triples) Reset()

func (*Triples) String 

func (x *Triples) String() string

type UnimplementedMixerServer 

type UnimplementedMixerServer struct {
}

UnimplementedMixerServer should be embedded to have forward compatible implementations.

func (*UnimplementedMixerServer) GetLandingPageData 

func (*UnimplementedMixerServer) GetLandingPageData(context.Context, *GetLandingPageDataRequest) (*GetLandingPageDataResponse, error)

func (*UnimplementedMixerServer) GetLocationsRankings 

func (*UnimplementedMixerServer) GetLocationsRankings(context.Context, *GetLocationsRankingsRequest) (*GetLocationsRankingsResponse, error)

func (*UnimplementedMixerServer) GetPlaceObs 

func (*UnimplementedMixerServer) GetPlaceObs(context.Context, *GetPlaceObsRequest) (*SVOCollection, error)

func (*UnimplementedMixerServer) GetPlaceStatDateWithinPlace 

func (*UnimplementedMixerServer) GetPlaceStatDateWithinPlace(context.Context, *GetPlaceStatDateWithinPlaceRequest) (*GetPlaceStatDateWithinPlaceResponse, error)

func (*UnimplementedMixerServer) GetPlaceStatVars 

func (*UnimplementedMixerServer) GetPlaceStatVars(context.Context, *GetPlaceStatVarsRequest) (*GetPlaceStatVarsResponse, error)

func (*UnimplementedMixerServer) GetPlaceStatVarsUnion 

func (*UnimplementedMixerServer) GetPlaceStatVarsUnion(context.Context, *GetPlaceStatVarsUnionRequest) (*GetPlaceStatVarsUnionResponse, error)

func (*UnimplementedMixerServer) GetPlaceStatVarsUnionV1 added in v1.20.3 

func (*UnimplementedMixerServer) GetPlaceStatVarsUnionV1(context.Context, *GetPlaceStatVarsUnionRequest) (*GetPlaceStatVarsUnionResponseV1, error)

func (*UnimplementedMixerServer) GetPlaceStatsVar 

func (*UnimplementedMixerServer) GetPlaceStatsVar(context.Context, *GetPlaceStatsVarRequest) (*GetPlaceStatsVarResponse, error)

func (*UnimplementedMixerServer) GetPlacesIn 

func (*UnimplementedMixerServer) GetPlacesIn(context.Context, *GetPlacesInRequest) (*GetPlacesInResponse, error)

func (*UnimplementedMixerServer) GetPropertyLabels 

func (*UnimplementedMixerServer) GetPropertyLabels(context.Context, *GetPropertyLabelsRequest) (*GetPropertyLabelsResponse, error)

func (*UnimplementedMixerServer) GetPropertyValues 

func (*UnimplementedMixerServer) GetPropertyValues(context.Context, *GetPropertyValuesRequest) (*GetPropertyValuesResponse, error)

func (*UnimplementedMixerServer) GetRelatedLocations 

func (*UnimplementedMixerServer) GetRelatedLocations(context.Context, *GetRelatedLocationsRequest) (*GetRelatedLocationsResponse, error)

func (*UnimplementedMixerServer) GetStatAll 

func (*UnimplementedMixerServer) GetStatAll(context.Context, *GetStatAllRequest) (*GetStatAllResponse, error)

func (*UnimplementedMixerServer) GetStatSeries 

func (*UnimplementedMixerServer) GetStatSeries(context.Context, *GetStatSeriesRequest) (*GetStatSeriesResponse, error)

func (*UnimplementedMixerServer) GetStatSet 

func (*UnimplementedMixerServer) GetStatSet(context.Context, *GetStatSetRequest) (*GetStatSetResponse, error)

func (*UnimplementedMixerServer) GetStatSetSeries added in v1.14.0 

func (*UnimplementedMixerServer) GetStatSetSeries(context.Context, *GetStatSetSeriesRequest) (*GetStatSetSeriesResponse, error)

func (*UnimplementedMixerServer) GetStatSetWithinPlace added in v1.19.1 

func (*UnimplementedMixerServer) GetStatSetWithinPlace(context.Context, *GetStatSetWithinPlaceRequest) (*GetStatSetResponse, error)

func (*UnimplementedMixerServer) GetStatValue 

func (*UnimplementedMixerServer) GetStatValue(context.Context, *GetStatValueRequest) (*GetStatValueResponse, error)

func (*UnimplementedMixerServer) GetStatVarGroup added in v1.18.0 

func (*UnimplementedMixerServer) GetStatVarGroup(context.Context, *GetStatVarGroupRequest) (*StatVarGroups, error)

func (*UnimplementedMixerServer) GetStats 

func (*UnimplementedMixerServer) GetStats(context.Context, *GetStatsRequest) (*GetStatsResponse, error)

func (*UnimplementedMixerServer) GetTriples 

func (*UnimplementedMixerServer) GetTriples(context.Context, *GetTriplesRequest) (*GetTriplesResponse, error)

func (*UnimplementedMixerServer) GetVersion added in v1.18.0 

func (*UnimplementedMixerServer) GetVersion(context.Context, *GetVersionRequest) (*GetVersionResponse, error)

func (*UnimplementedMixerServer) Query 

func (*UnimplementedMixerServer) Query(context.Context, *QueryRequest) (*QueryResponse, error)

func (*UnimplementedMixerServer) Search 

func (*UnimplementedMixerServer) Search(context.Context, *SearchRequest) (*SearchResponse, error)

func (*UnimplementedMixerServer) Translate 

func (*UnimplementedMixerServer) Translate(context.Context, *TranslateRequest) (*TranslateResponse, error)

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.