locationfinderpb

type CloudLocation struct {

	// Identifier. Name of the cloud location. Unique name of the cloud location
	// including project and location using the form:
	// `projects/{project_id}/locations/{location}/cloudLocations/{cloud_location}`
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	// Output only. The containing cloud location in the strict nesting hierarchy.
	// For example, the containing cloud location of a zone is a region.
	ContainingCloudLocation string `` /* 132-byte string literal not displayed */
	// Optional. The human-readable name of the cloud location. Example:
	// us-east-2, us-east1.
	DisplayName string `protobuf:"bytes,3,opt,name=display_name,json=displayName,proto3" json:"display_name,omitempty"`
	// Optional. The provider of the cloud location. Values can be Google Cloud or
	// third-party providers, including AWS, Azure, or Oracle Cloud
	// Infrastructure.
	CloudProvider CloudLocation_CloudProvider `` /* 165-byte string literal not displayed */
	// Optional. The two-letter ISO 3166-1 alpha-2 code of the cloud location.
	// Examples: US, JP, KR.
	TerritoryCode string `protobuf:"bytes,5,opt,name=territory_code,json=territoryCode,proto3" json:"territory_code,omitempty"`
	// Optional. The type of the cloud location.
	CloudLocationType CloudLocation_CloudLocationType `` /* 183-byte string literal not displayed */
	// Optional. The carbon free energy percentage of the cloud location. This
	// represents the average percentage of time customers' application will be
	// running on carbon-free energy. See
	// https://cloud.google.com/sustainability/region-carbon for more details.
	// There is a difference between default value 0 and unset value. 0 means the
	// carbon free energy percentage is 0%, while unset value means the carbon
	// footprint data is not available.
	CarbonFreeEnergyPercentage *float32 `` /* 151-byte string literal not displayed */
	// contains filtered or unexported fields
}

type CloudLocationFinderClient interface {
	// Lists cloud locations under a given project and location.
	ListCloudLocations(ctx context.Context, in *ListCloudLocationsRequest, opts ...grpc.CallOption) (*ListCloudLocationsResponse, error)
	// Retrieves a resource containing information about a cloud location.
	GetCloudLocation(ctx context.Context, in *GetCloudLocationRequest, opts ...grpc.CallOption) (*CloudLocation, error)
	// Searches for cloud locations from a given source location.
	SearchCloudLocations(ctx context.Context, in *SearchCloudLocationsRequest, opts ...grpc.CallOption) (*SearchCloudLocationsResponse, error)
}

type CloudLocationFinderServer interface {
	// Lists cloud locations under a given project and location.
	ListCloudLocations(context.Context, *ListCloudLocationsRequest) (*ListCloudLocationsResponse, error)
	// Retrieves a resource containing information about a cloud location.
	GetCloudLocation(context.Context, *GetCloudLocationRequest) (*CloudLocation, error)
	// Searches for cloud locations from a given source location.
	SearchCloudLocations(context.Context, *SearchCloudLocationsRequest) (*SearchCloudLocationsResponse, error)
}

type CloudLocation_CloudLocationType int32

type CloudLocation_CloudProvider int32

type GetCloudLocationRequest struct {

	// Required. Name of the resource.
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	// contains filtered or unexported fields
}

type ListCloudLocationsRequest struct {

	// Required. The parent, which owns this collection of cloud locations.
	// Format: projects/{project}/locations/{location}
	Parent string `protobuf:"bytes,1,opt,name=parent,proto3" json:"parent,omitempty"`
	// Optional. The maximum number of cloud locations to return per page. The
	// service might return fewer cloud locations than this value. If unspecified,
	// server will pick an appropriate default.
	PageSize int32 `protobuf:"varint,2,opt,name=page_size,json=pageSize,proto3" json:"page_size,omitempty"`
	// Optional. A token identifying a page of results the server should return.
	// Provide page token returned by a previous 'ListCloudLocations' call to
	// retrieve the next page of results. When paginating, all other parameters
	// provided to 'ListCloudLocations' must match the call that provided the page
	// token.
	PageToken string `protobuf:"bytes,3,opt,name=page_token,json=pageToken,proto3" json:"page_token,omitempty"`
	// Optional. A filter expression that filters resources listed in the
	// response. The expression is in the form of field=value. For example,
	// 'cloud_location_type=CLOUD_LOCATION_TYPE_REGION'. Multiple filter queries
	// are space-separated. For example,
	// 'cloud_location_type=CLOUD_LOCATION_TYPE_REGION territory_code="US"' By
	// default, each expression is an AND expression. However, you can include AND
	// and OR expressions explicitly.
	Filter string `protobuf:"bytes,4,opt,name=filter,proto3" json:"filter,omitempty"`
	// contains filtered or unexported fields
}

type ListCloudLocationsResponse struct {

	// Output only. List of cloud locations.
	CloudLocations []*CloudLocation `protobuf:"bytes,1,rep,name=cloud_locations,json=cloudLocations,proto3" json:"cloud_locations,omitempty"`
	// Output only. The continuation token, used to page through large result
	// sets. Provide this value in a subsequent request as page_token in
	// subsequent requests to retrieve the next page. If this field is not
	// present, there are no subsequent results.
	NextPageToken string `protobuf:"bytes,2,opt,name=next_page_token,json=nextPageToken,proto3" json:"next_page_token,omitempty"`
	// contains filtered or unexported fields
}

type SearchCloudLocationsRequest struct {

	// Required. The parent, which owns this collection of cloud locations.
	// Format: projects/{project}/locations/{location}
	Parent string `protobuf:"bytes,1,opt,name=parent,proto3" json:"parent,omitempty"`
	// Required. The source cloud location to search from.
	// Example search can be searching nearby cloud locations from the source
	// cloud location by latency.
	SourceCloudLocation string `protobuf:"bytes,2,opt,name=source_cloud_location,json=sourceCloudLocation,proto3" json:"source_cloud_location,omitempty"`
	// Optional. The maximum number of cloud locations to return. The service
	// might return fewer cloud locations than this value. If unspecified, server
	// will pick an appropriate default.
	PageSize int32 `protobuf:"varint,3,opt,name=page_size,json=pageSize,proto3" json:"page_size,omitempty"`
	// Optional. A token identifying a page of results the server should return.
	// Provide Page token returned by a previous 'ListCloudLocations' call to
	// retrieve the next page of results. When paginating, all other parameters
	// provided to 'ListCloudLocations' must match the call that provided the page
	// token.
	PageToken string `protobuf:"bytes,4,opt,name=page_token,json=pageToken,proto3" json:"page_token,omitempty"`
	// Optional. The query string in search query syntax. While filter is used to
	// filter the search results by attributes, query is used to specify the
	// search requirements.
	Query string `protobuf:"bytes,6,opt,name=query,proto3" json:"query,omitempty"`
	// contains filtered or unexported fields
}

type SearchCloudLocationsResponse struct {

	// Output only. List of cloud locations.
	CloudLocations []*CloudLocation `protobuf:"bytes,1,rep,name=cloud_locations,json=cloudLocations,proto3" json:"cloud_locations,omitempty"`
	// Output only. The continuation token, used to page through large result
	// sets. Provide this value in a subsequent request as page_token in
	// subsequent requests to retrieve the next page. If this field is not
	// present, there are no subsequent results.
	NextPageToken string `protobuf:"bytes,2,opt,name=next_page_token,json=nextPageToken,proto3" json:"next_page_token,omitempty"`
	// contains filtered or unexported fields
}

type UnimplementedCloudLocationFinderServer struct {
}

type UnsafeCloudLocationFinderServer interface {
	// contains filtered or unexported methods
}