cloudquotaspb

package
v0.2.0 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Apr 15, 2024 License: Apache-2.0 Imports: 12 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

View Source
var (
	QuotaSafetyCheck_name = map[int32]string{
		0: "QUOTA_SAFETY_CHECK_UNSPECIFIED",
		1: "QUOTA_DECREASE_BELOW_USAGE",
		2: "QUOTA_DECREASE_PERCENTAGE_TOO_HIGH",
	}
	QuotaSafetyCheck_value = map[string]int32{
		"QUOTA_SAFETY_CHECK_UNSPECIFIED":     0,
		"QUOTA_DECREASE_BELOW_USAGE":         1,
		"QUOTA_DECREASE_PERCENTAGE_TOO_HIGH": 2,
	}
)

Enum value maps for QuotaSafetyCheck.

View Source
var (
	QuotaInfo_ContainerType_name = map[int32]string{
		0: "CONTAINER_TYPE_UNSPECIFIED",
		1: "PROJECT",
		2: "FOLDER",
		3: "ORGANIZATION",
	}
	QuotaInfo_ContainerType_value = map[string]int32{
		"CONTAINER_TYPE_UNSPECIFIED": 0,
		"PROJECT":                    1,
		"FOLDER":                     2,
		"ORGANIZATION":               3,
	}
)

Enum value maps for QuotaInfo_ContainerType.

View Source
var (
	QuotaIncreaseEligibility_IneligibilityReason_name = map[int32]string{
		0: "INELIGIBILITY_REASON_UNSPECIFIED",
		1: "NO_VALID_BILLING_ACCOUNT",
		2: "OTHER",
	}
	QuotaIncreaseEligibility_IneligibilityReason_value = map[string]int32{
		"INELIGIBILITY_REASON_UNSPECIFIED": 0,
		"NO_VALID_BILLING_ACCOUNT":         1,
		"OTHER":                            2,
	}
)

Enum value maps for QuotaIncreaseEligibility_IneligibilityReason.

View Source
var (
	QuotaConfig_Origin_name = map[int32]string{
		0: "ORIGIN_UNSPECIFIED",
		1: "CLOUD_CONSOLE",
		2: "AUTO_ADJUSTER",
	}
	QuotaConfig_Origin_value = map[string]int32{
		"ORIGIN_UNSPECIFIED": 0,
		"CLOUD_CONSOLE":      1,
		"AUTO_ADJUSTER":      2,
	}
)

Enum value maps for QuotaConfig_Origin.

View Source
var File_google_api_cloudquotas_v1_cloudquotas_proto protoreflect.FileDescriptor
View Source
var File_google_api_cloudquotas_v1_resources_proto protoreflect.FileDescriptor

Functions

func RegisterCloudQuotasServer

func RegisterCloudQuotasServer(s *grpc.Server, srv CloudQuotasServer)

Types

type CloudQuotasClient

type CloudQuotasClient interface {
	// Lists QuotaInfos of all quotas for a given project, folder or organization.
	ListQuotaInfos(ctx context.Context, in *ListQuotaInfosRequest, opts ...grpc.CallOption) (*ListQuotaInfosResponse, error)
	// Retrieve the QuotaInfo of a quota for a project, folder or organization.
	GetQuotaInfo(ctx context.Context, in *GetQuotaInfoRequest, opts ...grpc.CallOption) (*QuotaInfo, error)
	// Lists QuotaPreferences in a given project, folder or organization.
	ListQuotaPreferences(ctx context.Context, in *ListQuotaPreferencesRequest, opts ...grpc.CallOption) (*ListQuotaPreferencesResponse, error)
	// Gets details of a single QuotaPreference.
	GetQuotaPreference(ctx context.Context, in *GetQuotaPreferenceRequest, opts ...grpc.CallOption) (*QuotaPreference, error)
	// Creates a new QuotaPreference that declares the desired value for a quota.
	CreateQuotaPreference(ctx context.Context, in *CreateQuotaPreferenceRequest, opts ...grpc.CallOption) (*QuotaPreference, error)
	// Updates the parameters of a single QuotaPreference. It can updates the
	// config in any states, not just the ones pending approval.
	UpdateQuotaPreference(ctx context.Context, in *UpdateQuotaPreferenceRequest, opts ...grpc.CallOption) (*QuotaPreference, error)
}

CloudQuotasClient is the client API for CloudQuotas service.

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

type CloudQuotasServer

type CloudQuotasServer interface {
	// Lists QuotaInfos of all quotas for a given project, folder or organization.
	ListQuotaInfos(context.Context, *ListQuotaInfosRequest) (*ListQuotaInfosResponse, error)
	// Retrieve the QuotaInfo of a quota for a project, folder or organization.
	GetQuotaInfo(context.Context, *GetQuotaInfoRequest) (*QuotaInfo, error)
	// Lists QuotaPreferences in a given project, folder or organization.
	ListQuotaPreferences(context.Context, *ListQuotaPreferencesRequest) (*ListQuotaPreferencesResponse, error)
	// Gets details of a single QuotaPreference.
	GetQuotaPreference(context.Context, *GetQuotaPreferenceRequest) (*QuotaPreference, error)
	// Creates a new QuotaPreference that declares the desired value for a quota.
	CreateQuotaPreference(context.Context, *CreateQuotaPreferenceRequest) (*QuotaPreference, error)
	// Updates the parameters of a single QuotaPreference. It can updates the
	// config in any states, not just the ones pending approval.
	UpdateQuotaPreference(context.Context, *UpdateQuotaPreferenceRequest) (*QuotaPreference, error)
}

CloudQuotasServer is the server API for CloudQuotas service.

