Documentation
¶
Overview ¶
Package location is a generated protocol buffer package.
It is generated from these files:
google/cloud/location/locations.proto
It has these top-level messages:
ListLocationsRequest ListLocationsResponse GetLocationRequest Location
Index ¶
- func RegisterLocationsServer(s *grpc.Server, srv LocationsServer)
- type GetLocationRequest
- type ListLocationsRequest
- func (*ListLocationsRequest) Descriptor() ([]byte, []int)
- func (m *ListLocationsRequest) GetFilter() string
- func (m *ListLocationsRequest) GetName() string
- func (m *ListLocationsRequest) GetPageSize() int32
- func (m *ListLocationsRequest) GetPageToken() string
- func (*ListLocationsRequest) ProtoMessage()
- func (m *ListLocationsRequest) Reset()
- func (m *ListLocationsRequest) String() string
- type ListLocationsResponse
- func (*ListLocationsResponse) Descriptor() ([]byte, []int)
- func (m *ListLocationsResponse) GetLocations() []*Location
- func (m *ListLocationsResponse) GetNextPageToken() string
- func (*ListLocationsResponse) ProtoMessage()
- func (m *ListLocationsResponse) Reset()
- func (m *ListLocationsResponse) String() string
- type Location
- func (*Location) Descriptor() ([]byte, []int)
- func (m *Location) GetLabels() map[string]string
- func (m *Location) GetLocationId() string
- func (m *Location) GetMetadata() *google_protobuf1.Any
- func (m *Location) GetName() string
- func (*Location) ProtoMessage()
- func (m *Location) Reset()
- func (m *Location) String() string
- type LocationsClient
- type LocationsServer
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func RegisterLocationsServer ¶
func RegisterLocationsServer(s *grpc.Server, srv LocationsServer)
Types ¶
type GetLocationRequest ¶
type GetLocationRequest struct {
// Resource name for the location.
Name string `protobuf:"bytes,1,opt,name=name" json:"name,omitempty"`
}
The request message for [Locations.GetLocation][google.cloud.location.Locations.GetLocation].
func (*GetLocationRequest) Descriptor ¶
func (*GetLocationRequest) Descriptor() ([]byte, []int)
func (*GetLocationRequest) GetName ¶
func (m *GetLocationRequest) GetName() string
func (*GetLocationRequest) ProtoMessage ¶
func (*GetLocationRequest) ProtoMessage()
func (*GetLocationRequest) Reset ¶
func (m *GetLocationRequest) Reset()
func (*GetLocationRequest) String ¶
func (m *GetLocationRequest) String() string
type ListLocationsRequest ¶
type ListLocationsRequest struct {
// The resource that owns the locations collection, if applicable.
Name string `protobuf:"bytes,1,opt,name=name" json:"name,omitempty"`
// The standard list filter.
Filter string `protobuf:"bytes,2,opt,name=filter" json:"filter,omitempty"`
// The standard list page size.
PageSize int32 `protobuf:"varint,3,opt,name=page_size,json=pageSize" json:"page_size,omitempty"`
// The standard list page token.
PageToken string `protobuf:"bytes,4,opt,name=page_token,json=pageToken" json:"page_token,omitempty"`
}
The request message for [Locations.ListLocations][google.cloud.location.Locations.ListLocations].
func (*ListLocationsRequest) Descriptor ¶
func (*ListLocationsRequest) Descriptor() ([]byte, []int)
func (*ListLocationsRequest) GetFilter ¶
func (m *ListLocationsRequest) GetFilter() string
func (*ListLocationsRequest) GetName ¶
func (m *ListLocationsRequest) GetName() string
func (*ListLocationsRequest) GetPageSize ¶
func (m *ListLocationsRequest) GetPageSize() int32
func (*ListLocationsRequest) GetPageToken ¶
func (m *ListLocationsRequest) GetPageToken() string
func (*ListLocationsRequest) ProtoMessage ¶
func (*ListLocationsRequest) ProtoMessage()
func (*ListLocationsRequest) Reset ¶
func (m *ListLocationsRequest) Reset()
func (*ListLocationsRequest) String ¶
func (m *ListLocationsRequest) String() string
type ListLocationsResponse ¶
type ListLocationsResponse struct {
// A list of locations that matches the specified filter in the request.
Locations []*Location `protobuf:"bytes,1,rep,name=locations" json:"locations,omitempty"`
// The standard List next-page token.
NextPageToken string `protobuf:"bytes,2,opt,name=next_page_token,json=nextPageToken" json:"next_page_token,omitempty"`
}
The response message for [Locations.ListLocations][google.cloud.location.Locations.ListLocations].
func (*ListLocationsResponse) Descriptor ¶
func (*ListLocationsResponse) Descriptor() ([]byte, []int)
func (*ListLocationsResponse) GetLocations ¶
func (m *ListLocationsResponse) GetLocations() []*Location
func (*ListLocationsResponse) GetNextPageToken ¶
func (m *ListLocationsResponse) GetNextPageToken() string
func (*ListLocationsResponse) ProtoMessage ¶
func (*ListLocationsResponse) ProtoMessage()
func (*ListLocationsResponse) Reset ¶
func (m *ListLocationsResponse) Reset()
func (*ListLocationsResponse) String ¶
func (m *ListLocationsResponse) String() string
type Location ¶
type Location struct {
// Resource name for the location, which may vary between implementations.
// For example: `"projects/example-project/locations/us-east1"`
Name string `protobuf:"bytes,1,opt,name=name" json:"name,omitempty"`
// The canonical id for this location. For example: `"us-east1"`.
LocationId string `protobuf:"bytes,4,opt,name=location_id,json=locationId" json:"location_id,omitempty"`
// Cross-service attributes for the location. For example
//
// {"cloud.googleapis.com/region": "us-east1"}
Labels map[string]string `` /* 132-byte string literal not displayed */
// Service-specific metadata. For example the available capacity at the given
// location.
Metadata *google_protobuf1.Any `protobuf:"bytes,3,opt,name=metadata" json:"metadata,omitempty"`
}
A resource that represents Google Cloud Platform location.
func (*Location) Descriptor ¶
func (*Location) GetLocationId ¶
func (*Location) GetMetadata ¶
func (m *Location) GetMetadata() *google_protobuf1.Any
func (*Location) ProtoMessage ¶
func (*Location) ProtoMessage()
type LocationsClient ¶
type LocationsClient interface {
// Lists information about the supported locations for this service.
ListLocations(ctx context.Context, in *ListLocationsRequest, opts ...grpc.CallOption) (*ListLocationsResponse, error)
// Get information about a location.
GetLocation(ctx context.Context, in *GetLocationRequest, opts ...grpc.CallOption) (*Location, error)
}
func NewLocationsClient ¶
func NewLocationsClient(cc *grpc.ClientConn) LocationsClient
type LocationsServer ¶
type LocationsServer interface {
// Lists information about the supported locations for this service.
ListLocations(context.Context, *ListLocationsRequest) (*ListLocationsResponse, error)
// Get information about a location.
GetLocation(context.Context, *GetLocationRequest) (*Location, error)
}
Click to show internal directories.
Click to hide internal directories.