location
packageThis package is not in the latest version of its module.
Details
Validgo.mod file
The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license
Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version
Modules with tagged versions give importers more predictable builds.
Stable version
When a project reaches major version v1 it is considered stable.
- Learn more about best practices
Repository
Links
Documentation¶
Index¶
- Variables
- func RegisterLocationsServer(s *grpc.Server, srv LocationsServer)
- type GetLocationRequest
- type ListLocationsRequest
- func (*ListLocationsRequest) Descriptor() ([]byte, []int)deprecated
- func (x *ListLocationsRequest) GetFilter() string
- func (x *ListLocationsRequest) GetName() string
- func (x *ListLocationsRequest) GetPageSize() int32
- func (x *ListLocationsRequest) GetPageToken() string
- func (*ListLocationsRequest) ProtoMessage()
- func (x *ListLocationsRequest) ProtoReflect() protoreflect.Message
- func (x *ListLocationsRequest) Reset()
- func (x *ListLocationsRequest) String() string
- type ListLocationsResponse
- func (*ListLocationsResponse) Descriptor() ([]byte, []int)deprecated
- func (x *ListLocationsResponse) GetLocations() []*Location
- func (x *ListLocationsResponse) GetNextPageToken() string
- func (*ListLocationsResponse) ProtoMessage()
- func (x *ListLocationsResponse) ProtoReflect() protoreflect.Message
- func (x *ListLocationsResponse) Reset()
- func (x *ListLocationsResponse) String() string
- type Location
- func (*Location) Descriptor() ([]byte, []int)deprecated
- func (x *Location) GetDisplayName() string
- func (x *Location) GetLabels() map[string]string
- func (x *Location) GetLocationId() string
- func (x *Location) GetMetadata() *anypb.Any
- func (x *Location) GetName() string
- func (*Location) ProtoMessage()
- func (x *Location) ProtoReflect() protoreflect.Message
- func (x *Location) Reset()
- func (x *Location) String() string
- type LocationsClient
- type LocationsServer
- type UnimplementedLocationsServer
Constants¶
This section is empty.
Variables¶
var File_google_cloud_location_locations_protoprotoreflect.FileDescriptorFunctions¶
funcRegisterLocationsServer¶
func RegisterLocationsServer(s *grpc.Server, srvLocationsServer)
Types¶
typeGetLocationRequest¶
type GetLocationRequest struct {// Resource name for the location.Namestring `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`// contains filtered or unexported fields}The request message for [Locations.GetLocation][google.cloud.location.Locations.GetLocation].
func (*GetLocationRequest)Descriptordeprecated
func (*GetLocationRequest) Descriptor() ([]byte, []int)
Deprecated: Use GetLocationRequest.ProtoReflect.Descriptor instead.
func (*GetLocationRequest)GetName¶
func (x *GetLocationRequest) GetName()string
func (*GetLocationRequest)ProtoMessage¶
func (*GetLocationRequest) ProtoMessage()
func (*GetLocationRequest)ProtoReflect¶
func (x *GetLocationRequest) ProtoReflect()protoreflect.Message
func (*GetLocationRequest)Reset¶
func (x *GetLocationRequest) Reset()
func (*GetLocationRequest)String¶
func (x *GetLocationRequest) String()string
typeListLocationsRequest¶
type ListLocationsRequest struct {// The resource that owns the locations collection, if applicable.Namestring `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`// The standard list filter.Filterstring `protobuf:"bytes,2,opt,name=filter,proto3" json:"filter,omitempty"`// The standard list page size.PageSizeint32 `protobuf:"varint,3,opt,name=page_size,json=pageSize,proto3" json:"page_size,omitempty"`// The standard list page token.PageTokenstring `protobuf:"bytes,4,opt,name=page_token,json=pageToken,proto3" json:"page_token,omitempty"`// contains filtered or unexported fields}The request message for [Locations.ListLocations][google.cloud.location.Locations.ListLocations].
func (*ListLocationsRequest)Descriptordeprecated
func (*ListLocationsRequest) Descriptor() ([]byte, []int)
Deprecated: Use ListLocationsRequest.ProtoReflect.Descriptor instead.
func (*ListLocationsRequest)GetFilter¶
func (x *ListLocationsRequest) GetFilter()string
func (*ListLocationsRequest)GetName¶
func (x *ListLocationsRequest) GetName()string
func (*ListLocationsRequest)GetPageSize¶
func (x *ListLocationsRequest) GetPageSize()int32
func (*ListLocationsRequest)GetPageToken¶
func (x *ListLocationsRequest) GetPageToken()string
func (*ListLocationsRequest)ProtoMessage¶
func (*ListLocationsRequest) ProtoMessage()
func (*ListLocationsRequest)ProtoReflect¶
func (x *ListLocationsRequest) ProtoReflect()protoreflect.Message
func (*ListLocationsRequest)Reset¶
func (x *ListLocationsRequest) Reset()
func (*ListLocationsRequest)String¶
func (x *ListLocationsRequest) String()string
typeListLocationsResponse¶
type ListLocationsResponse struct {// A list of locations that matches the specified filter in the request.Locations []*Location `protobuf:"bytes,1,rep,name=locations,proto3" json:"locations,omitempty"`// The standard List next-page token.NextPageTokenstring `protobuf:"bytes,2,opt,name=next_page_token,json=nextPageToken,proto3" json:"next_page_token,omitempty"`// contains filtered or unexported fields}The response message for [Locations.ListLocations][google.cloud.location.Locations.ListLocations].
func (*ListLocationsResponse)Descriptordeprecated
func (*ListLocationsResponse) Descriptor() ([]byte, []int)
Deprecated: Use ListLocationsResponse.ProtoReflect.Descriptor instead.
func (*ListLocationsResponse)GetLocations¶
func (x *ListLocationsResponse) GetLocations() []*Location
func (*ListLocationsResponse)GetNextPageToken¶
func (x *ListLocationsResponse) GetNextPageToken()string
func (*ListLocationsResponse)ProtoMessage¶
func (*ListLocationsResponse) ProtoMessage()
func (*ListLocationsResponse)ProtoReflect¶
func (x *ListLocationsResponse) ProtoReflect()protoreflect.Message
func (*ListLocationsResponse)Reset¶
func (x *ListLocationsResponse) Reset()
func (*ListLocationsResponse)String¶
func (x *ListLocationsResponse) String()string
typeLocation¶
type Location struct {// Resource name for the location, which may vary between implementations.// For example: `"projects/example-project/locations/us-east1"`Namestring `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`// The canonical id for this location. For example: `"us-east1"`.LocationIdstring `protobuf:"bytes,4,opt,name=location_id,json=locationId,proto3" json:"location_id,omitempty"`// The friendly name for this location, typically a nearby city name.// For example, "Tokyo".DisplayNamestring `protobuf:"bytes,5,opt,name=display_name,json=displayName,proto3" json:"display_name,omitempty"`// Cross-service attributes for the location. For example//// {"cloud.googleapis.com/region": "us-east1"}Labels map[string]string ``/* 153-byte string literal not displayed */// Service-specific metadata. For example the available capacity at the given// location.Metadata *anypb.Any `protobuf:"bytes,3,opt,name=metadata,proto3" json:"metadata,omitempty"`// contains filtered or unexported fields}A resource that represents Google Cloud Platform location.
func (*Location)Descriptordeprecated
func (*Location)GetDisplayName¶
func (*Location)GetLocationId¶
func (*Location)GetMetadata¶
func (*Location)ProtoMessage¶
func (*Location) ProtoMessage()
func (*Location)ProtoReflect¶
func (x *Location) ProtoReflect()protoreflect.Message
typeLocationsClient¶
type LocationsClient interface {// Lists information about the supported locations for this service.ListLocations(ctxcontext.Context, in *ListLocationsRequest, opts ...grpc.CallOption) (*ListLocationsResponse,error)// Gets information about a location.GetLocation(ctxcontext.Context, in *GetLocationRequest, opts ...grpc.CallOption) (*Location,error)}LocationsClient is the client API for Locations service.
For semantics around ctx use and closing/ending streaming RPCs, please refer tohttps://godoc.org/google.golang.org/grpc#ClientConn.NewStream.
funcNewLocationsClient¶
func NewLocationsClient(ccgrpc.ClientConnInterface)LocationsClient
typeLocationsServer¶
type LocationsServer interface {// Lists information about the supported locations for this service.ListLocations(context.Context, *ListLocationsRequest) (*ListLocationsResponse,error)// Gets information about a location.GetLocation(context.Context, *GetLocationRequest) (*Location,error)}LocationsServer is the server API for Locations service.
typeUnimplementedLocationsServer¶
type UnimplementedLocationsServer struct {}UnimplementedLocationsServer can be embedded to have forward compatible implementations.
func (*UnimplementedLocationsServer)GetLocation¶
func (*UnimplementedLocationsServer) GetLocation(context.Context, *GetLocationRequest) (*Location,error)
func (*UnimplementedLocationsServer)ListLocations¶
func (*UnimplementedLocationsServer) ListLocations(context.Context, *ListLocationsRequest) (*ListLocationsResponse,error)