type CreateQuotaPreferenceRequest

type CreateQuotaPreferenceRequest struct {

	// Required. Value for parent.
	//
	// Example:
	// `projects/123/locations/global`
	Parent string `protobuf:"bytes,1,opt,name=parent,proto3" json:"parent,omitempty"`
	// Optional. Id of the requesting object, must be unique under its parent.
	// If client does not set this field, the service will generate one.
	QuotaPreferenceId string `protobuf:"bytes,2,opt,name=quota_preference_id,json=quotaPreferenceId,proto3" json:"quota_preference_id,omitempty"`
	// Required. The resource being created
	QuotaPreference *QuotaPreference `protobuf:"bytes,3,opt,name=quota_preference,json=quotaPreference,proto3" json:"quota_preference,omitempty"`
	// The list of quota safety checks to be ignored.
	IgnoreSafetyChecks []QuotaSafetyCheck `` /* 173-byte string literal not displayed */
	// contains filtered or unexported fields
}

Message for creating a QuotaPreference

func (*CreateQuotaPreferenceRequest) Descriptor deprecated

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

Deprecated: Use CreateQuotaPreferenceRequest.ProtoReflect.Descriptor instead.

func (*CreateQuotaPreferenceRequest) GetIgnoreSafetyChecks

func (x *CreateQuotaPreferenceRequest) GetIgnoreSafetyChecks() []QuotaSafetyCheck

func (*CreateQuotaPreferenceRequest) GetParent

func (x *CreateQuotaPreferenceRequest) GetParent() string

func (*CreateQuotaPreferenceRequest) GetQuotaPreference

func (x *CreateQuotaPreferenceRequest) GetQuotaPreference() *QuotaPreference

func (*CreateQuotaPreferenceRequest) GetQuotaPreferenceId

func (x *CreateQuotaPreferenceRequest) GetQuotaPreferenceId() string

func (*CreateQuotaPreferenceRequest) ProtoMessage

func (*CreateQuotaPreferenceRequest) ProtoMessage()

func (*CreateQuotaPreferenceRequest) ProtoReflect

func (*CreateQuotaPreferenceRequest) Reset

func (x *CreateQuotaPreferenceRequest) Reset()

func (*CreateQuotaPreferenceRequest) String

type DimensionsInfo

type DimensionsInfo struct {

	// The map of dimensions for this dimensions info. The key of a map entry
	// is "region", "zone" or the name of a service specific dimension, and the
	// value of a map entry is the value of the dimension.  If a dimension does
	// not appear in the map of dimensions, the dimensions info applies to all
	// the dimension values except for those that have another DimenisonInfo
	// instance configured for the specific value.
	// Example: {"provider" : "Foo Inc"} where "provider" is a service specific
	// dimension of a quota.
	Dimensions map[string]string `` /* 161-byte string literal not displayed */
	// Quota details for the specified dimensions.
	Details *QuotaDetails `protobuf:"bytes,2,opt,name=details,proto3" json:"details,omitempty"`
	// The applicable regions or zones of this dimensions info. The field will be
	// set to ['global'] for quotas that are not per region or per zone.
	// Otherwise, it will be set to the list of locations this dimension info is
	// applicable to.
	ApplicableLocations []string `protobuf:"bytes,3,rep,name=applicable_locations,json=applicableLocations,proto3" json:"applicable_locations,omitempty"`
	// contains filtered or unexported fields
}

The detailed quota information such as effective quota value for a combination of dimensions.

func (*DimensionsInfo) Descriptor deprecated

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

Deprecated: Use DimensionsInfo.ProtoReflect.Descriptor instead.

func (*DimensionsInfo) GetApplicableLocations

func (x *DimensionsInfo) GetApplicableLocations() []string

func (*DimensionsInfo) GetDetails

func (x *DimensionsInfo) GetDetails() *QuotaDetails

func (*DimensionsInfo) GetDimensions

func (x *DimensionsInfo) GetDimensions() map[string]string

func (*DimensionsInfo) ProtoMessage

func (*DimensionsInfo) ProtoMessage()

func (*DimensionsInfo) ProtoReflect

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

func (*DimensionsInfo) Reset

func (x *DimensionsInfo) Reset()

func (*DimensionsInfo) String

func (x *DimensionsInfo) String() string

type GetQuotaInfoRequest

type GetQuotaInfoRequest struct {

	// Required. The resource name of the quota info.
	//
	// An example name:
	// `projects/123/locations/global/services/compute.googleapis.com/quotaInfos/CpusPerProjectPerRegion`
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	// contains filtered or unexported fields
}

Message for getting a QuotaInfo

func (*GetQuotaInfoRequest) Descriptor deprecated

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

Deprecated: Use GetQuotaInfoRequest.ProtoReflect.Descriptor instead.

func (*GetQuotaInfoRequest) GetName

func (x *GetQuotaInfoRequest) GetName() string

func (*GetQuotaInfoRequest) ProtoMessage

func (*GetQuotaInfoRequest) ProtoMessage()

func (*GetQuotaInfoRequest) ProtoReflect

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

func (*GetQuotaInfoRequest) Reset

func (x *GetQuotaInfoRequest) Reset()

func (*GetQuotaInfoRequest) String

func (x *GetQuotaInfoRequest) String() string

type GetQuotaPreferenceRequest

type GetQuotaPreferenceRequest struct {

	// Required. Name of the resource
	//
	// Example name:
	// `projects/123/locations/global/quota_preferences/my-config-for-us-east1`
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	// contains filtered or unexported fields
}

Message for getting a QuotaPreference

func (*GetQuotaPreferenceRequest) Descriptor deprecated

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

