var File_google_cloud_location_locations_proto protoreflect.FileDescriptor
func RegisterLocationsServer(s *grpc.Server, srv LocationsServer)
The request message for [Locations.GetLocation][google.cloud.location.Locations.GetLocation].
type GetLocationRequest struct {
// Resource name for the location.
Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
// contains filtered or unexported fields
}
func (*GetLocationRequest) Descriptor() ([]byte, []int)
Deprecated: Use GetLocationRequest.ProtoReflect.Descriptor instead.
func (x *GetLocationRequest) GetName() string
func (*GetLocationRequest) ProtoMessage()
func (x *GetLocationRequest) ProtoReflect() protoreflect.Message
func (x *GetLocationRequest) Reset()
func (x *GetLocationRequest) String() string
The request message for [Locations.ListLocations][google.cloud.location.Locations.ListLocations].
type ListLocationsRequest struct {
// The resource that owns the locations collection, if applicable.
Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
// The standard list filter.
Filter string `protobuf:"bytes,2,opt,name=filter,proto3" json:"filter,omitempty"`
// The standard list page size.
PageSize int32 `protobuf:"varint,3,opt,name=page_size,json=pageSize,proto3" json:"page_size,omitempty"`
// The standard list page token.
PageToken string `protobuf:"bytes,4,opt,name=page_token,json=pageToken,proto3" json:"page_token,omitempty"`
// contains filtered or unexported fields
}
func (*ListLocationsRequest) Descriptor() ([]byte, []int)
Deprecated: Use ListLocationsRequest.ProtoReflect.Descriptor instead.
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
The response message for [Locations.ListLocations][google.cloud.location.Locations.ListLocations].
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.
NextPageToken string `protobuf:"bytes,2,opt,name=next_page_token,json=nextPageToken,proto3" json:"next_page_token,omitempty"`
// contains filtered or unexported fields
}
func (*ListLocationsResponse) Descriptor() ([]byte, []int)
Deprecated: Use ListLocationsResponse.ProtoReflect.Descriptor instead.
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
A resource that represents Google Cloud Platform 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,proto3" json:"name,omitempty"`
// The canonical id for this location. For example: `"us-east1"`.
LocationId string `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".
DisplayName string `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 `protobuf:"bytes,2,rep,name=labels,proto3" json:"labels,omitempty" protobuf_key:"bytes,1,opt,name=key,proto3" protobuf_val:"bytes,2,opt,name=value,proto3"`
// 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
}
func (*Location) Descriptor() ([]byte, []int)
Deprecated: Use Location.ProtoReflect.Descriptor instead.
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
LocationsClient is the client API for Locations service.
For semantics around ctx use and closing/ending streaming RPCs, please refer to https://godoc.org/google.golang.org/grpc#ClientConn.NewStream.
type LocationsClient interface {
// Lists information about the supported locations for this service.
ListLocations(ctx context.Context, in *ListLocationsRequest, opts ...grpc.CallOption) (*ListLocationsResponse, error)
// Gets information about a location.
GetLocation(ctx context.Context, in *GetLocationRequest, opts ...grpc.CallOption) (*Location, error)
}
func NewLocationsClient(cc grpc.ClientConnInterface) LocationsClient
LocationsServer is the server API for Locations service.
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)
}
UnimplementedLocationsServer can be embedded to have forward compatible implementations.
type UnimplementedLocationsServer struct {
}
func (*UnimplementedLocationsServer) GetLocation(context.Context, *GetLocationRequest) (*Location, error)
func (*UnimplementedLocationsServer) ListLocations(context.Context, *ListLocationsRequest) (*ListLocationsResponse, error)