genproto: google.golang.org/genproto/googleapis/cloud/location Index | Files

package location

import "google.golang.org/genproto/googleapis/cloud/location"

Index

Package Files

locations.pb.go

Variables

var File_google_cloud_location_locations_proto protoreflect.FileDescriptor

func RegisterLocationsServer Uses

func RegisterLocationsServer(s *grpc.Server, srv LocationsServer)

type GetLocationRequest Uses

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
}

The request message for [Locations.GetLocation][google.cloud.location.Locations.GetLocation].

func (*GetLocationRequest) Descriptor Uses

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

Deprecated: Use GetLocationRequest.ProtoReflect.Descriptor instead.

func (*GetLocationRequest) GetName Uses

func (x *GetLocationRequest) GetName() string

func (*GetLocationRequest) ProtoMessage Uses

func (*GetLocationRequest) ProtoMessage()

func (*GetLocationRequest) ProtoReflect Uses

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

func (*GetLocationRequest) Reset Uses

func (x *GetLocationRequest) Reset()

func (*GetLocationRequest) String Uses

func (x *GetLocationRequest) String() string

type ListLocationsRequest Uses

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
}

The request message for [Locations.ListLocations][google.cloud.location.Locations.ListLocations].

func (*ListLocationsRequest) Descriptor Uses

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

Deprecated: Use ListLocationsRequest.ProtoReflect.Descriptor instead.

func (*ListLocationsRequest) GetFilter Uses

func (x *ListLocationsRequest) GetFilter() string

func (*ListLocationsRequest) GetName Uses

func (x *ListLocationsRequest) GetName() string

func (*ListLocationsRequest) GetPageSize Uses

func (x *ListLocationsRequest) GetPageSize() int32

func (*ListLocationsRequest) GetPageToken Uses

func (x *ListLocationsRequest) GetPageToken() string

func (*ListLocationsRequest) ProtoMessage Uses

func (*ListLocationsRequest) ProtoMessage()

func (*ListLocationsRequest) ProtoReflect Uses

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

func (*ListLocationsRequest) Reset Uses

func (x *ListLocationsRequest) Reset()

func (*ListLocationsRequest) String Uses

func (x *ListLocationsRequest) String() string

type ListLocationsResponse Uses

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
}

The response message for [Locations.ListLocations][google.cloud.location.Locations.ListLocations].

func (*ListLocationsResponse) Descriptor Uses

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

Deprecated: Use ListLocationsResponse.ProtoReflect.Descriptor instead.

func (*ListLocationsResponse) GetLocations Uses

func (x *ListLocationsResponse) GetLocations() []*Location

func (*ListLocationsResponse) GetNextPageToken Uses

func (x *ListLocationsResponse) GetNextPageToken() string

func (*ListLocationsResponse) ProtoMessage Uses

func (*ListLocationsResponse) ProtoMessage()

func (*ListLocationsResponse) ProtoReflect Uses

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

func (*ListLocationsResponse) Reset Uses

func (x *ListLocationsResponse) Reset()

func (*ListLocationsResponse) String Uses

func (x *ListLocationsResponse) String() string

type Location Uses

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 *any.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) Descriptor Uses

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

Deprecated: Use Location.ProtoReflect.Descriptor instead.

func (*Location) GetDisplayName Uses

func (x *Location) GetDisplayName() string

func (*Location) GetLabels Uses

func (x *Location) GetLabels() map[string]string

func (*Location) GetLocationId Uses

func (x *Location) GetLocationId() string

func (*Location) GetMetadata Uses

func (x *Location) GetMetadata() *any.Any

func (*Location) GetName Uses

func (x *Location) GetName() string

func (*Location) ProtoMessage Uses

func (*Location) ProtoMessage()

func (*Location) ProtoReflect Uses

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

func (*Location) Reset Uses

func (x *Location) Reset()

func (*Location) String Uses

func (x *Location) String() string

type LocationsClient Uses

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)
}

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.

func NewLocationsClient Uses

func NewLocationsClient(cc grpc.ClientConnInterface) LocationsClient

type LocationsServer Uses

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.

type UnimplementedLocationsServer Uses

type UnimplementedLocationsServer struct {
}

UnimplementedLocationsServer can be embedded to have forward compatible implementations.

func (*UnimplementedLocationsServer) GetLocation Uses

func (*UnimplementedLocationsServer) GetLocation(context.Context, *GetLocationRequest) (*Location, error)

func (*UnimplementedLocationsServer) ListLocations Uses

func (*UnimplementedLocationsServer) ListLocations(context.Context, *ListLocationsRequest) (*ListLocationsResponse, error)

Package location imports 11 packages (graph). Updated 2020-08-13. Refresh now. Tools for package owners.