Package cloud.google.com/go/shopping/merchant/quota/apiv1beta/quotapb (v0.8.7)

Version 0.8.7

• 0.12.1 (latest)
• 0.12.0
• 0.11.1
• 0.10.0
• 0.9.2
• 0.8.7
• 0.7.0
• 0.6.0
• 0.5.0
• 0.4.0
• 0.3.2
• 0.2.2

Beta

This library is covered by the Pre-GA Offerings Terms of the Terms of Service. Pre-GA libraries might have limited support, and changes to pre-GA libraries might not be compatible with other pre-GA versions. For more information, see the launch stage descriptions.

Note: To get more information about this package, such as access to older versions, view this package on pkg.go.dev.

Variables

File_google_shopping_merchant_quota_v1beta_quota_proto

var File_google_shopping_merchant_quota_v1beta_quota_proto protoreflect.FileDescriptor

Functions

func RegisterQuotaServiceServer

func RegisterQuotaServiceServer(s *grpc.Server, srv QuotaServiceServer)

ListQuotaGroupsRequest

type ListQuotaGroupsRequest struct {

	// Required. The merchant account who owns the collection of method quotas
	// Format: accounts/{account}
	Parent string `protobuf:"bytes,1,opt,name=parent,proto3" json:"parent,omitempty"`
	// Optional. The maximum number of quotas to return in the response, used
	// for paging. Defaults to 500; values above 1000 will be coerced to 1000.
	PageSize int32 `protobuf:"varint,2,opt,name=page_size,json=pageSize,proto3" json:"page_size,omitempty"`
	// Optional. Token (if provided) to retrieve the subsequent page. All other
	// parameters must match the original call that provided the page token.
	PageToken string `protobuf:"bytes,3,opt,name=page_token,json=pageToken,proto3" json:"page_token,omitempty"`
	// contains filtered or unexported fields
}

Request message for the ListQuotaGroups method.

func (*ListQuotaGroupsRequest) Descriptor

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

Deprecated: Use ListQuotaGroupsRequest.ProtoReflect.Descriptor instead.

func (*ListQuotaGroupsRequest) GetPageSize

func (x *ListQuotaGroupsRequest) GetPageSize() int32

func (*ListQuotaGroupsRequest) GetPageToken

func (x *ListQuotaGroupsRequest) GetPageToken() string

func (*ListQuotaGroupsRequest) GetParent

func (x *ListQuotaGroupsRequest) GetParent() string

func (*ListQuotaGroupsRequest) ProtoMessage

func (*ListQuotaGroupsRequest) ProtoMessage()

func (*ListQuotaGroupsRequest) ProtoReflect

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

func (*ListQuotaGroupsRequest) Reset

func (x *ListQuotaGroupsRequest) Reset()

func (*ListQuotaGroupsRequest) String

func (x *ListQuotaGroupsRequest) String() string

ListQuotaGroupsResponse

type ListQuotaGroupsResponse struct {

	// The methods, current quota usage and limits per each group. The quota is
	// shared between all methods in the group. The groups are sorted in
	// descending order based on
	// [quotaUsage][google.shopping.merchant.quota.v1main.QuotaGroup.quota_usage].
	QuotaGroups []*QuotaGroup `protobuf:"bytes,1,rep,name=quota_groups,json=quotaGroups,proto3" json:"quota_groups,omitempty"`
	// A token, which can be sent as `page_token` to retrieve the next page.
	// If this field is omitted, there are no subsequent pages.
	NextPageToken string `protobuf:"bytes,2,opt,name=next_page_token,json=nextPageToken,proto3" json:"next_page_token,omitempty"`
	// contains filtered or unexported fields
}

Response message for the ListMethodGroups method.

func (*ListQuotaGroupsResponse) Descriptor

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

Deprecated: Use ListQuotaGroupsResponse.ProtoReflect.Descriptor instead.

func (*ListQuotaGroupsResponse) GetNextPageToken

func (x *ListQuotaGroupsResponse) GetNextPageToken() string

func (*ListQuotaGroupsResponse) GetQuotaGroups

func (x *ListQuotaGroupsResponse) GetQuotaGroups() []*QuotaGroup

func (*ListQuotaGroupsResponse) ProtoMessage

func (*ListQuotaGroupsResponse) ProtoMessage()

func (*ListQuotaGroupsResponse) ProtoReflect

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

func (*ListQuotaGroupsResponse) Reset

func (x *ListQuotaGroupsResponse) Reset()

func (*ListQuotaGroupsResponse) String

func (x *ListQuotaGroupsResponse) String() string

MethodDetails