Deprecated: Use GetQuotaPreferenceRequest.ProtoReflect.Descriptor instead.

func (*GetQuotaPreferenceRequest) GetName

func (x *GetQuotaPreferenceRequest) GetName() string

func (*GetQuotaPreferenceRequest) ProtoMessage

func (*GetQuotaPreferenceRequest) ProtoMessage()

func (*GetQuotaPreferenceRequest) ProtoReflect

func (*GetQuotaPreferenceRequest) Reset

func (x *GetQuotaPreferenceRequest) Reset()

func (*GetQuotaPreferenceRequest) String

func (x *GetQuotaPreferenceRequest) String() string

type ListQuotaInfosRequest

type ListQuotaInfosRequest struct {

	// Required. Parent value of QuotaInfo resources.
	// Listing across different resource containers (such as 'projects/-') is not
	// allowed.
	//
	// Example names:
	// `projects/123/locations/global/services/compute.googleapis.com`
	// `folders/234/locations/global/services/compute.googleapis.com`
	// `organizations/345/locations/global/services/compute.googleapis.com`
	Parent string `protobuf:"bytes,1,opt,name=parent,proto3" json:"parent,omitempty"`
	// Optional. Requested page size. Server may return fewer items than
	// requested. 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.
	PageToken string `protobuf:"bytes,3,opt,name=page_token,json=pageToken,proto3" json:"page_token,omitempty"`
	// contains filtered or unexported fields
}

Message for requesting list of QuotaInfos

func (*ListQuotaInfosRequest) Descriptor deprecated

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

Deprecated: Use ListQuotaInfosRequest.ProtoReflect.Descriptor instead.

func (*ListQuotaInfosRequest) GetPageSize

func (x *ListQuotaInfosRequest) GetPageSize() int32

func (*ListQuotaInfosRequest) GetPageToken

func (x *ListQuotaInfosRequest) GetPageToken() string

func (*ListQuotaInfosRequest) GetParent

func (x *ListQuotaInfosRequest) GetParent() string

func (*ListQuotaInfosRequest) ProtoMessage

func (*ListQuotaInfosRequest) ProtoMessage()

func (*ListQuotaInfosRequest) ProtoReflect

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

func (*ListQuotaInfosRequest) Reset

func (x *ListQuotaInfosRequest) Reset()

func (*ListQuotaInfosRequest) String

func (x *ListQuotaInfosRequest) String() string

type ListQuotaInfosResponse