type MethodDetails struct {

	// Output only. The name of the method for example `products.list`.
	Method string `protobuf:"bytes,1,opt,name=method,proto3" json:"method,omitempty"`
	// Output only. The API version that the method belongs to.
	Version string `protobuf:"bytes,2,opt,name=version,proto3" json:"version,omitempty"`
	// Output only. The sub-API that the method belongs to.
	Subapi string `protobuf:"bytes,3,opt,name=subapi,proto3" json:"subapi,omitempty"`
	// Output only. The path for the method such as
	// `products/v1/productInputs.insert`
	Path string `protobuf:"bytes,4,opt,name=path,proto3" json:"path,omitempty"`
	// contains filtered or unexported fields
}

The method details per method in the Merchant API.

func (*MethodDetails) Descriptor

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

Deprecated: Use MethodDetails.ProtoReflect.Descriptor instead.

func (*MethodDetails) GetMethod

func (x *MethodDetails) GetMethod() string

func (*MethodDetails) GetPath

func (x *MethodDetails) GetPath() string

func (*MethodDetails) GetSubapi

func (x *MethodDetails) GetSubapi() string

func (*MethodDetails) GetVersion

func (x *MethodDetails) GetVersion() string

func (*MethodDetails) ProtoMessage

func (*MethodDetails) ProtoMessage()

func (*MethodDetails) ProtoReflect

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

func (*MethodDetails) Reset

func (x *MethodDetails) Reset()

func (*MethodDetails) String

func (x *MethodDetails) String() string

QuotaGroup

type QuotaGroup struct {

	// Identifier. The resource name of the quota group.
	// Format: accounts/{account}/quotas/{group}
	// Note: There is no guarantee on the format of {group}
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	// Output only. The current quota usage, meaning the number of calls already
	// made on a given day to the methods in the group. The daily quota limits
	// reset at at 12:00 PM midday UTC.
	QuotaUsage int64 `protobuf:"varint,2,opt,name=quota_usage,json=quotaUsage,proto3" json:"quota_usage,omitempty"`
	// Output only. The maximum number of calls allowed per day for the group.
	QuotaLimit int64 `protobuf:"varint,3,opt,name=quota_limit,json=quotaLimit,proto3" json:"quota_limit,omitempty"`
	// Output only. The maximum number of calls allowed per minute for the group.
	QuotaMinuteLimit int64 `protobuf:"varint,5,opt,name=quota_minute_limit,json=quotaMinuteLimit,proto3" json:"quota_minute_limit,omitempty"`
	// Output only. List of all methods group quota applies to.
	MethodDetails []*MethodDetails `protobuf:"bytes,4,rep,name=method_details,json=methodDetails,proto3" json:"method_details,omitempty"`
	// contains filtered or unexported fields
}

The group information for methods in the Merchant API. The quota is shared between all methods in the group. Even if none of the methods within the group have usage the information for the group is returned.

func (*QuotaGroup) Descriptor

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

Deprecated: Use QuotaGroup.ProtoReflect.Descriptor instead.

func (*QuotaGroup) GetMethodDetails

func (x *QuotaGroup) GetMethodDetails() []*MethodDetails

func (*QuotaGroup) GetName

func (x *QuotaGroup) GetName() string

func (*QuotaGroup) GetQuotaLimit

func (x *QuotaGroup) GetQuotaLimit() int64

func (*QuotaGroup) GetQuotaMinuteLimit

func (x *QuotaGroup) GetQuotaMinuteLimit() int64

func (*QuotaGroup) GetQuotaUsage

func (x *QuotaGroup) GetQuotaUsage() int64

func (*QuotaGroup) ProtoMessage

func (*QuotaGroup) ProtoMessage()

func (*QuotaGroup) ProtoReflect

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

func (*QuotaGroup) Reset

func (x *QuotaGroup) Reset()

func (*QuotaGroup) String

func (x *QuotaGroup) String() string

QuotaServiceClient

type QuotaServiceClient interface {
	// Lists the daily call quota and usage per group for your Merchant
	// Center account.
	ListQuotaGroups(ctx context.Context, in *ListQuotaGroupsRequest, opts ...grpc.CallOption) (*ListQuotaGroupsResponse, error)
}

QuotaServiceClient is the client API for QuotaService service.

For semantics around ctx use and closing/ending streaming RPCs, please refer to https://godoc.org/google.golang.org/grpc#ClientConn.NewStream.

func NewQuotaServiceClient

func NewQuotaServiceClient(cc grpc.ClientConnInterface) QuotaServiceClient

QuotaServiceServer

type QuotaServiceServer interface {
	// Lists the daily call quota and usage per group for your Merchant
	// Center account.
	ListQuotaGroups(context.Context, *ListQuotaGroupsRequest) (*ListQuotaGroupsResponse, error)
}

QuotaServiceServer is the server API for QuotaService service.

UnimplementedQuotaServiceServer

type UnimplementedQuotaServiceServer struct {
}

UnimplementedQuotaServiceServer can be embedded to have forward compatible implementations.

func (*UnimplementedQuotaServiceServer) ListQuotaGroups

func (*UnimplementedQuotaServiceServer) ListQuotaGroups(context.Context, *ListQuotaGroupsRequest) (*ListQuotaGroupsResponse, error)