type ListQuotaInfosResponse struct {

	// The list of QuotaInfo
	QuotaInfos []*QuotaInfo `protobuf:"bytes,1,rep,name=quota_infos,json=quotaInfos,proto3" json:"quota_infos,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
}

Message for response to listing QuotaInfos

func (*ListQuotaInfosResponse) Descriptor deprecated

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

Deprecated: Use ListQuotaInfosResponse.ProtoReflect.Descriptor instead.

func (*ListQuotaInfosResponse) GetNextPageToken

func (x *ListQuotaInfosResponse) GetNextPageToken() string

func (*ListQuotaInfosResponse) GetQuotaInfos

func (x *ListQuotaInfosResponse) GetQuotaInfos() []*QuotaInfo

func (*ListQuotaInfosResponse) ProtoMessage

func (*ListQuotaInfosResponse) ProtoMessage()

func (*ListQuotaInfosResponse) ProtoReflect

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

func (*ListQuotaInfosResponse) Reset

func (x *ListQuotaInfosResponse) Reset()

func (*ListQuotaInfosResponse) String

func (x *ListQuotaInfosResponse) String() string

type ListQuotaPreferencesRequest

type ListQuotaPreferencesRequest struct {

	// Required. Parent value of QuotaPreference resources.
	// Listing across different resource containers (such as 'projects/-') is not
	// allowed.
	//
	// When the value starts with 'folders' or 'organizations', it lists the
	// QuotaPreferences for org quotas in the container. It does not list the
	// QuotaPreferences in the descendant projects of the container.
	//
	// Example parents:
	// `projects/123/locations/global`
	Parent string `protobuf:"bytes,1,opt,name=parent,proto3" json:"parent,omitempty"`
	// Optional. Requested page size. Server may return fewer items than
	// requested. 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.
	PageToken string `protobuf:"bytes,3,opt,name=page_token,json=pageToken,proto3" json:"page_token,omitempty"`
	// Optional. Filter result QuotaPreferences by their state, type,
	// create/update time range.
	//
	// Example filters:
	// `reconciling=true AND request_type=CLOUD_CONSOLE`,
	// `reconciling=true OR creation_time>2022-12-03T10:30:00`
	Filter string `protobuf:"bytes,4,opt,name=filter,proto3" json:"filter,omitempty"`
	// Optional. How to order of the results. By default, the results are ordered
	// by create time.
	//
	// Example orders:
	// `quota_id`,
	// `service, create_time`
	OrderBy string `protobuf:"bytes,5,opt,name=order_by,json=orderBy,proto3" json:"order_by,omitempty"`
	// contains filtered or unexported fields
}

Message for requesting list of QuotaPreferences

func (*ListQuotaPreferencesRequest) Descriptor deprecated

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

Deprecated: Use ListQuotaPreferencesRequest.ProtoReflect.Descriptor instead.

func (*ListQuotaPreferencesRequest) GetFilter

func (x *ListQuotaPreferencesRequest) GetFilter() string

func (*ListQuotaPreferencesRequest) GetOrderBy

func (x *ListQuotaPreferencesRequest) GetOrderBy() string

func (*ListQuotaPreferencesRequest) GetPageSize

func (x *ListQuotaPreferencesRequest) GetPageSize() int32

func (*ListQuotaPreferencesRequest) GetPageToken

func (x *ListQuotaPreferencesRequest) GetPageToken() string

func (*ListQuotaPreferencesRequest) GetParent

func (x *ListQuotaPreferencesRequest) GetParent() string

func (*ListQuotaPreferencesRequest) ProtoMessage

func (*ListQuotaPreferencesRequest) ProtoMessage()

func (*ListQuotaPreferencesRequest) ProtoReflect

func (*ListQuotaPreferencesRequest) Reset

func (x *ListQuotaPreferencesRequest) Reset()

func (*ListQuotaPreferencesRequest) String

func (x *ListQuotaPreferencesRequest) String() string

type ListQuotaPreferencesResponse

type ListQuotaPreferencesResponse struct {

	// The list of QuotaPreference
	QuotaPreferences []*QuotaPreference `protobuf:"bytes,1,rep,name=quota_preferences,json=quotaPreferences,proto3" json:"quota_preferences,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"`
	// Locations that could not be reached.
	Unreachable []string `protobuf:"bytes,3,rep,name=unreachable,proto3" json:"unreachable,omitempty"`
	// contains filtered or unexported fields
}

Message for response to listing QuotaPreferences

func (*ListQuotaPreferencesResponse) Descriptor deprecated

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

Deprecated: Use ListQuotaPreferencesResponse.ProtoReflect.Descriptor instead.

func (*ListQuotaPreferencesResponse) GetNextPageToken

func (x *ListQuotaPreferencesResponse) GetNextPageToken() string

func (*ListQuotaPreferencesResponse) GetQuotaPreferences

func (x *ListQuotaPreferencesResponse) GetQuotaPreferences() []*QuotaPreference

func (*ListQuotaPreferencesResponse) GetUnreachable

func (x *ListQuotaPreferencesResponse) GetUnreachable() []string

func (*ListQuotaPreferencesResponse) ProtoMessage

func (*ListQuotaPreferencesResponse) ProtoMessage()

func (*ListQuotaPreferencesResponse) ProtoReflect

func (*ListQuotaPreferencesResponse) Reset

func (x *ListQuotaPreferencesResponse) Reset()

func (*ListQuotaPreferencesResponse) String

type QuotaConfig

type QuotaConfig struct {

	// Required. The preferred value. Must be greater than or equal to -1. If set
	// to -1, it means the value is "unlimited".
	PreferredValue int64 `protobuf:"varint,1,opt,name=preferred_value,json=preferredValue,proto3" json:"preferred_value,omitempty"`
	// Output only. Optional details about the state of this quota preference.
	StateDetail string `protobuf:"bytes,2,opt,name=state_detail,json=stateDetail,proto3" json:"state_detail,omitempty"`
	// Output only. Granted quota value.
	GrantedValue *wrapperspb.Int64Value `protobuf:"bytes,3,opt,name=granted_value,json=grantedValue,proto3" json:"granted_value,omitempty"`
	// Output only. The trace id that the Google Cloud uses to provision the
	// requested quota. This trace id may be used by the client to contact Cloud
	// support to track the state of a quota preference request. The trace id is
	// only produced for increase requests and is unique for each request. The
	// quota decrease requests do not have a trace id.
	TraceId string `protobuf:"bytes,4,opt,name=trace_id,json=traceId,proto3" json:"trace_id,omitempty"`
	// Optional. The annotations map for clients to store small amounts of
	// arbitrary data. Do not put PII or other sensitive information here. See
	// https://google.aip.dev/128#annotations
	Annotations map[string]string `` /* 163-byte string literal not displayed */
	// Output only. The origin of the quota preference request.
	RequestOrigin QuotaConfig_Origin `` /* 151-byte string literal not displayed */
	// contains filtered or unexported fields
}

The preferred quota configuration.

func (*QuotaConfig) Descriptor deprecated

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

Deprecated: Use QuotaConfig.ProtoReflect.Descriptor instead.

func (*QuotaConfig) GetAnnotations

func (x *QuotaConfig) GetAnnotations() map[string]string

func (*QuotaConfig) GetGrantedValue

func (x *QuotaConfig) GetGrantedValue() *wrapperspb.Int64Value

func (*QuotaConfig) GetPreferredValue

func (x *QuotaConfig) GetPreferredValue() int64

func (*QuotaConfig) GetRequestOrigin

func (x *QuotaConfig) GetRequestOrigin() QuotaConfig_Origin

func (*QuotaConfig) GetStateDetail

func (x *QuotaConfig) GetStateDetail() string

func (*QuotaConfig) GetTraceId

func (x *QuotaConfig) GetTraceId() string

func (*QuotaConfig) ProtoMessage

func (*QuotaConfig) ProtoMessage()

func (*QuotaConfig) ProtoReflect

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

func (*QuotaConfig) Reset

func (x *QuotaConfig) Reset()

func (*QuotaConfig) String

func (x *QuotaConfig) String() string

type QuotaConfig_Origin

type QuotaConfig_Origin int32

The enumeration of the origins of quota preference requests.

const (
	// The unspecified value.
	QuotaConfig_ORIGIN_UNSPECIFIED QuotaConfig_Origin = 0
	// Created through Cloud Console.
	QuotaConfig_CLOUD_CONSOLE QuotaConfig_Origin = 1
	// Generated by automatic quota adjustment.
	QuotaConfig_AUTO_ADJUSTER QuotaConfig_Origin = 2
)

func (QuotaConfig_Origin) Descriptor

func (QuotaConfig_Origin) Enum

func (QuotaConfig_Origin) EnumDescriptor deprecated

func (QuotaConfig_Origin) EnumDescriptor() ([]byte, []int)

Deprecated: Use QuotaConfig_Origin.Descriptor instead.

func (QuotaConfig_Origin) Number

func (QuotaConfig_Origin) String

func (x QuotaConfig_Origin) String() string

func (QuotaConfig_Origin) Type

type QuotaDetails

type QuotaDetails struct {

	// The value currently in effect and being enforced.
	Value int64 `protobuf:"varint,1,opt,name=value,proto3" json:"value,omitempty"`
	// Rollout information of this quota.
	// This field is present only if the effective limit will change due to the
	// ongoing rollout of the service config.
	RolloutInfo *RolloutInfo `protobuf:"bytes,3,opt,name=rollout_info,json=rolloutInfo,proto3" json:"rollout_info,omitempty"`
	// contains filtered or unexported fields
}

The quota details for a map of dimensions.

func (*QuotaDetails) Descriptor deprecated

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

Deprecated: Use QuotaDetails.ProtoReflect.Descriptor instead.

func (*QuotaDetails) GetRolloutInfo added in v0.2.0

func (x *QuotaDetails) GetRolloutInfo() *RolloutInfo

func (*QuotaDetails) GetValue

func (x *QuotaDetails) GetValue() int64

func (*QuotaDetails) ProtoMessage

func (*QuotaDetails) ProtoMessage()

func (*QuotaDetails) ProtoReflect

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

func (*QuotaDetails) Reset

func (x *QuotaDetails) Reset()

func (*QuotaDetails) String

func (x *QuotaDetails) String() string

type QuotaIncreaseEligibility

type QuotaIncreaseEligibility struct {

	// Whether a higher quota value can be requested for the quota.
	IsEligible bool `protobuf:"varint,1,opt,name=is_eligible,json=isEligible,proto3" json:"is_eligible,omitempty"`
	// The reason of why it is ineligible to request increased value of the quota.
	// If the is_eligible field is true, it defaults to
	// INELIGIBILITY_REASON_UNSPECIFIED.
	IneligibilityReason QuotaIncreaseEligibility_IneligibilityReason `` /* 195-byte string literal not displayed */
	// contains filtered or unexported fields
}

Eligibility information regarding requesting increase adjustment of a quota.

func (*QuotaIncreaseEligibility) Descriptor deprecated

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

Deprecated: Use QuotaIncreaseEligibility.ProtoReflect.Descriptor instead.

func (*QuotaIncreaseEligibility) GetIneligibilityReason

func (*QuotaIncreaseEligibility) GetIsEligible

func (x *QuotaIncreaseEligibility) GetIsEligible() bool

func (*QuotaIncreaseEligibility) ProtoMessage

func (*QuotaIncreaseEligibility) ProtoMessage()

func (*QuotaIncreaseEligibility) ProtoReflect

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

func (*QuotaIncreaseEligibility) Reset

func (x *QuotaIncreaseEligibility) Reset()

func (*QuotaIncreaseEligibility) String

func (x *QuotaIncreaseEligibility) String() string

type QuotaIncreaseEligibility_IneligibilityReason

type QuotaIncreaseEligibility_IneligibilityReason int32

The enumeration of reasons when it is ineligible to request increase adjustment.

const (
	// Default value when is_eligible is true.
	QuotaIncreaseEligibility_INELIGIBILITY_REASON_UNSPECIFIED QuotaIncreaseEligibility_IneligibilityReason = 0
	// The container is not linked with a valid billing account.
	QuotaIncreaseEligibility_NO_VALID_BILLING_ACCOUNT QuotaIncreaseEligibility_IneligibilityReason = 1
	// Other reasons.
	QuotaIncreaseEligibility_OTHER QuotaIncreaseEligibility_IneligibilityReason = 2
)

func (QuotaIncreaseEligibility_IneligibilityReason) Descriptor

func (QuotaIncreaseEligibility_IneligibilityReason) Enum

func (QuotaIncreaseEligibility_IneligibilityReason) EnumDescriptor deprecated

func (QuotaIncreaseEligibility_IneligibilityReason) EnumDescriptor() ([]byte, []int)

Deprecated: Use QuotaIncreaseEligibility_IneligibilityReason.Descriptor instead.

func (QuotaIncreaseEligibility_IneligibilityReason) Number

func (QuotaIncreaseEligibility_IneligibilityReason) String

func (QuotaIncreaseEligibility_IneligibilityReason) Type

type QuotaInfo

type QuotaInfo struct {

	// Resource name of this QuotaInfo.
	// The ID component following "locations/" must be "global".
	// Example:
	// `projects/123/locations/global/services/compute.googleapis.com/quotaInfos/CpusPerProjectPerRegion`
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	// The id of the quota, which is unquie within the service.
	// Example: `CpusPerProjectPerRegion`
	QuotaId string `protobuf:"bytes,2,opt,name=quota_id,json=quotaId,proto3" json:"quota_id,omitempty"`
	// The metric of the quota. It specifies the resources consumption the quota
	// is defined for.
	// Example: `compute.googleapis.com/cpus`
	Metric string `protobuf:"bytes,3,opt,name=metric,proto3" json:"metric,omitempty"`
	// The name of the service in which the quota is defined.
	// Example: `compute.googleapis.com`
	Service string `protobuf:"bytes,4,opt,name=service,proto3" json:"service,omitempty"`
	// Whether this is a precise quota. A precise quota is tracked with absolute
	// precision. In contrast, an imprecise quota is not tracked with precision.
	IsPrecise bool `protobuf:"varint,5,opt,name=is_precise,json=isPrecise,proto3" json:"is_precise,omitempty"`
	// The reset time interval for the quota. Refresh interval applies to rate
	// quota only.
	// Example: "minute" for per minute, "day" for per day, or "10 seconds" for
	// every 10 seconds.
	RefreshInterval string `protobuf:"bytes,6,opt,name=refresh_interval,json=refreshInterval,proto3" json:"refresh_interval,omitempty"`
	// The container type of the QuotaInfo.
	ContainerType QuotaInfo_ContainerType `` /* 156-byte string literal not displayed */
	// The dimensions the quota is defined on.
	Dimensions []string `protobuf:"bytes,8,rep,name=dimensions,proto3" json:"dimensions,omitempty"`
	// The display name of the quota metric
	MetricDisplayName string `protobuf:"bytes,9,opt,name=metric_display_name,json=metricDisplayName,proto3" json:"metric_display_name,omitempty"`
	// The display name of the quota.
	QuotaDisplayName string `protobuf:"bytes,10,opt,name=quota_display_name,json=quotaDisplayName,proto3" json:"quota_display_name,omitempty"`
	// The unit in which the metric value is reported, e.g., "MByte".
	MetricUnit string `protobuf:"bytes,11,opt,name=metric_unit,json=metricUnit,proto3" json:"metric_unit,omitempty"`
	// Whether it is eligible to request a higher quota value for this quota.
	QuotaIncreaseEligibility *QuotaIncreaseEligibility `` /* 136-byte string literal not displayed */
	// Whether the quota value is fixed or adjustable
	IsFixed bool `protobuf:"varint,13,opt,name=is_fixed,json=isFixed,proto3" json:"is_fixed,omitempty"`
	// The collection of dimensions info ordered by their dimensions from more
	// specific ones to less specific ones.
	DimensionsInfos []*DimensionsInfo `protobuf:"bytes,14,rep,name=dimensions_infos,json=dimensionsInfos,proto3" json:"dimensions_infos,omitempty"`
	// Whether the quota is a concurrent quota. Concurrent quotas are enforced
	// on the total number of concurrent operations in flight at any given time.
	IsConcurrent bool `protobuf:"varint,15,opt,name=is_concurrent,json=isConcurrent,proto3" json:"is_concurrent,omitempty"`
	// URI to the page where users can request more quota for the cloud
	// service—for example,
	// https://console.cloud.google.com/iam-admin/quotas.
	ServiceRequestQuotaUri string `` /* 132-byte string literal not displayed */
	// contains filtered or unexported fields
}

QuotaInfo represents information about a particular quota for a given project, folder or organization.

func (*QuotaInfo) Descriptor deprecated

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

Deprecated: Use QuotaInfo.ProtoReflect.Descriptor instead.

func (*QuotaInfo) GetContainerType

func (x *QuotaInfo) GetContainerType() QuotaInfo_ContainerType

func (*QuotaInfo) GetDimensions

func (x *QuotaInfo) GetDimensions() []string

func (*QuotaInfo) GetDimensionsInfos

func (x *QuotaInfo) GetDimensionsInfos() []*DimensionsInfo

func (*QuotaInfo) GetIsConcurrent

func (x *QuotaInfo) GetIsConcurrent() bool

func (*QuotaInfo) GetIsFixed

func (x *QuotaInfo) GetIsFixed() bool

func (*QuotaInfo) GetIsPrecise

func (x *QuotaInfo) GetIsPrecise() bool

func (*QuotaInfo) GetMetric

func (x *QuotaInfo) GetMetric() string

func (*QuotaInfo) GetMetricDisplayName

func (x *QuotaInfo) GetMetricDisplayName() string

func (*QuotaInfo) GetMetricUnit

func (x *QuotaInfo) GetMetricUnit() string

func (*QuotaInfo) GetName

func (x *QuotaInfo) GetName() string

func (*QuotaInfo) GetQuotaDisplayName

func (x *QuotaInfo) GetQuotaDisplayName() string

func (*QuotaInfo) GetQuotaId

func (x *QuotaInfo) GetQuotaId() string

func (*QuotaInfo) GetQuotaIncreaseEligibility

func (x *QuotaInfo) GetQuotaIncreaseEligibility() *QuotaIncreaseEligibility

func (*QuotaInfo) GetRefreshInterval

func (x *QuotaInfo) GetRefreshInterval() string

func (*QuotaInfo) GetService

func (x *QuotaInfo) GetService() string

func (*QuotaInfo) GetServiceRequestQuotaUri

func (x *QuotaInfo) GetServiceRequestQuotaUri() string

func (*QuotaInfo) ProtoMessage

func (*QuotaInfo) ProtoMessage()

func (*QuotaInfo) ProtoReflect

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

func (*QuotaInfo) Reset

func (x *QuotaInfo) Reset()

func (*QuotaInfo) String

func (x *QuotaInfo) String() string

type QuotaInfo_ContainerType

type QuotaInfo_ContainerType int32

The enumeration of the types of a cloud resource container.

const (
	// Unspecified container type.
	QuotaInfo_CONTAINER_TYPE_UNSPECIFIED QuotaInfo_ContainerType = 0
	// consumer project
	QuotaInfo_PROJECT QuotaInfo_ContainerType = 1
	// folder
	QuotaInfo_FOLDER QuotaInfo_ContainerType = 2
	// organization
	QuotaInfo_ORGANIZATION QuotaInfo_ContainerType = 3
)

func (QuotaInfo_ContainerType) Descriptor

func (QuotaInfo_ContainerType) Enum

func (QuotaInfo_ContainerType) EnumDescriptor deprecated

func (QuotaInfo_ContainerType) EnumDescriptor() ([]byte, []int)

Deprecated: Use QuotaInfo_ContainerType.Descriptor instead.

func (QuotaInfo_ContainerType) Number

func (QuotaInfo_ContainerType) String

func (x QuotaInfo_ContainerType) String() string

func (QuotaInfo_ContainerType) Type

type QuotaPreference

type QuotaPreference struct {

	// Required except in the CREATE requests.
	// The resource name of the quota preference.
	// The ID component following "locations/" must be "global".
	// Example:
	// `projects/123/locations/global/quotaPreferences/my-config-for-us-east1`
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	// Immutable. The dimensions that this quota preference applies to. The key of
	// the map entry is the name of a dimension, such as "region", "zone",
	// "network_id", and the value of the map entry is the dimension value.
	//
	// If a dimension is missing from the map of dimensions, the quota preference
	// applies to all the dimension values except for those that have other quota
	// preferences configured for the specific value.
	//
	// NOTE: QuotaPreferences can only be applied across all values of "user" and
	// "resource" dimension. Do not set values for "user" or "resource" in the
	// dimension map.
	//
	// Example: {"provider", "Foo Inc"} where "provider" is a service specific
	// dimension.
	Dimensions map[string]string `` /* 161-byte string literal not displayed */
	// Required. Preferred quota configuration.
	QuotaConfig *QuotaConfig `protobuf:"bytes,3,opt,name=quota_config,json=quotaConfig,proto3" json:"quota_config,omitempty"`
	// Optional. The current etag of the quota preference. If an etag is provided
	// on update and does not match the current server's etag of the quota
	// preference, the request will be blocked and an ABORTED error will be
	// returned. See https://google.aip.dev/134#etags for more details on etags.
	Etag string `protobuf:"bytes,4,opt,name=etag,proto3" json:"etag,omitempty"`
	// Output only. Create time stamp
	CreateTime *timestamppb.Timestamp `protobuf:"bytes,5,opt,name=create_time,json=createTime,proto3" json:"create_time,omitempty"`
	// Output only. Update time stamp
	UpdateTime *timestamppb.Timestamp `protobuf:"bytes,6,opt,name=update_time,json=updateTime,proto3" json:"update_time,omitempty"`
	// Required. The name of the service to which the quota preference is applied.
	Service string `protobuf:"bytes,7,opt,name=service,proto3" json:"service,omitempty"`
	// Required. The id of the quota to which the quota preference is applied. A
	// quota name is unique in the service. Example: `CpusPerProjectPerRegion`
	QuotaId string `protobuf:"bytes,8,opt,name=quota_id,json=quotaId,proto3" json:"quota_id,omitempty"`
	// Output only. Is the quota preference pending Google Cloud approval and
	// fulfillment.
	Reconciling bool `protobuf:"varint,10,opt,name=reconciling,proto3" json:"reconciling,omitempty"`
	// The reason / justification for this quota preference.
	Justification string `protobuf:"bytes,11,opt,name=justification,proto3" json:"justification,omitempty"`
	// Input only. An email address that can be used for quota related
	// communication between the Google Cloud and the user in case the Google
	// Cloud needs further information to make a decision on whether the user
	// preferred quota can be granted.
	//
	// The email address is optional for decrease quota preferences. In another
	// word, QuotaConfig.preferred_value is smaller than the
	// QuotaDetails.reset_value. It is required for increase quota preferences.
	// The Google account for the email address must have quota update permission
	// for the project, folder or organization this quota preference is for.
	ContactEmail string `protobuf:"bytes,12,opt,name=contact_email,json=contactEmail,proto3" json:"contact_email,omitempty"`
	// contains filtered or unexported fields
}

QuotaPreference represents the preferred quota configuration specified for a project, folder or organization. There is only one QuotaPreference resource for a quota value targeting a unique set of dimensions.

func (*QuotaPreference) Descriptor deprecated

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

Deprecated: Use QuotaPreference.ProtoReflect.Descriptor instead.

func (*QuotaPreference) GetContactEmail

func (x *QuotaPreference) GetContactEmail() string

func (*QuotaPreference) GetCreateTime

func (x *QuotaPreference) GetCreateTime() *timestamppb.Timestamp

func (*QuotaPreference) GetDimensions

func (x *QuotaPreference) GetDimensions() map[string]string

func (*QuotaPreference) GetEtag

func (x *QuotaPreference) GetEtag() string

func (*QuotaPreference) GetJustification

func (x *QuotaPreference) GetJustification() string

func (*QuotaPreference) GetName

func (x *QuotaPreference) GetName() string

func (*QuotaPreference) GetQuotaConfig

func (x *QuotaPreference) GetQuotaConfig() *QuotaConfig

func (*QuotaPreference) GetQuotaId

func (x *QuotaPreference) GetQuotaId() string

func (*QuotaPreference) GetReconciling

func (x *QuotaPreference) GetReconciling() bool

func (*QuotaPreference) GetService

func (x *QuotaPreference) GetService() string

func (*QuotaPreference) GetUpdateTime

func (x *QuotaPreference) GetUpdateTime() *timestamppb.Timestamp

func (*QuotaPreference) ProtoMessage

func (*QuotaPreference) ProtoMessage()

func (*QuotaPreference) ProtoReflect

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

func (*QuotaPreference) Reset

func (x *QuotaPreference) Reset()

func (*QuotaPreference) String

func (x *QuotaPreference) String() string

type QuotaSafetyCheck

type QuotaSafetyCheck int32

Enumerations of quota safety checks.

const (
	// Unspecified quota safety check.
	QuotaSafetyCheck_QUOTA_SAFETY_CHECK_UNSPECIFIED QuotaSafetyCheck = 0
	// Validates that a quota mutation would not cause the consumer's effective
	// limit to be lower than the consumer's quota usage.
	QuotaSafetyCheck_QUOTA_DECREASE_BELOW_USAGE QuotaSafetyCheck = 1
	// Validates that a quota mutation would not cause the consumer's effective
	// limit to decrease by more than 10 percent.
	QuotaSafetyCheck_QUOTA_DECREASE_PERCENTAGE_TOO_HIGH QuotaSafetyCheck = 2
)

func (QuotaSafetyCheck) Descriptor

func (QuotaSafetyCheck) Enum

func (QuotaSafetyCheck) EnumDescriptor deprecated

func (QuotaSafetyCheck) EnumDescriptor() ([]byte, []int)

Deprecated: Use QuotaSafetyCheck.Descriptor instead.

func (QuotaSafetyCheck) Number

func (QuotaSafetyCheck) String

func (x QuotaSafetyCheck) String() string

func (QuotaSafetyCheck) Type

type RolloutInfo added in v0.2.0

type RolloutInfo struct {

	// Whether there is an ongoing rollout for a quota or not.
	OngoingRollout bool `protobuf:"varint,1,opt,name=ongoing_rollout,json=ongoingRollout,proto3" json:"ongoing_rollout,omitempty"`
	// contains filtered or unexported fields
}

[Output only] Rollout information of a quota.

func (*RolloutInfo) Descriptor deprecated added in v0.2.0

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

Deprecated: Use RolloutInfo.ProtoReflect.Descriptor instead.

func (*RolloutInfo) GetOngoingRollout added in v0.2.0

func (x *RolloutInfo) GetOngoingRollout() bool

func (*RolloutInfo) ProtoMessage added in v0.2.0

func (*RolloutInfo) ProtoMessage()

func (*RolloutInfo) ProtoReflect added in v0.2.0

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

func (*RolloutInfo) Reset added in v0.2.0

func (x *RolloutInfo) Reset()

func (*RolloutInfo) String added in v0.2.0

func (x *RolloutInfo) String() string

type UnimplementedCloudQuotasServer

type UnimplementedCloudQuotasServer struct {
}

UnimplementedCloudQuotasServer can be embedded to have forward compatible implementations.

func (*UnimplementedCloudQuotasServer) CreateQuotaPreference

func (*UnimplementedCloudQuotasServer) GetQuotaInfo

func (*UnimplementedCloudQuotasServer) GetQuotaPreference

func (*UnimplementedCloudQuotasServer) ListQuotaInfos

func (*UnimplementedCloudQuotasServer) ListQuotaPreferences

func (*UnimplementedCloudQuotasServer) UpdateQuotaPreference

type UpdateQuotaPreferenceRequest

type UpdateQuotaPreferenceRequest struct {

	// Optional. Field mask is used to specify the fields to be overwritten in the
	// QuotaPreference resource by the update.
	// The fields specified in the update_mask are relative to the resource, not
	// the full request. A field will be overwritten if it is in the mask. If the
	// user does not provide a mask then all fields will be overwritten.
	UpdateMask *fieldmaskpb.FieldMask `protobuf:"bytes,1,opt,name=update_mask,json=updateMask,proto3" json:"update_mask,omitempty"`
	// Required. The resource being updated
	QuotaPreference *QuotaPreference `protobuf:"bytes,2,opt,name=quota_preference,json=quotaPreference,proto3" json:"quota_preference,omitempty"`
	// Optional. If set to true, and the quota preference is not found, a new one
	// will be created. In this situation, `update_mask` is ignored.
	AllowMissing bool `protobuf:"varint,3,opt,name=allow_missing,json=allowMissing,proto3" json:"allow_missing,omitempty"`
	// Optional. If set to true, validate the request, but do not actually update.
	// Note that a request being valid does not mean that the request is
	// guaranteed to be fulfilled.
	ValidateOnly bool `protobuf:"varint,4,opt,name=validate_only,json=validateOnly,proto3" json:"validate_only,omitempty"`
	// The list of quota safety checks to be ignored.
	IgnoreSafetyChecks []QuotaSafetyCheck `` /* 173-byte string literal not displayed */
	// contains filtered or unexported fields
}

Message for updating a QuotaPreference

func (*UpdateQuotaPreferenceRequest) Descriptor deprecated

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

Deprecated: Use UpdateQuotaPreferenceRequest.ProtoReflect.Descriptor instead.

func (*UpdateQuotaPreferenceRequest) GetAllowMissing

func (x *UpdateQuotaPreferenceRequest) GetAllowMissing() bool

func (*UpdateQuotaPreferenceRequest) GetIgnoreSafetyChecks

func (x *UpdateQuotaPreferenceRequest) GetIgnoreSafetyChecks() []QuotaSafetyCheck

func (*UpdateQuotaPreferenceRequest) GetQuotaPreference

func (x *UpdateQuotaPreferenceRequest) GetQuotaPreference() *QuotaPreference

func (*UpdateQuotaPreferenceRequest) GetUpdateMask

func (*UpdateQuotaPreferenceRequest) GetValidateOnly

func (x *UpdateQuotaPreferenceRequest) GetValidateOnly() bool

func (*UpdateQuotaPreferenceRequest) ProtoMessage

func (*UpdateQuotaPreferenceRequest) ProtoMessage()

func (*UpdateQuotaPreferenceRequest) ProtoReflect

func (*UpdateQuotaPreferenceRequest) Reset

func (x *UpdateQuotaPreferenceRequest) Reset()

func (*UpdateQuotaPreferenceRequest) String

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL