Enum value maps for Lifecycle_State.
var (
Lifecycle_State_name = map[int32]string{
0: "STATE_UNSPECIFIED",
1: "UNPUBLISHED_DRAFT",
2: "PUBLISHED",
3: "DISABLED",
4: "DELETED",
}
Lifecycle_State_value = map[string]int32{
"STATE_UNSPECIFIED": 0,
"UNPUBLISHED_DRAFT": 1,
"PUBLISHED": 2,
"DISABLED": 3,
"DELETED": 4,
}
)
Enum value maps for InvalidArgument_FieldViolation_Reason.
var (
InvalidArgument_FieldViolation_Reason_name = map[int32]string{
0: "REASON_UNSPECIFIED",
1: "FIELD_REQUIRED",
2: "INVALID_VALUE",
3: "VALUE_OUT_OF_RANGE",
4: "STRING_VALUE_TOO_LONG",
5: "MAX_ENTRIES_EXCEEDED",
6: "FIELD_NOT_FOUND",
7: "CHOICE_NOT_FOUND",
}
InvalidArgument_FieldViolation_Reason_value = map[string]int32{
"REASON_UNSPECIFIED": 0,
"FIELD_REQUIRED": 1,
"INVALID_VALUE": 2,
"VALUE_OUT_OF_RANGE": 3,
"STRING_VALUE_TOO_LONG": 4,
"MAX_ENTRIES_EXCEEDED": 5,
"FIELD_NOT_FOUND": 6,
"CHOICE_NOT_FOUND": 7,
}
)
Enum value maps for PreconditionFailure_Violation_Reason.
var (
PreconditionFailure_Violation_Reason_name = map[int32]string{
0: "REASON_UNSPECIFIED",
1: "CANNOT_DISABLE",
2: "CANNOT_ENABLE",
3: "CANNOT_PUBLISH",
4: "CANNOT_UNPUBLISH",
5: "CANNOT_DELETE",
6: "CANNOT_RESTRICT_RANGE",
7: "CANNOT_CHANGE_PUBLISHED_FIELD",
8: "CANNOT_CREATE_MORE_LABELS",
9: "CANNOT_CHANGE_PUBLISHED_FIELD_TYPE",
10: "CANNOT_MODIFY_LOCKED_COMPONENT",
}
PreconditionFailure_Violation_Reason_value = map[string]int32{
"REASON_UNSPECIFIED": 0,
"CANNOT_DISABLE": 1,
"CANNOT_ENABLE": 2,
"CANNOT_PUBLISH": 3,
"CANNOT_UNPUBLISH": 4,
"CANNOT_DELETE": 5,
"CANNOT_RESTRICT_RANGE": 6,
"CANNOT_CHANGE_PUBLISHED_FIELD": 7,
"CANNOT_CREATE_MORE_LABELS": 8,
"CANNOT_CHANGE_PUBLISHED_FIELD_TYPE": 9,
"CANNOT_MODIFY_LOCKED_COMPONENT": 10,
}
)
Enum value maps for ExceptionType.
var (
ExceptionType_name = map[int32]string{
0: "EXCEPTION_TYPE_UNSPECIFIED",
1: "FIELD_REQUIRED",
2: "METAMODEL_ALREADY_EXISTS",
3: "METAMODEL_NOT_FOUND",
4: "ILLEGAL_METAMODEL_STATE_TRANSITION",
5: "INVALID_METAMODEL_DEPRECATION_POLICY",
6: "METAMODEL_DELETION_DENIED_UNTIL",
7: "INVALID_FIELD",
8: "METAMODEL_PRECONDITION_FAILED",
9: "DUPLICATE_FIELD_KEY",
10: "ILLEGAL_FIELD_REMOVAL",
11: "ILLEGAL_FIELD_OPTIONS_FOR_FIELD",
12: "UNSUPPORTED_CHANGE_TO_PUBLISHED_METAMODEL",
13: "ILLEGAL_METAMODEL_STATE_TRANSITION_IN_UPDATE",
14: "PAGE_TOKEN_EXPIRED",
15: "NOT_AUTHORIZED",
16: "ILLEGAL_FIELD_STATE_TRANSITION",
17: "ILLEGAL_CHOICE_SET_OPTION_STATE_TRANSITION",
18: "INVALID_CHOICE_SET_OPTIONS",
19: "INVALID_FIELD_KEY",
20: "INVALID_FIELD_PROPERTY_RANGE",
21: "INVALID_LOCALIZED_STRING",
22: "ILLEGAL_CHANGE_TO_PUBLISHED_FIELD",
23: "INVALID_FIELD_UPDATE_NOT_INCLUSIVE",
24: "INVALID_CHOICE_SET_STATE",
500: "INTERNAL_SERVER_ERROR",
}
ExceptionType_value = map[string]int32{
"EXCEPTION_TYPE_UNSPECIFIED": 0,
"FIELD_REQUIRED": 1,
"METAMODEL_ALREADY_EXISTS": 2,
"METAMODEL_NOT_FOUND": 3,
"ILLEGAL_METAMODEL_STATE_TRANSITION": 4,
"INVALID_METAMODEL_DEPRECATION_POLICY": 5,
"METAMODEL_DELETION_DENIED_UNTIL": 6,
"INVALID_FIELD": 7,
"METAMODEL_PRECONDITION_FAILED": 8,
"DUPLICATE_FIELD_KEY": 9,
"ILLEGAL_FIELD_REMOVAL": 10,
"ILLEGAL_FIELD_OPTIONS_FOR_FIELD": 11,
"UNSUPPORTED_CHANGE_TO_PUBLISHED_METAMODEL": 12,
"ILLEGAL_METAMODEL_STATE_TRANSITION_IN_UPDATE": 13,
"PAGE_TOKEN_EXPIRED": 14,
"NOT_AUTHORIZED": 15,
"ILLEGAL_FIELD_STATE_TRANSITION": 16,
"ILLEGAL_CHOICE_SET_OPTION_STATE_TRANSITION": 17,
"INVALID_CHOICE_SET_OPTIONS": 18,
"INVALID_FIELD_KEY": 19,
"INVALID_FIELD_PROPERTY_RANGE": 20,
"INVALID_LOCALIZED_STRING": 21,
"ILLEGAL_CHANGE_TO_PUBLISHED_FIELD": 22,
"INVALID_FIELD_UPDATE_NOT_INCLUSIVE": 23,
"INVALID_CHOICE_SET_STATE": 24,
"INTERNAL_SERVER_ERROR": 500,
}
)
Enum value maps for Field_DateOptions_DateFormat.
var (
Field_DateOptions_DateFormat_name = map[int32]string{
0: "DATE_FORMAT_UNSPECIFIED",
1: "LONG_DATE",
2: "SHORT_DATE",
}
Field_DateOptions_DateFormat_value = map[string]int32{
"DATE_FORMAT_UNSPECIFIED": 0,
"LONG_DATE": 1,
"SHORT_DATE": 2,
}
)
Enum value maps for Label_LabelType.
var (
Label_LabelType_name = map[int32]string{
0: "LABEL_TYPE_UNSPECIFIED",
1: "SHARED",
2: "ADMIN",
3: "GOOGLE_APP",
}
Label_LabelType_value = map[string]int32{
"LABEL_TYPE_UNSPECIFIED": 0,
"SHARED": 1,
"ADMIN": 2,
"GOOGLE_APP": 3,
}
)
Enum value maps for Label_AppliedLabelPolicy_CopyMode.
var (
Label_AppliedLabelPolicy_CopyMode_name = map[int32]string{
0: "COPY_MODE_UNSPECIFIED",
1: "DO_NOT_COPY",
2: "ALWAYS_COPY",
3: "COPY_APPLIABLE",
}
Label_AppliedLabelPolicy_CopyMode_value = map[string]int32{
"COPY_MODE_UNSPECIFIED": 0,
"DO_NOT_COPY": 1,
"ALWAYS_COPY": 2,
"COPY_APPLIABLE": 3,
}
)
Enum value maps for LabelLock_State.
var (
LabelLock_State_name = map[int32]string{
0: "STATE_UNSPECIFIED",
1: "ACTIVE",
2: "DELETING",
}
LabelLock_State_value = map[string]int32{
"STATE_UNSPECIFIED": 0,
"ACTIVE": 1,
"DELETING": 2,
}
)
Enum value maps for LabelPermission_LabelRole.
var (
LabelPermission_LabelRole_name = map[int32]string{
0: "LABEL_ROLE_UNSPECIFIED",
1: "READER",
2: "APPLIER",
3: "ORGANIZER",
4: "EDITOR",
}
LabelPermission_LabelRole_value = map[string]int32{
"LABEL_ROLE_UNSPECIFIED": 0,
"READER": 1,
"APPLIER": 2,
"ORGANIZER": 3,
"EDITOR": 4,
}
)
Enum value maps for LabelView.
var (
LabelView_name = map[int32]string{
0: "LABEL_VIEW_BASIC",
1: "LABEL_VIEW_FULL",
}
LabelView_value = map[string]int32{
"LABEL_VIEW_BASIC": 0,
"LABEL_VIEW_FULL": 1,
}
)
var File_google_apps_drive_labels_v2beta_common_proto protoreflect.FileDescriptor
var File_google_apps_drive_labels_v2beta_error_details_proto protoreflect.FileDescriptor
var File_google_apps_drive_labels_v2beta_exception_detail_proto protoreflect.FileDescriptor
var File_google_apps_drive_labels_v2beta_field_proto protoreflect.FileDescriptor
var File_google_apps_drive_labels_v2beta_label_limits_proto protoreflect.FileDescriptor
var File_google_apps_drive_labels_v2beta_label_lock_proto protoreflect.FileDescriptor
var File_google_apps_drive_labels_v2beta_label_permission_proto protoreflect.FileDescriptor
var File_google_apps_drive_labels_v2beta_label_proto protoreflect.FileDescriptor
var File_google_apps_drive_labels_v2beta_label_service_proto protoreflect.FileDescriptor
var File_google_apps_drive_labels_v2beta_requests_proto protoreflect.FileDescriptor
var File_google_apps_drive_labels_v2beta_user_capabilities_proto protoreflect.FileDescriptor
func RegisterLabelServiceServer(s *grpc.Server, srv LabelServiceServer)
The color derived from BadgeConfig and changed to the closest recommended supported color.
type BadgeColors struct {
// Output only. Badge background that pairs with the foreground.
BackgroundColor *color.Color `protobuf:"bytes,1,opt,name=background_color,json=backgroundColor,proto3" json:"background_color,omitempty"`
// Output only. Badge foreground that pairs with the background.
ForegroundColor *color.Color `protobuf:"bytes,2,opt,name=foreground_color,json=foregroundColor,proto3" json:"foreground_color,omitempty"`
// Output only. Color that can be used for text without a background.
SoloColor *color.Color `protobuf:"bytes,3,opt,name=solo_color,json=soloColor,proto3" json:"solo_color,omitempty"`
// contains filtered or unexported fields
}
func (*BadgeColors) Descriptor() ([]byte, []int)
Deprecated: Use BadgeColors.ProtoReflect.Descriptor instead.
func (x *BadgeColors) GetBackgroundColor() *color.Color
func (x *BadgeColors) GetForegroundColor() *color.Color
func (x *BadgeColors) GetSoloColor() *color.Color
func (*BadgeColors) ProtoMessage()
func (x *BadgeColors) ProtoReflect() protoreflect.Message
func (x *BadgeColors) Reset()
func (x *BadgeColors) String() string
Badge status of the label.
type BadgeConfig struct {
// The color of the badge. When not specified, no badge is rendered.
// The background, foreground, and solo (light and dark mode) colors set here
// are changed in the Drive UI into the closest recommended supported color.
Color *color.Color `protobuf:"bytes,1,opt,name=color,proto3" json:"color,omitempty"`
// Override the default global priority of this badge.
// When set to 0, the default priority heuristic is used.
PriorityOverride int64 `protobuf:"varint,2,opt,name=priority_override,json=priorityOverride,proto3" json:"priority_override,omitempty"`
// contains filtered or unexported fields
}
func (*BadgeConfig) Descriptor() ([]byte, []int)
Deprecated: Use BadgeConfig.ProtoReflect.Descriptor instead.
func (x *BadgeConfig) GetColor() *color.Color
func (x *BadgeConfig) GetPriorityOverride() int64
func (*BadgeConfig) ProtoMessage()
func (x *BadgeConfig) ProtoReflect() protoreflect.Message
func (x *BadgeConfig) Reset()
func (x *BadgeConfig) String() string
Deletes one of more Label Permissions.
type BatchDeleteLabelPermissionsRequest struct {
// Required. The request message specifying the resources to update.
Requests []*DeleteLabelPermissionRequest `protobuf:"bytes,1,rep,name=requests,proto3" json:"requests,omitempty"`
// Set to `true` in order to use the user's admin credentials. The server
// will verify the user is an admin for the Label before allowing access.
// If this is set, the use_admin_access field in the
// DeleteLabelPermissionRequest messages must either be empty or match this
// field.
UseAdminAccess bool `protobuf:"varint,2,opt,name=use_admin_access,json=useAdminAccess,proto3" json:"use_admin_access,omitempty"`
// Required. The parent Label resource name shared by all permissions being
// deleted. Format: labels/{label} If this is set, the parent field in the
// UpdateLabelPermissionRequest messages must either be empty or match this
// field.
Parent string `protobuf:"bytes,3,opt,name=parent,proto3" json:"parent,omitempty"`
// contains filtered or unexported fields
}
func (*BatchDeleteLabelPermissionsRequest) Descriptor() ([]byte, []int)
Deprecated: Use BatchDeleteLabelPermissionsRequest.ProtoReflect.Descriptor instead.
func (x *BatchDeleteLabelPermissionsRequest) GetParent() string
func (x *BatchDeleteLabelPermissionsRequest) GetRequests() []*DeleteLabelPermissionRequest
func (x *BatchDeleteLabelPermissionsRequest) GetUseAdminAccess() bool
func (*BatchDeleteLabelPermissionsRequest) ProtoMessage()
func (x *BatchDeleteLabelPermissionsRequest) ProtoReflect() protoreflect.Message
func (x *BatchDeleteLabelPermissionsRequest) Reset()
func (x *BatchDeleteLabelPermissionsRequest) String() string
Updates one or more Label Permissions.
type BatchUpdateLabelPermissionsRequest struct {
// Required. The parent Label resource name shared by all permissions being
// updated. Format: labels/{label} If this is set, the parent field in the
// UpdateLabelPermissionRequest messages must either be empty or match this
// field.
Parent string `protobuf:"bytes,1,opt,name=parent,proto3" json:"parent,omitempty"`
// Required. The request message specifying the resources to update.
Requests []*UpdateLabelPermissionRequest `protobuf:"bytes,2,rep,name=requests,proto3" json:"requests,omitempty"`
// Set to `true` in order to use the user's admin credentials. The server
// will verify the user is an admin for the Label before allowing access.
// If this is set, the use_admin_access field in the
// UpdateLabelPermissionRequest messages must either be empty or match this
// field.
UseAdminAccess bool `protobuf:"varint,3,opt,name=use_admin_access,json=useAdminAccess,proto3" json:"use_admin_access,omitempty"`
// contains filtered or unexported fields
}
func (*BatchUpdateLabelPermissionsRequest) Descriptor() ([]byte, []int)
Deprecated: Use BatchUpdateLabelPermissionsRequest.ProtoReflect.Descriptor instead.
func (x *BatchUpdateLabelPermissionsRequest) GetParent() string
func (x *BatchUpdateLabelPermissionsRequest) GetRequests() []*UpdateLabelPermissionRequest
func (x *BatchUpdateLabelPermissionsRequest) GetUseAdminAccess() bool
func (*BatchUpdateLabelPermissionsRequest) ProtoMessage()
func (x *BatchUpdateLabelPermissionsRequest) ProtoReflect() protoreflect.Message
func (x *BatchUpdateLabelPermissionsRequest) Reset()
func (x *BatchUpdateLabelPermissionsRequest) String() string
Response for updating one or more Label Permissions.
type BatchUpdateLabelPermissionsResponse struct {
// Required. Permissions updated.
Permissions []*LabelPermission `protobuf:"bytes,1,rep,name=permissions,proto3" json:"permissions,omitempty"`
// contains filtered or unexported fields
}
func (*BatchUpdateLabelPermissionsResponse) Descriptor() ([]byte, []int)
Deprecated: Use BatchUpdateLabelPermissionsResponse.ProtoReflect.Descriptor instead.
func (x *BatchUpdateLabelPermissionsResponse) GetPermissions() []*LabelPermission
func (*BatchUpdateLabelPermissionsResponse) ProtoMessage()
func (x *BatchUpdateLabelPermissionsResponse) ProtoReflect() protoreflect.Message
func (x *BatchUpdateLabelPermissionsResponse) Reset()
func (x *BatchUpdateLabelPermissionsResponse) String() string
Creates or updates a permission on the Label. Permissions affect the Label resource as a whole, are not revisioned, and do not require publishing.
type CreateLabelPermissionRequest struct {
// Required. The parent Label resource name on the Label Permission is
// created. Format: labels/{label}
Parent string `protobuf:"bytes,1,opt,name=parent,proto3" json:"parent,omitempty"`
// Required. The permission to create or update on the Label.
LabelPermission *LabelPermission `protobuf:"bytes,2,opt,name=label_permission,json=labelPermission,proto3" json:"label_permission,omitempty"`
// Set to `true` in order to use the user's admin credentials. The server
// will verify the user is an admin for the Label before allowing access.
UseAdminAccess bool `protobuf:"varint,3,opt,name=use_admin_access,json=useAdminAccess,proto3" json:"use_admin_access,omitempty"`
// contains filtered or unexported fields
}
func (*CreateLabelPermissionRequest) Descriptor() ([]byte, []int)
Deprecated: Use CreateLabelPermissionRequest.ProtoReflect.Descriptor instead.
func (x *CreateLabelPermissionRequest) GetLabelPermission() *LabelPermission
func (x *CreateLabelPermissionRequest) GetParent() string
func (x *CreateLabelPermissionRequest) GetUseAdminAccess() bool
func (*CreateLabelPermissionRequest) ProtoMessage()
func (x *CreateLabelPermissionRequest) ProtoReflect() protoreflect.Message
func (x *CreateLabelPermissionRequest) Reset()
func (x *CreateLabelPermissionRequest) String() string
Request to create a Label.
type CreateLabelRequest struct {
// Required. The label to create.
Label *Label `protobuf:"bytes,1,opt,name=label,proto3" json:"label,omitempty"`
// Set to `true` in order to use the user's admin privileges. The server
// will verify the user is an admin before allowing access.
UseAdminAccess bool `protobuf:"varint,2,opt,name=use_admin_access,json=useAdminAccess,proto3" json:"use_admin_access,omitempty"`
// The BCP-47 language code to use for evaluating localized Field labels in
// response. When not specified, values in the default configured language
// will be used.
LanguageCode string `protobuf:"bytes,3,opt,name=language_code,json=languageCode,proto3" json:"language_code,omitempty"`
// contains filtered or unexported fields
}
func (*CreateLabelRequest) Descriptor() ([]byte, []int)
Deprecated: Use CreateLabelRequest.ProtoReflect.Descriptor instead.
func (x *CreateLabelRequest) GetLabel() *Label
func (x *CreateLabelRequest) GetLanguageCode() string
func (x *CreateLabelRequest) GetUseAdminAccess() bool
func (*CreateLabelRequest) ProtoMessage()
func (x *CreateLabelRequest) ProtoReflect() protoreflect.Message
func (x *CreateLabelRequest) Reset()
func (x *CreateLabelRequest) String() string
Limits for date Field type.
type DateLimits struct {
// Minimum value for the date Field type.
MinValue *date.Date `protobuf:"bytes,1,opt,name=min_value,json=minValue,proto3" json:"min_value,omitempty"`
// Maximum value for the date Field type.
MaxValue *date.Date `protobuf:"bytes,2,opt,name=max_value,json=maxValue,proto3" json:"max_value,omitempty"`
// contains filtered or unexported fields
}
func (*DateLimits) Descriptor() ([]byte, []int)
Deprecated: Use DateLimits.ProtoReflect.Descriptor instead.
func (x *DateLimits) GetMaxValue() *date.Date
func (x *DateLimits) GetMinValue() *date.Date
func (*DateLimits) ProtoMessage()
func (x *DateLimits) ProtoReflect() protoreflect.Message
func (x *DateLimits) Reset()
func (x *DateLimits) String() string
Deletes a Label Permission. Permissions affect the Label resource as a whole, are not revisioned, and do not require publishing.
type DeleteLabelPermissionRequest struct {
// Required. Label Permission resource name.
Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
// Set to `true` in order to use the user's admin credentials. The server
// will verify the user is an admin for the Label before allowing access.
UseAdminAccess bool `protobuf:"varint,2,opt,name=use_admin_access,json=useAdminAccess,proto3" json:"use_admin_access,omitempty"`
// contains filtered or unexported fields
}
func (*DeleteLabelPermissionRequest) Descriptor() ([]byte, []int)
Deprecated: Use DeleteLabelPermissionRequest.ProtoReflect.Descriptor instead.
func (x *DeleteLabelPermissionRequest) GetName() string
func (x *DeleteLabelPermissionRequest) GetUseAdminAccess() bool
func (*DeleteLabelPermissionRequest) ProtoMessage()
func (x *DeleteLabelPermissionRequest) ProtoReflect() protoreflect.Message
func (x *DeleteLabelPermissionRequest) Reset()
func (x *DeleteLabelPermissionRequest) String() string
Request to delete a label.
type DeleteLabelRequest struct {
// Required. Label resource name.
Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
// Set to `true` in order to use the user's admin credentials. The server
// will verify the user is an admin for the Label before allowing access.
UseAdminAccess bool `protobuf:"varint,2,opt,name=use_admin_access,json=useAdminAccess,proto3" json:"use_admin_access,omitempty"`
// Provides control over how write requests are executed. Defaults to unset,
// which means last write wins.
WriteControl *WriteControl `protobuf:"bytes,3,opt,name=write_control,json=writeControl,proto3" json:"write_control,omitempty"`
// contains filtered or unexported fields
}
func (*DeleteLabelRequest) Descriptor() ([]byte, []int)
Deprecated: Use DeleteLabelRequest.ProtoReflect.Descriptor instead.
func (x *DeleteLabelRequest) GetName() string
func (x *DeleteLabelRequest) GetUseAdminAccess() bool
func (x *DeleteLabelRequest) GetWriteControl() *WriteControl
func (*DeleteLabelRequest) ProtoMessage()
func (x *DeleteLabelRequest) ProtoReflect() protoreflect.Message
func (x *DeleteLabelRequest) Reset()
func (x *DeleteLabelRequest) String() string
The set of requests for updating aspects of a Label. If any request is not valid, no requests will be applied.
type DeltaUpdateLabelRequest struct {
// Required. The resource name of the Label to update.
Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
// Provides control over how write requests are executed.
WriteControl *WriteControl `protobuf:"bytes,2,opt,name=write_control,json=writeControl,proto3" json:"write_control,omitempty"`
// A list of updates to apply to the Label.
// Requests will be applied in the order they are specified.
Requests []*DeltaUpdateLabelRequest_Request `protobuf:"bytes,3,rep,name=requests,proto3" json:"requests,omitempty"`
// Set to `true` in order to use the user's admin credentials. The server
// will verify the user is an admin for the Label before allowing access.
UseAdminAccess bool `protobuf:"varint,4,opt,name=use_admin_access,json=useAdminAccess,proto3" json:"use_admin_access,omitempty"`
// When specified, only certain fields belonging to the indicated view will be
// returned.
View LabelView `protobuf:"varint,5,opt,name=view,proto3,enum=google.apps.drive.labels.v2beta.LabelView" json:"view,omitempty"`
// The BCP-47 language code to use for evaluating localized Field labels when
// `include_label_in_response` is `true`.
LanguageCode string `protobuf:"bytes,6,opt,name=language_code,json=languageCode,proto3" json:"language_code,omitempty"`
// contains filtered or unexported fields
}
func (*DeltaUpdateLabelRequest) Descriptor() ([]byte, []int)
Deprecated: Use DeltaUpdateLabelRequest.ProtoReflect.Descriptor instead.
func (x *DeltaUpdateLabelRequest) GetLanguageCode() string
func (x *DeltaUpdateLabelRequest) GetName() string
func (x *DeltaUpdateLabelRequest) GetRequests() []*DeltaUpdateLabelRequest_Request
func (x *DeltaUpdateLabelRequest) GetUseAdminAccess() bool
func (x *DeltaUpdateLabelRequest) GetView() LabelView
func (x *DeltaUpdateLabelRequest) GetWriteControl() *WriteControl
func (*DeltaUpdateLabelRequest) ProtoMessage()
func (x *DeltaUpdateLabelRequest) ProtoReflect() protoreflect.Message
func (x *DeltaUpdateLabelRequest) Reset()
func (x *DeltaUpdateLabelRequest) String() string
Request to create a Field within a Label.
type DeltaUpdateLabelRequest_CreateFieldRequest struct {
// Required. Field to create.
Field *Field `protobuf:"bytes,1,opt,name=field,proto3" json:"field,omitempty"`
// contains filtered or unexported fields
}
func (*DeltaUpdateLabelRequest_CreateFieldRequest) Descriptor() ([]byte, []int)
Deprecated: Use DeltaUpdateLabelRequest_CreateFieldRequest.ProtoReflect.Descriptor instead.
func (x *DeltaUpdateLabelRequest_CreateFieldRequest) GetField() *Field
func (*DeltaUpdateLabelRequest_CreateFieldRequest) ProtoMessage()
func (x *DeltaUpdateLabelRequest_CreateFieldRequest) ProtoReflect() protoreflect.Message
func (x *DeltaUpdateLabelRequest_CreateFieldRequest) Reset()
func (x *DeltaUpdateLabelRequest_CreateFieldRequest) String() string
Request to create a Selection Choice.
type DeltaUpdateLabelRequest_CreateSelectionChoiceRequest struct {
// Required. The Selection Field in which a Choice will be created.
FieldId string `protobuf:"bytes,1,opt,name=field_id,json=fieldId,proto3" json:"field_id,omitempty"`
// Required. The Choice to create.
Choice *Field_SelectionOptions_Choice `protobuf:"bytes,2,opt,name=choice,proto3" json:"choice,omitempty"`
// contains filtered or unexported fields
}
func (*DeltaUpdateLabelRequest_CreateSelectionChoiceRequest) Descriptor() ([]byte, []int)
Deprecated: Use DeltaUpdateLabelRequest_CreateSelectionChoiceRequest.ProtoReflect.Descriptor instead.
func (x *DeltaUpdateLabelRequest_CreateSelectionChoiceRequest) GetChoice() *Field_SelectionOptions_Choice
func (x *DeltaUpdateLabelRequest_CreateSelectionChoiceRequest) GetFieldId() string
func (*DeltaUpdateLabelRequest_CreateSelectionChoiceRequest) ProtoMessage()
func (x *DeltaUpdateLabelRequest_CreateSelectionChoiceRequest) ProtoReflect() protoreflect.Message
func (x *DeltaUpdateLabelRequest_CreateSelectionChoiceRequest) Reset()
func (x *DeltaUpdateLabelRequest_CreateSelectionChoiceRequest) String() string
Request to delete the Field.
type DeltaUpdateLabelRequest_DeleteFieldRequest struct {
// Required. ID of the Field to delete.
Id string `protobuf:"bytes,1,opt,name=id,proto3" json:"id,omitempty"`
// contains filtered or unexported fields
}
func (*DeltaUpdateLabelRequest_DeleteFieldRequest) Descriptor() ([]byte, []int)
Deprecated: Use DeltaUpdateLabelRequest_DeleteFieldRequest.ProtoReflect.Descriptor instead.
func (x *DeltaUpdateLabelRequest_DeleteFieldRequest) GetId() string
func (*DeltaUpdateLabelRequest_DeleteFieldRequest) ProtoMessage()
func (x *DeltaUpdateLabelRequest_DeleteFieldRequest) ProtoReflect() protoreflect.Message
func (x *DeltaUpdateLabelRequest_DeleteFieldRequest) Reset()
func (x *DeltaUpdateLabelRequest_DeleteFieldRequest) String() string
Request to delete a Choice.
type DeltaUpdateLabelRequest_DeleteSelectionChoiceRequest struct {
// Required. The Selection Field from which a Choice will be deleted.
FieldId string `protobuf:"bytes,1,opt,name=field_id,json=fieldId,proto3" json:"field_id,omitempty"`
// Required. Choice to delete.
Id string `protobuf:"bytes,2,opt,name=id,proto3" json:"id,omitempty"`
// contains filtered or unexported fields
}
func (*DeltaUpdateLabelRequest_DeleteSelectionChoiceRequest) Descriptor() ([]byte, []int)
Deprecated: Use DeltaUpdateLabelRequest_DeleteSelectionChoiceRequest.ProtoReflect.Descriptor instead.
func (x *DeltaUpdateLabelRequest_DeleteSelectionChoiceRequest) GetFieldId() string
func (x *DeltaUpdateLabelRequest_DeleteSelectionChoiceRequest) GetId() string
func (*DeltaUpdateLabelRequest_DeleteSelectionChoiceRequest) ProtoMessage()
func (x *DeltaUpdateLabelRequest_DeleteSelectionChoiceRequest) ProtoReflect() protoreflect.Message
func (x *DeltaUpdateLabelRequest_DeleteSelectionChoiceRequest) Reset()
func (x *DeltaUpdateLabelRequest_DeleteSelectionChoiceRequest) String() string
Request to disable the Field.
type DeltaUpdateLabelRequest_DisableFieldRequest struct {
// The fields that should be updated. At least one field must be specified.
// The root `disabled_policy` is implied and should not be specified. A
// single `*` can be used as short-hand for updating every field.
UpdateMask *fieldmaskpb.FieldMask `protobuf:"bytes,1,opt,name=update_mask,json=updateMask,proto3" json:"update_mask,omitempty"`
// Required. Key of the Field to disable.
Id string `protobuf:"bytes,2,opt,name=id,proto3" json:"id,omitempty"`
// Required. Field Disabled Policy.
DisabledPolicy *Lifecycle_DisabledPolicy `protobuf:"bytes,3,opt,name=disabled_policy,json=disabledPolicy,proto3" json:"disabled_policy,omitempty"`
// contains filtered or unexported fields
}
func (*DeltaUpdateLabelRequest_DisableFieldRequest) Descriptor() ([]byte, []int)
Deprecated: Use DeltaUpdateLabelRequest_DisableFieldRequest.ProtoReflect.Descriptor instead.
func (x *DeltaUpdateLabelRequest_DisableFieldRequest) GetDisabledPolicy() *Lifecycle_DisabledPolicy
func (x *DeltaUpdateLabelRequest_DisableFieldRequest) GetId() string
func (x *DeltaUpdateLabelRequest_DisableFieldRequest) GetUpdateMask() *fieldmaskpb.FieldMask
func (*DeltaUpdateLabelRequest_DisableFieldRequest) ProtoMessage()
func (x *DeltaUpdateLabelRequest_DisableFieldRequest) ProtoReflect() protoreflect.Message
func (x *DeltaUpdateLabelRequest_DisableFieldRequest) Reset()
func (x *DeltaUpdateLabelRequest_DisableFieldRequest) String() string
Request to disable a Choice.
type DeltaUpdateLabelRequest_DisableSelectionChoiceRequest struct {
// The fields that should be updated. At least one field must be specified.
// The root `disabled_policy` is implied and should not be specified. A
// single `*` can be used as short-hand for updating every field.
UpdateMask *fieldmaskpb.FieldMask `protobuf:"bytes,1,opt,name=update_mask,json=updateMask,proto3" json:"update_mask,omitempty"`
// Required. The Selection Field in which a Choice will be disabled.
FieldId string `protobuf:"bytes,2,opt,name=field_id,json=fieldId,proto3" json:"field_id,omitempty"`
// Required. Choice to disable.
Id string `protobuf:"bytes,3,opt,name=id,proto3" json:"id,omitempty"`
// Required. The disabled policy to update.
DisabledPolicy *Lifecycle_DisabledPolicy `protobuf:"bytes,4,opt,name=disabled_policy,json=disabledPolicy,proto3" json:"disabled_policy,omitempty"`
// contains filtered or unexported fields
}
func (*DeltaUpdateLabelRequest_DisableSelectionChoiceRequest) Descriptor() ([]byte, []int)
Deprecated: Use DeltaUpdateLabelRequest_DisableSelectionChoiceRequest.ProtoReflect.Descriptor instead.
func (x *DeltaUpdateLabelRequest_DisableSelectionChoiceRequest) GetDisabledPolicy() *Lifecycle_DisabledPolicy
func (x *DeltaUpdateLabelRequest_DisableSelectionChoiceRequest) GetFieldId() string
func (x *DeltaUpdateLabelRequest_DisableSelectionChoiceRequest) GetId() string
func (x *DeltaUpdateLabelRequest_DisableSelectionChoiceRequest) GetUpdateMask() *fieldmaskpb.FieldMask
func (*DeltaUpdateLabelRequest_DisableSelectionChoiceRequest) ProtoMessage()
func (x *DeltaUpdateLabelRequest_DisableSelectionChoiceRequest) ProtoReflect() protoreflect.Message
func (x *DeltaUpdateLabelRequest_DisableSelectionChoiceRequest) Reset()
func (x *DeltaUpdateLabelRequest_DisableSelectionChoiceRequest) String() string
Request to enable the Field.
type DeltaUpdateLabelRequest_EnableFieldRequest struct {
// Required. ID of the Field to enable.
Id string `protobuf:"bytes,1,opt,name=id,proto3" json:"id,omitempty"`
// contains filtered or unexported fields
}
func (*DeltaUpdateLabelRequest_EnableFieldRequest) Descriptor() ([]byte, []int)
Deprecated: Use DeltaUpdateLabelRequest_EnableFieldRequest.ProtoReflect.Descriptor instead.
func (x *DeltaUpdateLabelRequest_EnableFieldRequest) GetId() string
func (*DeltaUpdateLabelRequest_EnableFieldRequest) ProtoMessage()
func (x *DeltaUpdateLabelRequest_EnableFieldRequest) ProtoReflect() protoreflect.Message
func (x *DeltaUpdateLabelRequest_EnableFieldRequest) Reset()
func (x *DeltaUpdateLabelRequest_EnableFieldRequest) String() string
Request to enable a Choice.
type DeltaUpdateLabelRequest_EnableSelectionChoiceRequest struct {
// Required. The Selection Field in which a Choice will be enabled.
FieldId string `protobuf:"bytes,1,opt,name=field_id,json=fieldId,proto3" json:"field_id,omitempty"`
// Required. Choice to enable.
Id string `protobuf:"bytes,2,opt,name=id,proto3" json:"id,omitempty"`
// contains filtered or unexported fields
}
func (*DeltaUpdateLabelRequest_EnableSelectionChoiceRequest) Descriptor() ([]byte, []int)
Deprecated: Use DeltaUpdateLabelRequest_EnableSelectionChoiceRequest.ProtoReflect.Descriptor instead.
func (x *DeltaUpdateLabelRequest_EnableSelectionChoiceRequest) GetFieldId() string
func (x *DeltaUpdateLabelRequest_EnableSelectionChoiceRequest) GetId() string
func (*DeltaUpdateLabelRequest_EnableSelectionChoiceRequest) ProtoMessage()
func (x *DeltaUpdateLabelRequest_EnableSelectionChoiceRequest) ProtoReflect() protoreflect.Message
func (x *DeltaUpdateLabelRequest_EnableSelectionChoiceRequest) Reset()
func (x *DeltaUpdateLabelRequest_EnableSelectionChoiceRequest) String() string
A single kind of update to apply to a Label.
type DeltaUpdateLabelRequest_Request struct {
// The kind of update. Exactly one Field is required.
//
// Types that are assignable to Kind:
//
// *DeltaUpdateLabelRequest_Request_UpdateLabel
// *DeltaUpdateLabelRequest_Request_CreateField
// *DeltaUpdateLabelRequest_Request_UpdateField
// *DeltaUpdateLabelRequest_Request_UpdateFieldType
// *DeltaUpdateLabelRequest_Request_EnableField
// *DeltaUpdateLabelRequest_Request_DisableField
// *DeltaUpdateLabelRequest_Request_DeleteField
// *DeltaUpdateLabelRequest_Request_CreateSelectionChoice
// *DeltaUpdateLabelRequest_Request_UpdateSelectionChoiceProperties
// *DeltaUpdateLabelRequest_Request_EnableSelectionChoice
// *DeltaUpdateLabelRequest_Request_DisableSelectionChoice
// *DeltaUpdateLabelRequest_Request_DeleteSelectionChoice
Kind isDeltaUpdateLabelRequest_Request_Kind `protobuf_oneof:"kind"`
// contains filtered or unexported fields
}
func (*DeltaUpdateLabelRequest_Request) Descriptor() ([]byte, []int)
Deprecated: Use DeltaUpdateLabelRequest_Request.ProtoReflect.Descriptor instead.
func (x *DeltaUpdateLabelRequest_Request) GetCreateField() *DeltaUpdateLabelRequest_CreateFieldRequest
func (x *DeltaUpdateLabelRequest_Request) GetCreateSelectionChoice() *DeltaUpdateLabelRequest_CreateSelectionChoiceRequest
func (x *DeltaUpdateLabelRequest_Request) GetDeleteField() *DeltaUpdateLabelRequest_DeleteFieldRequest
func (x *DeltaUpdateLabelRequest_Request) GetDeleteSelectionChoice() *DeltaUpdateLabelRequest_DeleteSelectionChoiceRequest
func (x *DeltaUpdateLabelRequest_Request) GetDisableField() *DeltaUpdateLabelRequest_DisableFieldRequest
func (x *DeltaUpdateLabelRequest_Request) GetDisableSelectionChoice() *DeltaUpdateLabelRequest_DisableSelectionChoiceRequest
func (x *DeltaUpdateLabelRequest_Request) GetEnableField() *DeltaUpdateLabelRequest_EnableFieldRequest
func (x *DeltaUpdateLabelRequest_Request) GetEnableSelectionChoice() *DeltaUpdateLabelRequest_EnableSelectionChoiceRequest
func (m *DeltaUpdateLabelRequest_Request) GetKind() isDeltaUpdateLabelRequest_Request_Kind
func (x *DeltaUpdateLabelRequest_Request) GetUpdateField() *DeltaUpdateLabelRequest_UpdateFieldPropertiesRequest
func (x *DeltaUpdateLabelRequest_Request) GetUpdateFieldType() *DeltaUpdateLabelRequest_UpdateFieldTypeRequest
func (x *DeltaUpdateLabelRequest_Request) GetUpdateLabel() *DeltaUpdateLabelRequest_UpdateLabelPropertiesRequest
func (x *DeltaUpdateLabelRequest_Request) GetUpdateSelectionChoiceProperties() *DeltaUpdateLabelRequest_UpdateSelectionChoicePropertiesRequest
func (*DeltaUpdateLabelRequest_Request) ProtoMessage()
func (x *DeltaUpdateLabelRequest_Request) ProtoReflect() protoreflect.Message
func (x *DeltaUpdateLabelRequest_Request) Reset()
func (x *DeltaUpdateLabelRequest_Request) String() string
type DeltaUpdateLabelRequest_Request_CreateField struct {
// Creates a new Field.
CreateField *DeltaUpdateLabelRequest_CreateFieldRequest `protobuf:"bytes,2,opt,name=create_field,json=createField,proto3,oneof"`
}
type DeltaUpdateLabelRequest_Request_CreateSelectionChoice struct {
// Creates Choice within a Selection field.
CreateSelectionChoice *DeltaUpdateLabelRequest_CreateSelectionChoiceRequest `protobuf:"bytes,8,opt,name=create_selection_choice,json=createSelectionChoice,proto3,oneof"`
}
type DeltaUpdateLabelRequest_Request_DeleteField struct {
// Deletes a Field from the label.
DeleteField *DeltaUpdateLabelRequest_DeleteFieldRequest `protobuf:"bytes,7,opt,name=delete_field,json=deleteField,proto3,oneof"`
}
type DeltaUpdateLabelRequest_Request_DeleteSelectionChoice struct {
// Delete a Choice within a Selection Field.
DeleteSelectionChoice *DeltaUpdateLabelRequest_DeleteSelectionChoiceRequest `protobuf:"bytes,12,opt,name=delete_selection_choice,json=deleteSelectionChoice,proto3,oneof"`
}
type DeltaUpdateLabelRequest_Request_DisableField struct {
// Disables the Field.
DisableField *DeltaUpdateLabelRequest_DisableFieldRequest `protobuf:"bytes,6,opt,name=disable_field,json=disableField,proto3,oneof"`
}
type DeltaUpdateLabelRequest_Request_DisableSelectionChoice struct {
// Disable a Choice within a Selection Field.
DisableSelectionChoice *DeltaUpdateLabelRequest_DisableSelectionChoiceRequest `protobuf:"bytes,11,opt,name=disable_selection_choice,json=disableSelectionChoice,proto3,oneof"`
}
type DeltaUpdateLabelRequest_Request_EnableField struct {
// Enables the Field.
EnableField *DeltaUpdateLabelRequest_EnableFieldRequest `protobuf:"bytes,5,opt,name=enable_field,json=enableField,proto3,oneof"`
}
type DeltaUpdateLabelRequest_Request_EnableSelectionChoice struct {
// Enable a Choice within a Selection Field.
EnableSelectionChoice *DeltaUpdateLabelRequest_EnableSelectionChoiceRequest `protobuf:"bytes,10,opt,name=enable_selection_choice,json=enableSelectionChoice,proto3,oneof"`
}
type DeltaUpdateLabelRequest_Request_UpdateField struct {
// Updates basic properties of a Field.
UpdateField *DeltaUpdateLabelRequest_UpdateFieldPropertiesRequest `protobuf:"bytes,3,opt,name=update_field,json=updateField,proto3,oneof"`
}
type DeltaUpdateLabelRequest_Request_UpdateFieldType struct {
// Update Field type and/or type options.
UpdateFieldType *DeltaUpdateLabelRequest_UpdateFieldTypeRequest `protobuf:"bytes,4,opt,name=update_field_type,json=updateFieldType,proto3,oneof"`
}
type DeltaUpdateLabelRequest_Request_UpdateLabel struct {
// Updates the Label properties.
UpdateLabel *DeltaUpdateLabelRequest_UpdateLabelPropertiesRequest `protobuf:"bytes,1,opt,name=update_label,json=updateLabel,proto3,oneof"`
}
type DeltaUpdateLabelRequest_Request_UpdateSelectionChoiceProperties struct {
// Update a Choice properties within a Selection Field.
UpdateSelectionChoiceProperties *DeltaUpdateLabelRequest_UpdateSelectionChoicePropertiesRequest `protobuf:"bytes,9,opt,name=update_selection_choice_properties,json=updateSelectionChoiceProperties,proto3,oneof"`
}
Request to update Field properties.
type DeltaUpdateLabelRequest_UpdateFieldPropertiesRequest struct {
// The fields that should be updated. At least one field must be specified.
// The root `properties` is implied and should not be specified. A single
// `*` can be used as short-hand for updating every field.
UpdateMask *fieldmaskpb.FieldMask `protobuf:"bytes,1,opt,name=update_mask,json=updateMask,proto3" json:"update_mask,omitempty"`
// Required. The Field to update.
Id string `protobuf:"bytes,2,opt,name=id,proto3" json:"id,omitempty"`
// Required. Basic Field properties.
Properties *Field_Properties `protobuf:"bytes,3,opt,name=properties,proto3" json:"properties,omitempty"`
// contains filtered or unexported fields
}
func (*DeltaUpdateLabelRequest_UpdateFieldPropertiesRequest) Descriptor() ([]byte, []int)
Deprecated: Use DeltaUpdateLabelRequest_UpdateFieldPropertiesRequest.ProtoReflect.Descriptor instead.
func (x *DeltaUpdateLabelRequest_UpdateFieldPropertiesRequest) GetId() string
func (x *DeltaUpdateLabelRequest_UpdateFieldPropertiesRequest) GetProperties() *Field_Properties
func (x *DeltaUpdateLabelRequest_UpdateFieldPropertiesRequest) GetUpdateMask() *fieldmaskpb.FieldMask
func (*DeltaUpdateLabelRequest_UpdateFieldPropertiesRequest) ProtoMessage()
func (x *DeltaUpdateLabelRequest_UpdateFieldPropertiesRequest) ProtoReflect() protoreflect.Message
func (x *DeltaUpdateLabelRequest_UpdateFieldPropertiesRequest) Reset()
func (x *DeltaUpdateLabelRequest_UpdateFieldPropertiesRequest) String() string
Request to change the type of a Field.
type DeltaUpdateLabelRequest_UpdateFieldTypeRequest struct {
// Types that are assignable to TypeOptions:
//
// *DeltaUpdateLabelRequest_UpdateFieldTypeRequest_TextOptions
// *DeltaUpdateLabelRequest_UpdateFieldTypeRequest_IntegerOptions
// *DeltaUpdateLabelRequest_UpdateFieldTypeRequest_DateOptions
// *DeltaUpdateLabelRequest_UpdateFieldTypeRequest_SelectionOptions
// *DeltaUpdateLabelRequest_UpdateFieldTypeRequest_UserOptions
TypeOptions isDeltaUpdateLabelRequest_UpdateFieldTypeRequest_TypeOptions `protobuf_oneof:"type_options"`
// The fields that should be updated. At least one field must be specified.
// The root of `type_options` is implied and should not be specified. A
// single `*` can be used as short-hand for updating every field.
UpdateMask *fieldmaskpb.FieldMask `protobuf:"bytes,1,opt,name=update_mask,json=updateMask,proto3" json:"update_mask,omitempty"`
// Required. The Field to update.
Id string `protobuf:"bytes,2,opt,name=id,proto3" json:"id,omitempty"`
// contains filtered or unexported fields
}
func (*DeltaUpdateLabelRequest_UpdateFieldTypeRequest) Descriptor() ([]byte, []int)
Deprecated: Use DeltaUpdateLabelRequest_UpdateFieldTypeRequest.ProtoReflect.Descriptor instead.
func (x *DeltaUpdateLabelRequest_UpdateFieldTypeRequest) GetDateOptions() *Field_DateOptions
func (x *DeltaUpdateLabelRequest_UpdateFieldTypeRequest) GetId() string
func (x *DeltaUpdateLabelRequest_UpdateFieldTypeRequest) GetIntegerOptions() *Field_IntegerOptions
func (x *DeltaUpdateLabelRequest_UpdateFieldTypeRequest) GetSelectionOptions() *Field_SelectionOptions
func (x *DeltaUpdateLabelRequest_UpdateFieldTypeRequest) GetTextOptions() *Field_TextOptions
func (m *DeltaUpdateLabelRequest_UpdateFieldTypeRequest) GetTypeOptions() isDeltaUpdateLabelRequest_UpdateFieldTypeRequest_TypeOptions
func (x *DeltaUpdateLabelRequest_UpdateFieldTypeRequest) GetUpdateMask() *fieldmaskpb.FieldMask
func (x *DeltaUpdateLabelRequest_UpdateFieldTypeRequest) GetUserOptions() *Field_UserOptions
func (*DeltaUpdateLabelRequest_UpdateFieldTypeRequest) ProtoMessage()
func (x *DeltaUpdateLabelRequest_UpdateFieldTypeRequest) ProtoReflect() protoreflect.Message
func (x *DeltaUpdateLabelRequest_UpdateFieldTypeRequest) Reset()
func (x *DeltaUpdateLabelRequest_UpdateFieldTypeRequest) String() string
type DeltaUpdateLabelRequest_UpdateFieldTypeRequest_DateOptions struct {
// Update field to Date.
DateOptions *Field_DateOptions `protobuf:"bytes,6,opt,name=date_options,json=dateOptions,proto3,oneof"`
}
type DeltaUpdateLabelRequest_UpdateFieldTypeRequest_IntegerOptions struct {
// Update field to Integer.
IntegerOptions *Field_IntegerOptions `protobuf:"bytes,5,opt,name=integer_options,json=integerOptions,proto3,oneof"`
}
type DeltaUpdateLabelRequest_UpdateFieldTypeRequest_SelectionOptions struct {
// Update field to Selection.
SelectionOptions *Field_SelectionOptions `protobuf:"bytes,7,opt,name=selection_options,json=selectionOptions,proto3,oneof"`
}
type DeltaUpdateLabelRequest_UpdateFieldTypeRequest_TextOptions struct {
// Update field to Text.
TextOptions *Field_TextOptions `protobuf:"bytes,3,opt,name=text_options,json=textOptions,proto3,oneof"`
}
type DeltaUpdateLabelRequest_UpdateFieldTypeRequest_UserOptions struct {
// Update field to User.
UserOptions *Field_UserOptions `protobuf:"bytes,8,opt,name=user_options,json=userOptions,proto3,oneof"`
}
Updates basic properties of a Label.
type DeltaUpdateLabelRequest_UpdateLabelPropertiesRequest struct {
// The fields that should be updated. At least one field must be specified.
// The root `label_properties` is implied and should not be specified. A
// single `*` can be used as short-hand for updating every field.
UpdateMask *fieldmaskpb.FieldMask `protobuf:"bytes,1,opt,name=update_mask,json=updateMask,proto3" json:"update_mask,omitempty"`
// Required. Label properties to update.
Properties *Label_Properties `protobuf:"bytes,2,opt,name=properties,proto3" json:"properties,omitempty"`
// contains filtered or unexported fields
}
func (*DeltaUpdateLabelRequest_UpdateLabelPropertiesRequest) Descriptor() ([]byte, []int)
Deprecated: Use DeltaUpdateLabelRequest_UpdateLabelPropertiesRequest.ProtoReflect.Descriptor instead.
func (x *DeltaUpdateLabelRequest_UpdateLabelPropertiesRequest) GetProperties() *Label_Properties
func (x *DeltaUpdateLabelRequest_UpdateLabelPropertiesRequest) GetUpdateMask() *fieldmaskpb.FieldMask
func (*DeltaUpdateLabelRequest_UpdateLabelPropertiesRequest) ProtoMessage()
func (x *DeltaUpdateLabelRequest_UpdateLabelPropertiesRequest) ProtoReflect() protoreflect.Message
func (x *DeltaUpdateLabelRequest_UpdateLabelPropertiesRequest) Reset()
func (x *DeltaUpdateLabelRequest_UpdateLabelPropertiesRequest) String() string
Request to update a Choice properties.
type DeltaUpdateLabelRequest_UpdateSelectionChoicePropertiesRequest struct {
// The fields that should be updated. At least one field must be specified.
// The root `properties` is implied and should not be specified. A single
// `*` can be used as short-hand for updating every field.
UpdateMask *fieldmaskpb.FieldMask `protobuf:"bytes,1,opt,name=update_mask,json=updateMask,proto3" json:"update_mask,omitempty"`
// Required. The Selection Field to update.
FieldId string `protobuf:"bytes,2,opt,name=field_id,json=fieldId,proto3" json:"field_id,omitempty"`
// Required. The Choice to update.
Id string `protobuf:"bytes,3,opt,name=id,proto3" json:"id,omitempty"`
// Required. The Choice properties to update.
Properties *Field_SelectionOptions_Choice_Properties `protobuf:"bytes,4,opt,name=properties,proto3" json:"properties,omitempty"`
// contains filtered or unexported fields
}
func (*DeltaUpdateLabelRequest_UpdateSelectionChoicePropertiesRequest) Descriptor() ([]byte, []int)
Deprecated: Use DeltaUpdateLabelRequest_UpdateSelectionChoicePropertiesRequest.ProtoReflect.Descriptor instead.
func (x *DeltaUpdateLabelRequest_UpdateSelectionChoicePropertiesRequest) GetFieldId() string
func (x *DeltaUpdateLabelRequest_UpdateSelectionChoicePropertiesRequest) GetId() string
func (x *DeltaUpdateLabelRequest_UpdateSelectionChoicePropertiesRequest) GetProperties() *Field_SelectionOptions_Choice_Properties
func (x *DeltaUpdateLabelRequest_UpdateSelectionChoicePropertiesRequest) GetUpdateMask() *fieldmaskpb.FieldMask
func (*DeltaUpdateLabelRequest_UpdateSelectionChoicePropertiesRequest) ProtoMessage()
func (x *DeltaUpdateLabelRequest_UpdateSelectionChoicePropertiesRequest) ProtoReflect() protoreflect.Message
func (x *DeltaUpdateLabelRequest_UpdateSelectionChoicePropertiesRequest) Reset()
func (x *DeltaUpdateLabelRequest_UpdateSelectionChoicePropertiesRequest) String() string
Response for Label update.
type DeltaUpdateLabelResponse struct {
// The reply of the updates. This maps 1:1 with the updates, although
// responses to some requests may be empty.
Responses []*DeltaUpdateLabelResponse_Response `protobuf:"bytes,1,rep,name=responses,proto3" json:"responses,omitempty"`
// The label after updates were applied. This is only set if
// [BatchUpdateLabelResponse2.include_label_in_response] is `true` and there
// were no errors.
UpdatedLabel *Label `protobuf:"bytes,6,opt,name=updated_label,json=updatedLabel,proto3" json:"updated_label,omitempty"`
// contains filtered or unexported fields
}
func (*DeltaUpdateLabelResponse) Descriptor() ([]byte, []int)
Deprecated: Use DeltaUpdateLabelResponse.ProtoReflect.Descriptor instead.
func (x *DeltaUpdateLabelResponse) GetResponses() []*DeltaUpdateLabelResponse_Response
func (x *DeltaUpdateLabelResponse) GetUpdatedLabel() *Label
func (*DeltaUpdateLabelResponse) ProtoMessage()
func (x *DeltaUpdateLabelResponse) ProtoReflect() protoreflect.Message
func (x *DeltaUpdateLabelResponse) Reset()
func (x *DeltaUpdateLabelResponse) String() string
Response following Field create.
type DeltaUpdateLabelResponse_CreateFieldResponse struct {
// The field of the created field. When left blank in a create request,
// a key will be autogenerated and can be identified here.
Id string `protobuf:"bytes,1,opt,name=id,proto3" json:"id,omitempty"`
// The priority of the created field. The priority may change from what
// was specified to assure contiguous priorities between fields (1-n).
Priority int32 `protobuf:"varint,2,opt,name=priority,proto3" json:"priority,omitempty"`
// contains filtered or unexported fields
}
func (*DeltaUpdateLabelResponse_CreateFieldResponse) Descriptor() ([]byte, []int)
Deprecated: Use DeltaUpdateLabelResponse_CreateFieldResponse.ProtoReflect.Descriptor instead.
func (x *DeltaUpdateLabelResponse_CreateFieldResponse) GetId() string
func (x *DeltaUpdateLabelResponse_CreateFieldResponse) GetPriority() int32
func (*DeltaUpdateLabelResponse_CreateFieldResponse) ProtoMessage()
func (x *DeltaUpdateLabelResponse_CreateFieldResponse) ProtoReflect() protoreflect.Message
func (x *DeltaUpdateLabelResponse_CreateFieldResponse) Reset()
func (x *DeltaUpdateLabelResponse_CreateFieldResponse) String() string
Response following Selection Choice create.
type DeltaUpdateLabelResponse_CreateSelectionChoiceResponse struct {
// The server-generated id of the field.
FieldId string `protobuf:"bytes,1,opt,name=field_id,json=fieldId,proto3" json:"field_id,omitempty"`
// The server-generated ID of the created choice within the Field
Id string `protobuf:"bytes,2,opt,name=id,proto3" json:"id,omitempty"`
// contains filtered or unexported fields
}
func (*DeltaUpdateLabelResponse_CreateSelectionChoiceResponse) Descriptor() ([]byte, []int)
Deprecated: Use DeltaUpdateLabelResponse_CreateSelectionChoiceResponse.ProtoReflect.Descriptor instead.
func (x *DeltaUpdateLabelResponse_CreateSelectionChoiceResponse) GetFieldId() string
func (x *DeltaUpdateLabelResponse_CreateSelectionChoiceResponse) GetId() string
func (*DeltaUpdateLabelResponse_CreateSelectionChoiceResponse) ProtoMessage()
func (x *DeltaUpdateLabelResponse_CreateSelectionChoiceResponse) ProtoReflect() protoreflect.Message
func (x *DeltaUpdateLabelResponse_CreateSelectionChoiceResponse) Reset()
func (x *DeltaUpdateLabelResponse_CreateSelectionChoiceResponse) String() string
Response following Field delete.
type DeltaUpdateLabelResponse_DeleteFieldResponse struct {
// contains filtered or unexported fields
}
func (*DeltaUpdateLabelResponse_DeleteFieldResponse) Descriptor() ([]byte, []int)
Deprecated: Use DeltaUpdateLabelResponse_DeleteFieldResponse.ProtoReflect.Descriptor instead.
func (*DeltaUpdateLabelResponse_DeleteFieldResponse) ProtoMessage()
func (x *DeltaUpdateLabelResponse_DeleteFieldResponse) ProtoReflect() protoreflect.Message
func (x *DeltaUpdateLabelResponse_DeleteFieldResponse) Reset()
func (x *DeltaUpdateLabelResponse_DeleteFieldResponse) String() string
Response following Choice delete.
type DeltaUpdateLabelResponse_DeleteSelectionChoiceResponse struct {
// contains filtered or unexported fields
}
func (*DeltaUpdateLabelResponse_DeleteSelectionChoiceResponse) Descriptor() ([]byte, []int)
Deprecated: Use DeltaUpdateLabelResponse_DeleteSelectionChoiceResponse.ProtoReflect.Descriptor instead.
func (*DeltaUpdateLabelResponse_DeleteSelectionChoiceResponse) ProtoMessage()
func (x *DeltaUpdateLabelResponse_DeleteSelectionChoiceResponse) ProtoReflect() protoreflect.Message
func (x *DeltaUpdateLabelResponse_DeleteSelectionChoiceResponse) Reset()
func (x *DeltaUpdateLabelResponse_DeleteSelectionChoiceResponse) String() string
Response following Field disable.
type DeltaUpdateLabelResponse_DisableFieldResponse struct {
// contains filtered or unexported fields
}
func (*DeltaUpdateLabelResponse_DisableFieldResponse) Descriptor() ([]byte, []int)
Deprecated: Use DeltaUpdateLabelResponse_DisableFieldResponse.ProtoReflect.Descriptor instead.
func (*DeltaUpdateLabelResponse_DisableFieldResponse) ProtoMessage()
func (x *DeltaUpdateLabelResponse_DisableFieldResponse) ProtoReflect() protoreflect.Message
func (x *DeltaUpdateLabelResponse_DisableFieldResponse) Reset()
func (x *DeltaUpdateLabelResponse_DisableFieldResponse) String() string
Response following Choice disable.
type DeltaUpdateLabelResponse_DisableSelectionChoiceResponse struct {
// contains filtered or unexported fields
}
func (*DeltaUpdateLabelResponse_DisableSelectionChoiceResponse) Descriptor() ([]byte, []int)
Deprecated: Use DeltaUpdateLabelResponse_DisableSelectionChoiceResponse.ProtoReflect.Descriptor instead.
func (*DeltaUpdateLabelResponse_DisableSelectionChoiceResponse) ProtoMessage()
func (x *DeltaUpdateLabelResponse_DisableSelectionChoiceResponse) ProtoReflect() protoreflect.Message
func (x *DeltaUpdateLabelResponse_DisableSelectionChoiceResponse) Reset()
func (x *DeltaUpdateLabelResponse_DisableSelectionChoiceResponse) String() string
Response following Field enable.
type DeltaUpdateLabelResponse_EnableFieldResponse struct {
// contains filtered or unexported fields
}
func (*DeltaUpdateLabelResponse_EnableFieldResponse) Descriptor() ([]byte, []int)
Deprecated: Use DeltaUpdateLabelResponse_EnableFieldResponse.ProtoReflect.Descriptor instead.
func (*DeltaUpdateLabelResponse_EnableFieldResponse) ProtoMessage()
func (x *DeltaUpdateLabelResponse_EnableFieldResponse) ProtoReflect() protoreflect.Message
func (x *DeltaUpdateLabelResponse_EnableFieldResponse) Reset()
func (x *DeltaUpdateLabelResponse_EnableFieldResponse) String() string
Response following Choice enable.
type DeltaUpdateLabelResponse_EnableSelectionChoiceResponse struct {
// contains filtered or unexported fields
}
func (*DeltaUpdateLabelResponse_EnableSelectionChoiceResponse) Descriptor() ([]byte, []int)
Deprecated: Use DeltaUpdateLabelResponse_EnableSelectionChoiceResponse.ProtoReflect.Descriptor instead.
func (*DeltaUpdateLabelResponse_EnableSelectionChoiceResponse) ProtoMessage()
func (x *DeltaUpdateLabelResponse_EnableSelectionChoiceResponse) ProtoReflect() protoreflect.Message
func (x *DeltaUpdateLabelResponse_EnableSelectionChoiceResponse) Reset()
func (x *DeltaUpdateLabelResponse_EnableSelectionChoiceResponse) String() string
A single response from an update.
type DeltaUpdateLabelResponse_Response struct {
// The response for the corresponding request.
//
// Types that are assignable to Response:
//
// *DeltaUpdateLabelResponse_Response_UpdateLabel
// *DeltaUpdateLabelResponse_Response_CreateField
// *DeltaUpdateLabelResponse_Response_UpdateField
// *DeltaUpdateLabelResponse_Response_UpdateFieldType
// *DeltaUpdateLabelResponse_Response_EnableField
// *DeltaUpdateLabelResponse_Response_DisableField
// *DeltaUpdateLabelResponse_Response_DeleteField
// *DeltaUpdateLabelResponse_Response_CreateSelectionChoice
// *DeltaUpdateLabelResponse_Response_UpdateSelectionChoiceProperties
// *DeltaUpdateLabelResponse_Response_EnableSelectionChoice
// *DeltaUpdateLabelResponse_Response_DisableSelectionChoice
// *DeltaUpdateLabelResponse_Response_DeleteSelectionChoice
Response isDeltaUpdateLabelResponse_Response_Response `protobuf_oneof:"response"`
// contains filtered or unexported fields
}
func (*DeltaUpdateLabelResponse_Response) Descriptor() ([]byte, []int)
Deprecated: Use DeltaUpdateLabelResponse_Response.ProtoReflect.Descriptor instead.
func (x *DeltaUpdateLabelResponse_Response) GetCreateField() *DeltaUpdateLabelResponse_CreateFieldResponse
func (x *DeltaUpdateLabelResponse_Response) GetCreateSelectionChoice() *DeltaUpdateLabelResponse_CreateSelectionChoiceResponse
func (x *DeltaUpdateLabelResponse_Response) GetDeleteField() *DeltaUpdateLabelResponse_DeleteFieldResponse
func (x *DeltaUpdateLabelResponse_Response) GetDeleteSelectionChoice() *DeltaUpdateLabelResponse_DeleteSelectionChoiceResponse
func (x *DeltaUpdateLabelResponse_Response) GetDisableField() *DeltaUpdateLabelResponse_DisableFieldResponse
func (x *DeltaUpdateLabelResponse_Response) GetDisableSelectionChoice() *DeltaUpdateLabelResponse_DisableSelectionChoiceResponse
func (x *DeltaUpdateLabelResponse_Response) GetEnableField() *DeltaUpdateLabelResponse_EnableFieldResponse
func (x *DeltaUpdateLabelResponse_Response) GetEnableSelectionChoice() *DeltaUpdateLabelResponse_EnableSelectionChoiceResponse
func (m *DeltaUpdateLabelResponse_Response) GetResponse() isDeltaUpdateLabelResponse_Response_Response
func (x *DeltaUpdateLabelResponse_Response) GetUpdateField() *DeltaUpdateLabelResponse_UpdateFieldPropertiesResponse
func (x *DeltaUpdateLabelResponse_Response) GetUpdateFieldType() *DeltaUpdateLabelResponse_UpdateFieldTypeResponse
func (x *DeltaUpdateLabelResponse_Response) GetUpdateLabel() *DeltaUpdateLabelResponse_UpdateLabelPropertiesResponse
func (x *DeltaUpdateLabelResponse_Response) GetUpdateSelectionChoiceProperties() *DeltaUpdateLabelResponse_UpdateSelectionChoicePropertiesResponse
func (*DeltaUpdateLabelResponse_Response) ProtoMessage()
func (x *DeltaUpdateLabelResponse_Response) ProtoReflect() protoreflect.Message
func (x *DeltaUpdateLabelResponse_Response) Reset()
func (x *DeltaUpdateLabelResponse_Response) String() string
type DeltaUpdateLabelResponse_Response_CreateField struct {
// Creates a new Field.
CreateField *DeltaUpdateLabelResponse_CreateFieldResponse `protobuf:"bytes,2,opt,name=create_field,json=createField,proto3,oneof"`
}
type DeltaUpdateLabelResponse_Response_CreateSelectionChoice struct {
// Creates a new selection list option to add to a Selection Field.
CreateSelectionChoice *DeltaUpdateLabelResponse_CreateSelectionChoiceResponse `protobuf:"bytes,8,opt,name=create_selection_choice,json=createSelectionChoice,proto3,oneof"`
}
type DeltaUpdateLabelResponse_Response_DeleteField struct {
// Deletes a Field from the label.
DeleteField *DeltaUpdateLabelResponse_DeleteFieldResponse `protobuf:"bytes,7,opt,name=delete_field,json=deleteField,proto3,oneof"`
}
type DeltaUpdateLabelResponse_Response_DeleteSelectionChoice struct {
// Deletes a Choice from a Selection Field.
DeleteSelectionChoice *DeltaUpdateLabelResponse_DeleteSelectionChoiceResponse `protobuf:"bytes,12,opt,name=delete_selection_choice,json=deleteSelectionChoice,proto3,oneof"`
}
type DeltaUpdateLabelResponse_Response_DisableField struct {
// Disables Field.
DisableField *DeltaUpdateLabelResponse_DisableFieldResponse `protobuf:"bytes,6,opt,name=disable_field,json=disableField,proto3,oneof"`
}
type DeltaUpdateLabelResponse_Response_DisableSelectionChoice struct {
// Disables a Choice within a Selection Field.
DisableSelectionChoice *DeltaUpdateLabelResponse_DisableSelectionChoiceResponse `protobuf:"bytes,11,opt,name=disable_selection_choice,json=disableSelectionChoice,proto3,oneof"`
}
type DeltaUpdateLabelResponse_Response_EnableField struct {
// Enables Field.
EnableField *DeltaUpdateLabelResponse_EnableFieldResponse `protobuf:"bytes,5,opt,name=enable_field,json=enableField,proto3,oneof"`
}
type DeltaUpdateLabelResponse_Response_EnableSelectionChoice struct {
// Enables a Choice within a Selection Field.
EnableSelectionChoice *DeltaUpdateLabelResponse_EnableSelectionChoiceResponse `protobuf:"bytes,10,opt,name=enable_selection_choice,json=enableSelectionChoice,proto3,oneof"`
}
type DeltaUpdateLabelResponse_Response_UpdateField struct {
// Updates basic properties of a Field.
UpdateField *DeltaUpdateLabelResponse_UpdateFieldPropertiesResponse `protobuf:"bytes,3,opt,name=update_field,json=updateField,proto3,oneof"`
}
type DeltaUpdateLabelResponse_Response_UpdateFieldType struct {
// Update Field type and/or type options.
UpdateFieldType *DeltaUpdateLabelResponse_UpdateFieldTypeResponse `protobuf:"bytes,4,opt,name=update_field_type,json=updateFieldType,proto3,oneof"`
}
type DeltaUpdateLabelResponse_Response_UpdateLabel struct {
// Updated basic properties of a Label.
UpdateLabel *DeltaUpdateLabelResponse_UpdateLabelPropertiesResponse `protobuf:"bytes,1,opt,name=update_label,json=updateLabel,proto3,oneof"`
}
type DeltaUpdateLabelResponse_Response_UpdateSelectionChoiceProperties struct {
// Updates a Choice within a Selection Field.
UpdateSelectionChoiceProperties *DeltaUpdateLabelResponse_UpdateSelectionChoicePropertiesResponse `protobuf:"bytes,9,opt,name=update_selection_choice_properties,json=updateSelectionChoiceProperties,proto3,oneof"`
}
Response following update to Field properties.
type DeltaUpdateLabelResponse_UpdateFieldPropertiesResponse struct {
// The priority of the updated field. The priority may change from what
// was specified to assure contiguous priorities between fields (1-n).
Priority int32 `protobuf:"varint,1,opt,name=priority,proto3" json:"priority,omitempty"`
// contains filtered or unexported fields
}
func (*DeltaUpdateLabelResponse_UpdateFieldPropertiesResponse) Descriptor() ([]byte, []int)
Deprecated: Use DeltaUpdateLabelResponse_UpdateFieldPropertiesResponse.ProtoReflect.Descriptor instead.
func (x *DeltaUpdateLabelResponse_UpdateFieldPropertiesResponse) GetPriority() int32
func (*DeltaUpdateLabelResponse_UpdateFieldPropertiesResponse) ProtoMessage()
func (x *DeltaUpdateLabelResponse_UpdateFieldPropertiesResponse) ProtoReflect() protoreflect.Message
func (x *DeltaUpdateLabelResponse_UpdateFieldPropertiesResponse) Reset()
func (x *DeltaUpdateLabelResponse_UpdateFieldPropertiesResponse) String() string
Response following update to Field type.
type DeltaUpdateLabelResponse_UpdateFieldTypeResponse struct {
// contains filtered or unexported fields
}
func (*DeltaUpdateLabelResponse_UpdateFieldTypeResponse) Descriptor() ([]byte, []int)
Deprecated: Use DeltaUpdateLabelResponse_UpdateFieldTypeResponse.ProtoReflect.Descriptor instead.
func (*DeltaUpdateLabelResponse_UpdateFieldTypeResponse) ProtoMessage()
func (x *DeltaUpdateLabelResponse_UpdateFieldTypeResponse) ProtoReflect() protoreflect.Message
func (x *DeltaUpdateLabelResponse_UpdateFieldTypeResponse) Reset()
func (x *DeltaUpdateLabelResponse_UpdateFieldTypeResponse) String() string
Response following update to Label properties.
type DeltaUpdateLabelResponse_UpdateLabelPropertiesResponse struct {
// contains filtered or unexported fields
}
func (*DeltaUpdateLabelResponse_UpdateLabelPropertiesResponse) Descriptor() ([]byte, []int)
Deprecated: Use DeltaUpdateLabelResponse_UpdateLabelPropertiesResponse.ProtoReflect.Descriptor instead.
func (*DeltaUpdateLabelResponse_UpdateLabelPropertiesResponse) ProtoMessage()
func (x *DeltaUpdateLabelResponse_UpdateLabelPropertiesResponse) ProtoReflect() protoreflect.Message
func (x *DeltaUpdateLabelResponse_UpdateLabelPropertiesResponse) Reset()
func (x *DeltaUpdateLabelResponse_UpdateLabelPropertiesResponse) String() string
Response following update to Selection Choice properties.
type DeltaUpdateLabelResponse_UpdateSelectionChoicePropertiesResponse struct {
// The priority of the updated choice. The priority may change from what
// was specified to assure contiguous priorities between choices (1-n).
Priority int32 `protobuf:"varint,1,opt,name=priority,proto3" json:"priority,omitempty"`
// contains filtered or unexported fields
}
func (*DeltaUpdateLabelResponse_UpdateSelectionChoicePropertiesResponse) Descriptor() ([]byte, []int)
Deprecated: Use DeltaUpdateLabelResponse_UpdateSelectionChoicePropertiesResponse.ProtoReflect.Descriptor instead.
func (x *DeltaUpdateLabelResponse_UpdateSelectionChoicePropertiesResponse) GetPriority() int32
func (*DeltaUpdateLabelResponse_UpdateSelectionChoicePropertiesResponse) ProtoMessage()
func (x *DeltaUpdateLabelResponse_UpdateSelectionChoicePropertiesResponse) ProtoReflect() protoreflect.Message
func (x *DeltaUpdateLabelResponse_UpdateSelectionChoicePropertiesResponse) Reset()
func (x *DeltaUpdateLabelResponse_UpdateSelectionChoicePropertiesResponse) String() string
Request to deprecate a published Label.
type DisableLabelRequest struct {
// The fields that should be updated. At least one field must be specified.
// The root `disabled_policy` is implied and should not be specified. A
// single `*` can be used as short-hand for updating every field.
UpdateMask *fieldmaskpb.FieldMask `protobuf:"bytes,1,opt,name=update_mask,json=updateMask,proto3" json:"update_mask,omitempty"`
// Required. Label resource name.
Name string `protobuf:"bytes,2,opt,name=name,proto3" json:"name,omitempty"`
// Set to `true` in order to use the user's admin credentials. The server
// will verify the user is an admin for the Label before allowing access.
UseAdminAccess bool `protobuf:"varint,3,opt,name=use_admin_access,json=useAdminAccess,proto3" json:"use_admin_access,omitempty"`
// Provides control over how write requests are executed. Defaults to unset,
// which means last write wins.
WriteControl *WriteControl `protobuf:"bytes,4,opt,name=write_control,json=writeControl,proto3" json:"write_control,omitempty"`
// Disabled policy to use.
DisabledPolicy *Lifecycle_DisabledPolicy `protobuf:"bytes,5,opt,name=disabled_policy,json=disabledPolicy,proto3" json:"disabled_policy,omitempty"`
// The BCP-47 language code to use for evaluating localized field labels.
// When not specified, values in the default configured language will be used.
LanguageCode string `protobuf:"bytes,6,opt,name=language_code,json=languageCode,proto3" json:"language_code,omitempty"`
// contains filtered or unexported fields
}
func (*DisableLabelRequest) Descriptor() ([]byte, []int)
Deprecated: Use DisableLabelRequest.ProtoReflect.Descriptor instead.
func (x *DisableLabelRequest) GetDisabledPolicy() *Lifecycle_DisabledPolicy
func (x *DisableLabelRequest) GetLanguageCode() string
func (x *DisableLabelRequest) GetName() string
func (x *DisableLabelRequest) GetUpdateMask() *fieldmaskpb.FieldMask
func (x *DisableLabelRequest) GetUseAdminAccess() bool
func (x *DisableLabelRequest) GetWriteControl() *WriteControl
func (*DisableLabelRequest) ProtoMessage()
func (x *DisableLabelRequest) ProtoReflect() protoreflect.Message
func (x *DisableLabelRequest) Reset()
func (x *DisableLabelRequest) String() string
Request to enable a label.
type EnableLabelRequest struct {
// Required. Label resource name.
Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
// Set to `true` in order to use the user's admin credentials. The server
// will verify the user is an admin for the Label before allowing access.
UseAdminAccess bool `protobuf:"varint,2,opt,name=use_admin_access,json=useAdminAccess,proto3" json:"use_admin_access,omitempty"`
// Provides control over how write requests are executed. Defaults to unset,
// which means last write wins.
WriteControl *WriteControl `protobuf:"bytes,3,opt,name=write_control,json=writeControl,proto3" json:"write_control,omitempty"`
// The BCP-47 language code to use for evaluating localized field labels.
// When not specified, values in the default configured language will be used.
LanguageCode string `protobuf:"bytes,4,opt,name=language_code,json=languageCode,proto3" json:"language_code,omitempty"`
// contains filtered or unexported fields
}
func (*EnableLabelRequest) Descriptor() ([]byte, []int)
Deprecated: Use EnableLabelRequest.ProtoReflect.Descriptor instead.
func (x *EnableLabelRequest) GetLanguageCode() string
func (x *EnableLabelRequest) GetName() string
func (x *EnableLabelRequest) GetUseAdminAccess() bool
func (x *EnableLabelRequest) GetWriteControl() *WriteControl
func (*EnableLabelRequest) ProtoMessage()
func (x *EnableLabelRequest) ProtoReflect() protoreflect.Message
func (x *EnableLabelRequest) Reset()
func (x *EnableLabelRequest) String() string
Exception detail.
type ExceptionDetail struct {
// The type of exception that occurred. Required.
ErrorType ExceptionType `protobuf:"varint,1,opt,name=error_type,json=errorType,proto3,enum=google.apps.drive.labels.v2beta.ExceptionType" json:"error_type,omitempty"`
// contains filtered or unexported fields
}
func (*ExceptionDetail) Descriptor() ([]byte, []int)
Deprecated: Use ExceptionDetail.ProtoReflect.Descriptor instead.
func (x *ExceptionDetail) GetErrorType() ExceptionType
func (*ExceptionDetail) ProtoMessage()
func (x *ExceptionDetail) ProtoReflect() protoreflect.Message
func (x *ExceptionDetail) Reset()
func (x *ExceptionDetail) String() string
Every ExceptionType maps to one and only one Exception class. This allows internal clients to identify the exact server exception that caused the error for debugging and logging purposes. Add new ExceptionTypes to EXCEPTION_TYPE_TO_ERROR_CODE_MAP in j/c/g/apps/boq/metadata/model/service/exceptions/CategoryExceptionHelper
type ExceptionType int32
const (
// Unknown ExceptionType.
ExceptionType_EXCEPTION_TYPE_UNSPECIFIED ExceptionType = 0
// The required field is missing.
ExceptionType_FIELD_REQUIRED ExceptionType = 1
// Unable to create a metamodel with the given ID because it already exists.
ExceptionType_METAMODEL_ALREADY_EXISTS ExceptionType = 2
// Metamodel was not found
ExceptionType_METAMODEL_NOT_FOUND ExceptionType = 3
// Metamodel state transition isn't allowed.
ExceptionType_ILLEGAL_METAMODEL_STATE_TRANSITION ExceptionType = 4
// Metamodel deprecation policy is invalid.
ExceptionType_INVALID_METAMODEL_DEPRECATION_POLICY ExceptionType = 5
// Cannot delete a metamodel due to the pending deprecation policy.
ExceptionType_METAMODEL_DELETION_DENIED_UNTIL ExceptionType = 6
// A Field value is invalid.
ExceptionType_INVALID_FIELD ExceptionType = 7
// Precondition failed when updating a metamodel
ExceptionType_METAMODEL_PRECONDITION_FAILED ExceptionType = 8
// Multiple fields had the same key.
ExceptionType_DUPLICATE_FIELD_KEY ExceptionType = 9
// Removing a field from a Metamodel (e.g. a published Metamodel) is not
// permitted.
ExceptionType_ILLEGAL_FIELD_REMOVAL ExceptionType = 10
// Cannot specify field options for a different field type.
ExceptionType_ILLEGAL_FIELD_OPTIONS_FOR_FIELD ExceptionType = 11
// Some changes are not supported
ExceptionType_UNSUPPORTED_CHANGE_TO_PUBLISHED_METAMODEL ExceptionType = 12
// Cannot change the metamodel state in an update
ExceptionType_ILLEGAL_METAMODEL_STATE_TRANSITION_IN_UPDATE ExceptionType = 13
// The page token is expired
ExceptionType_PAGE_TOKEN_EXPIRED ExceptionType = 14
// The user is not authorized to make the request.
ExceptionType_NOT_AUTHORIZED ExceptionType = 15
// Illegal field state transition
ExceptionType_ILLEGAL_FIELD_STATE_TRANSITION ExceptionType = 16
// Illegal choice set option state transition
ExceptionType_ILLEGAL_CHOICE_SET_OPTION_STATE_TRANSITION ExceptionType = 17
// Invalid choice set options
ExceptionType_INVALID_CHOICE_SET_OPTIONS ExceptionType = 18
// Invalid field key
ExceptionType_INVALID_FIELD_KEY ExceptionType = 19
// A specified property on a field is outside the allowed range.
ExceptionType_INVALID_FIELD_PROPERTY_RANGE ExceptionType = 20
// A localized string wasn't valid. This may be because the locale is invalid,
// its missing a default value, or the translation is empty for a set locale.
ExceptionType_INVALID_LOCALIZED_STRING ExceptionType = 21
// cannot change a property on a published field
ExceptionType_ILLEGAL_CHANGE_TO_PUBLISHED_FIELD ExceptionType = 22
// A field update is not inclusive of the previous value
ExceptionType_INVALID_FIELD_UPDATE_NOT_INCLUSIVE ExceptionType = 23
// A field update is not inclusive of the previous value
ExceptionType_INVALID_CHOICE_SET_STATE ExceptionType = 24
// An unknown error occurred
ExceptionType_INTERNAL_SERVER_ERROR ExceptionType = 500
)
func (ExceptionType) Descriptor() protoreflect.EnumDescriptor
func (x ExceptionType) Enum() *ExceptionType
func (ExceptionType) EnumDescriptor() ([]byte, []int)
Deprecated: Use ExceptionType.Descriptor instead.
func (x ExceptionType) Number() protoreflect.EnumNumber
func (x ExceptionType) String() string
func (ExceptionType) Type() protoreflect.EnumType
Defines a field that has a display name, data type, and other configuration options. This field defines the kind of metadata that may be set on a Drive item.
type Field struct {
// The data type and options of this field.
// Once published, the data type cannot be changed.
//
// Types that are assignable to Type:
//
// *Field_TextOptions_
// *Field_IntegerOptions_
// *Field_DateOptions_
// *Field_SelectionOptions_
// *Field_UserOptions_
Type isField_Type `protobuf_oneof:"type"`
// Output only. The key of a field, unique within a label or library.
//
// This value is autogenerated. Matches the regex: `([a-zA-Z0-9])+`
Id string `protobuf:"bytes,1,opt,name=id,proto3" json:"id,omitempty"`
// Output only. The key to use when constructing Drive search queries to find
// files based on values defined for this field on files.
// For example, "`{query_key}` > 2001-01-01".
QueryKey string `protobuf:"bytes,2,opt,name=query_key,json=queryKey,proto3" json:"query_key,omitempty"`
// The basic properties of the field.
Properties *Field_Properties `protobuf:"bytes,3,opt,name=properties,proto3" json:"properties,omitempty"`
// Output only. The lifecycle of this field.
Lifecycle *Lifecycle `protobuf:"bytes,4,opt,name=lifecycle,proto3" json:"lifecycle,omitempty"`
// Output only. UI display hints for rendering a field.
DisplayHints *Field_DisplayHints `protobuf:"bytes,5,opt,name=display_hints,json=displayHints,proto3" json:"display_hints,omitempty"`
// Output only. The capabilities this user has when editing this field.
SchemaCapabilities *Field_SchemaCapabilities `protobuf:"bytes,6,opt,name=schema_capabilities,json=schemaCapabilities,proto3" json:"schema_capabilities,omitempty"`
// Output only. The capabilities this user has on this field and its value
// when the label is applied on Drive items.
AppliedCapabilities *Field_AppliedCapabilities `protobuf:"bytes,7,opt,name=applied_capabilities,json=appliedCapabilities,proto3" json:"applied_capabilities,omitempty"`
// Output only. The user who created this field.
Creator *UserInfo `protobuf:"bytes,8,opt,name=creator,proto3" json:"creator,omitempty"`
// Output only. The time this field was created.
CreateTime *timestamppb.Timestamp `protobuf:"bytes,9,opt,name=create_time,json=createTime,proto3" json:"create_time,omitempty"`
// Output only. The user who modified this field.
Updater *UserInfo `protobuf:"bytes,10,opt,name=updater,proto3" json:"updater,omitempty"`
// Output only. The time this field was updated.
UpdateTime *timestamppb.Timestamp `protobuf:"bytes,11,opt,name=update_time,json=updateTime,proto3" json:"update_time,omitempty"`
// Output only. The user who published this field. This value has no meaning
// when the field is not published.
Publisher *UserInfo `protobuf:"bytes,12,opt,name=publisher,proto3" json:"publisher,omitempty"`
// Output only. The user who disabled this field. This value has no meaning
// when the field is not disabled.
Disabler *UserInfo `protobuf:"bytes,13,opt,name=disabler,proto3" json:"disabler,omitempty"`
// Output only. The time this field was disabled. This value has no meaning
// when the field is not disabled.
DisableTime *timestamppb.Timestamp `protobuf:"bytes,14,opt,name=disable_time,json=disableTime,proto3" json:"disable_time,omitempty"`
// Output only. The LockStatus of this field.
LockStatus *LockStatus `protobuf:"bytes,15,opt,name=lock_status,json=lockStatus,proto3" json:"lock_status,omitempty"`
// contains filtered or unexported fields
}
func (*Field) Descriptor() ([]byte, []int)
Deprecated: Use Field.ProtoReflect.Descriptor instead.
func (x *Field) GetAppliedCapabilities() *Field_AppliedCapabilities
func (x *Field) GetCreateTime() *timestamppb.Timestamp
func (x *Field) GetCreator() *UserInfo
func (x *Field) GetDateOptions() *Field_DateOptions
func (x *Field) GetDisableTime() *timestamppb.Timestamp
func (x *Field) GetDisabler() *UserInfo
func (x *Field) GetDisplayHints() *Field_DisplayHints
func (x *Field) GetId() string
func (x *Field) GetIntegerOptions() *Field_IntegerOptions
func (x *Field) GetLifecycle() *Lifecycle
func (x *Field) GetLockStatus() *LockStatus
func (x *Field) GetProperties() *Field_Properties
func (x *Field) GetPublisher() *UserInfo
func (x *Field) GetQueryKey() string
func (x *Field) GetSchemaCapabilities() *Field_SchemaCapabilities
func (x *Field) GetSelectionOptions() *Field_SelectionOptions
func (x *Field) GetTextOptions() *Field_TextOptions
func (m *Field) GetType() isField_Type
func (x *Field) GetUpdateTime() *timestamppb.Timestamp
func (x *Field) GetUpdater() *UserInfo
func (x *Field) GetUserOptions() *Field_UserOptions
func (*Field) ProtoMessage()
func (x *Field) ProtoReflect() protoreflect.Message
func (x *Field) Reset()
func (x *Field) String() string
Field constants governing the structure of a Field; such as, the maximum title length, minimum and maximum field values or length, etc.
type FieldLimits struct {
// Max length for the id.
MaxIdLength int32 `protobuf:"varint,1,opt,name=max_id_length,json=maxIdLength,proto3" json:"max_id_length,omitempty"`
// Limits for Field title.
MaxDisplayNameLength int32 `protobuf:"varint,2,opt,name=max_display_name_length,json=maxDisplayNameLength,proto3" json:"max_display_name_length,omitempty"`
// Limits for Field description, also called help text.
MaxDescriptionLength int32 `protobuf:"varint,3,opt,name=max_description_length,json=maxDescriptionLength,proto3" json:"max_description_length,omitempty"`
// The relevant limits for the specified Field.Type.
// Text Field limits.
TextLimits *TextLimits `protobuf:"bytes,4,opt,name=text_limits,json=textLimits,proto3" json:"text_limits,omitempty"`
// Long text Field limits.
LongTextLimits *LongTextLimits `protobuf:"bytes,5,opt,name=long_text_limits,json=longTextLimits,proto3" json:"long_text_limits,omitempty"`
// Integer Field limits.
IntegerLimits *IntegerLimits `protobuf:"bytes,6,opt,name=integer_limits,json=integerLimits,proto3" json:"integer_limits,omitempty"`
// Date Field limits.
DateLimits *DateLimits `protobuf:"bytes,7,opt,name=date_limits,json=dateLimits,proto3" json:"date_limits,omitempty"`
// User Field limits.
UserLimits *UserLimits `protobuf:"bytes,8,opt,name=user_limits,json=userLimits,proto3" json:"user_limits,omitempty"`
// Selection Field limits.
SelectionLimits *SelectionLimits `protobuf:"bytes,9,opt,name=selection_limits,json=selectionLimits,proto3" json:"selection_limits,omitempty"`
// contains filtered or unexported fields
}
func (*FieldLimits) Descriptor() ([]byte, []int)
Deprecated: Use FieldLimits.ProtoReflect.Descriptor instead.
func (x *FieldLimits) GetDateLimits() *DateLimits
func (x *FieldLimits) GetIntegerLimits() *IntegerLimits
func (x *FieldLimits) GetLongTextLimits() *LongTextLimits
func (x *FieldLimits) GetMaxDescriptionLength() int32
func (x *FieldLimits) GetMaxDisplayNameLength() int32
func (x *FieldLimits) GetMaxIdLength() int32
func (x *FieldLimits) GetSelectionLimits() *SelectionLimits
func (x *FieldLimits) GetTextLimits() *TextLimits
func (x *FieldLimits) GetUserLimits() *UserLimits
func (*FieldLimits) ProtoMessage()
func (x *FieldLimits) ProtoReflect() protoreflect.Message
func (x *FieldLimits) Reset()
func (x *FieldLimits) String() string
The capabilities related to this field on applied metadata.
type Field_AppliedCapabilities struct {
// Whether the user can read related applied metadata on items.
CanRead bool `protobuf:"varint,1,opt,name=can_read,json=canRead,proto3" json:"can_read,omitempty"`
// Whether the user can search for Drive items referencing this field.
CanSearch bool `protobuf:"varint,2,opt,name=can_search,json=canSearch,proto3" json:"can_search,omitempty"`
// Whether the user can set this field on Drive items.
CanWrite bool `protobuf:"varint,3,opt,name=can_write,json=canWrite,proto3" json:"can_write,omitempty"`
// contains filtered or unexported fields
}
func (*Field_AppliedCapabilities) Descriptor() ([]byte, []int)
Deprecated: Use Field_AppliedCapabilities.ProtoReflect.Descriptor instead.
func (x *Field_AppliedCapabilities) GetCanRead() bool
func (x *Field_AppliedCapabilities) GetCanSearch() bool
func (x *Field_AppliedCapabilities) GetCanWrite() bool
func (*Field_AppliedCapabilities) ProtoMessage()
func (x *Field_AppliedCapabilities) ProtoReflect() protoreflect.Message
func (x *Field_AppliedCapabilities) Reset()
func (x *Field_AppliedCapabilities) String() string
Options for the date field type.
type Field_DateOptions struct {
// Localized date formatting option. Field values are rendered in
// this format according to their locale.
DateFormatType Field_DateOptions_DateFormat `protobuf:"varint,1,opt,name=date_format_type,json=dateFormatType,proto3,enum=google.apps.drive.labels.v2beta.Field_DateOptions_DateFormat" json:"date_format_type,omitempty"`
// Output only. ICU date format.
DateFormat string `protobuf:"bytes,2,opt,name=date_format,json=dateFormat,proto3" json:"date_format,omitempty"`
// Output only. Minimum valid value (year, month, day).
MinValue *date.Date `protobuf:"bytes,3,opt,name=min_value,json=minValue,proto3" json:"min_value,omitempty"`
// Output only. Maximum valid value (year, month, day).
MaxValue *date.Date `protobuf:"bytes,4,opt,name=max_value,json=maxValue,proto3" json:"max_value,omitempty"`
// contains filtered or unexported fields
}
func (*Field_DateOptions) Descriptor() ([]byte, []int)
Deprecated: Use Field_DateOptions.ProtoReflect.Descriptor instead.
func (x *Field_DateOptions) GetDateFormat() string
func (x *Field_DateOptions) GetDateFormatType() Field_DateOptions_DateFormat
func (x *Field_DateOptions) GetMaxValue() *date.Date
func (x *Field_DateOptions) GetMinValue() *date.Date
func (*Field_DateOptions) ProtoMessage()
func (x *Field_DateOptions) ProtoReflect() protoreflect.Message
func (x *Field_DateOptions) Reset()
func (x *Field_DateOptions) String() string
type Field_DateOptions_ struct {
// Date field options.
DateOptions *Field_DateOptions `protobuf:"bytes,19,opt,name=date_options,json=dateOptions,proto3,oneof"`
}
Localized date format options.
type Field_DateOptions_DateFormat int32
const (
// Date format unspecified.
Field_DateOptions_DATE_FORMAT_UNSPECIFIED Field_DateOptions_DateFormat = 0
// Includes full month name.
// For example, January 12, 1999
// (MMMM d, y)
Field_DateOptions_LONG_DATE Field_DateOptions_DateFormat = 1
// Short, numeric, representation.
// For example, 12/13/99
// (M/d/yy)
Field_DateOptions_SHORT_DATE Field_DateOptions_DateFormat = 2
)
func (Field_DateOptions_DateFormat) Descriptor() protoreflect.EnumDescriptor
func (x Field_DateOptions_DateFormat) Enum() *Field_DateOptions_DateFormat
func (Field_DateOptions_DateFormat) EnumDescriptor() ([]byte, []int)
Deprecated: Use Field_DateOptions_DateFormat.Descriptor instead.
func (x Field_DateOptions_DateFormat) Number() protoreflect.EnumNumber
func (x Field_DateOptions_DateFormat) String() string
func (Field_DateOptions_DateFormat) Type() protoreflect.EnumType
UI display hints for rendering a field.
type Field_DisplayHints struct {
// Whether the field should be shown as required in the UI.
Required bool `protobuf:"varint,1,opt,name=required,proto3" json:"required,omitempty"`
// Whether the field should be shown in the UI as disabled.
Disabled bool `protobuf:"varint,2,opt,name=disabled,proto3" json:"disabled,omitempty"`
// This field should be hidden in the search menu when searching for Drive
// items.
HiddenInSearch bool `protobuf:"varint,3,opt,name=hidden_in_search,json=hiddenInSearch,proto3" json:"hidden_in_search,omitempty"`
// This field should be shown in the apply menu when applying values to a
// Drive item.
ShownInApply bool `protobuf:"varint,4,opt,name=shown_in_apply,json=shownInApply,proto3" json:"shown_in_apply,omitempty"`
// contains filtered or unexported fields
}
func (*Field_DisplayHints) Descriptor() ([]byte, []int)
Deprecated: Use Field_DisplayHints.ProtoReflect.Descriptor instead.
func (x *Field_DisplayHints) GetDisabled() bool
func (x *Field_DisplayHints) GetHiddenInSearch() bool
func (x *Field_DisplayHints) GetRequired() bool
func (x *Field_DisplayHints) GetShownInApply() bool
func (*Field_DisplayHints) ProtoMessage()
func (x *Field_DisplayHints) ProtoReflect() protoreflect.Message
func (x *Field_DisplayHints) Reset()
func (x *Field_DisplayHints) String() string
Options for the Integer field type.
type Field_IntegerOptions struct {
// Output only. The minimum valid value for the integer field.
MinValue int64 `protobuf:"varint,1,opt,name=min_value,json=minValue,proto3" json:"min_value,omitempty"`
// Output only. The maximum valid value for the integer field.
MaxValue int64 `protobuf:"varint,2,opt,name=max_value,json=maxValue,proto3" json:"max_value,omitempty"`
// contains filtered or unexported fields
}
func (*Field_IntegerOptions) Descriptor() ([]byte, []int)
Deprecated: Use Field_IntegerOptions.ProtoReflect.Descriptor instead.
func (x *Field_IntegerOptions) GetMaxValue() int64
func (x *Field_IntegerOptions) GetMinValue() int64
func (*Field_IntegerOptions) ProtoMessage()
func (x *Field_IntegerOptions) ProtoReflect() protoreflect.Message
func (x *Field_IntegerOptions) Reset()
func (x *Field_IntegerOptions) String() string
type Field_IntegerOptions_ struct {
// Integer field options.
IntegerOptions *Field_IntegerOptions `protobuf:"bytes,18,opt,name=integer_options,json=integerOptions,proto3,oneof"`
}
Options for a multi-valued variant of an associated field type.
type Field_ListOptions struct {
// Maximum number of entries permitted.
MaxEntries int32 `protobuf:"varint,1,opt,name=max_entries,json=maxEntries,proto3" json:"max_entries,omitempty"`
// contains filtered or unexported fields
}
func (*Field_ListOptions) Descriptor() ([]byte, []int)
Deprecated: Use Field_ListOptions.ProtoReflect.Descriptor instead.
func (x *Field_ListOptions) GetMaxEntries() int32
func (*Field_ListOptions) ProtoMessage()
func (x *Field_ListOptions) ProtoReflect() protoreflect.Message
func (x *Field_ListOptions) Reset()
func (x *Field_ListOptions) String() string
The basic properties of the field.
type Field_Properties struct {
// Required. The display text to show in the UI identifying this field.
DisplayName string `protobuf:"bytes,1,opt,name=display_name,json=displayName,proto3" json:"display_name,omitempty"`
// Whether the field should be marked as required.
Required bool `protobuf:"varint,2,opt,name=required,proto3" json:"required,omitempty"`
// Input only. Insert or move this field before the indicated field. If
// empty, the field is placed at the end of the list.
InsertBeforeField string `protobuf:"bytes,3,opt,name=insert_before_field,json=insertBeforeField,proto3" json:"insert_before_field,omitempty"`
// contains filtered or unexported fields
}
func (*Field_Properties) Descriptor() ([]byte, []int)
Deprecated: Use Field_Properties.ProtoReflect.Descriptor instead.
func (x *Field_Properties) GetDisplayName() string
func (x *Field_Properties) GetInsertBeforeField() string
func (x *Field_Properties) GetRequired() bool
func (*Field_Properties) ProtoMessage()
func (x *Field_Properties) ProtoReflect() protoreflect.Message
func (x *Field_Properties) Reset()
func (x *Field_Properties) String() string
The capabilities related to this field when editing the field.
type Field_SchemaCapabilities struct {
// Whether the user can change this field.
CanUpdate bool `protobuf:"varint,1,opt,name=can_update,json=canUpdate,proto3" json:"can_update,omitempty"`
// Whether the user can delete this field.
// The user must have permission and the field must be deprecated.
CanDelete bool `protobuf:"varint,2,opt,name=can_delete,json=canDelete,proto3" json:"can_delete,omitempty"`
// Whether the user can disable this field.
// The user must have permission and this field must not already be
// disabled.
CanDisable bool `protobuf:"varint,3,opt,name=can_disable,json=canDisable,proto3" json:"can_disable,omitempty"`
// Whether the user can enable this field.
// The user must have permission and this field must be disabled.
CanEnable bool `protobuf:"varint,4,opt,name=can_enable,json=canEnable,proto3" json:"can_enable,omitempty"`
// contains filtered or unexported fields
}
func (*Field_SchemaCapabilities) Descriptor() ([]byte, []int)
Deprecated: Use Field_SchemaCapabilities.ProtoReflect.Descriptor instead.
func (x *Field_SchemaCapabilities) GetCanDelete() bool
func (x *Field_SchemaCapabilities) GetCanDisable() bool
func (x *Field_SchemaCapabilities) GetCanEnable() bool
func (x *Field_SchemaCapabilities) GetCanUpdate() bool
func (*Field_SchemaCapabilities) ProtoMessage()
func (x *Field_SchemaCapabilities) ProtoReflect() protoreflect.Message
func (x *Field_SchemaCapabilities) Reset()
func (x *Field_SchemaCapabilities) String() string
Options for the selection field type.
type Field_SelectionOptions struct {
// When specified, indicates this field supports a list of values.
// Once the field is published, this cannot be changed.
ListOptions *Field_ListOptions `protobuf:"bytes,1,opt,name=list_options,json=listOptions,proto3" json:"list_options,omitempty"`
// The options available for this selection field.
// The list order is consistent, and modified with `insert_before_choice`.
Choices []*Field_SelectionOptions_Choice `protobuf:"bytes,2,rep,name=choices,proto3" json:"choices,omitempty"`
// contains filtered or unexported fields
}
func (*Field_SelectionOptions) Descriptor() ([]byte, []int)
Deprecated: Use Field_SelectionOptions.ProtoReflect.Descriptor instead.
func (x *Field_SelectionOptions) GetChoices() []*Field_SelectionOptions_Choice
func (x *Field_SelectionOptions) GetListOptions() *Field_ListOptions
func (*Field_SelectionOptions) ProtoMessage()
func (x *Field_SelectionOptions) ProtoReflect() protoreflect.Message
func (x *Field_SelectionOptions) Reset()
func (x *Field_SelectionOptions) String() string
type Field_SelectionOptions_ struct {
// Selection field options.
SelectionOptions *Field_SelectionOptions `protobuf:"bytes,20,opt,name=selection_options,json=selectionOptions,proto3,oneof"`
}
Selection field choice.
type Field_SelectionOptions_Choice struct {
// The unique value of the choice.
// This ID is autogenerated. Matches the regex: `([a-zA-Z0-9_])+`.
Id string `protobuf:"bytes,1,opt,name=id,proto3" json:"id,omitempty"`
// Basic properties of the choice.
Properties *Field_SelectionOptions_Choice_Properties `protobuf:"bytes,2,opt,name=properties,proto3" json:"properties,omitempty"`
// Output only. Lifecycle of the choice.
Lifecycle *Lifecycle `protobuf:"bytes,3,opt,name=lifecycle,proto3" json:"lifecycle,omitempty"`
// Output only. UI display hints for rendering a choice.
DisplayHints *Field_SelectionOptions_Choice_DisplayHints `protobuf:"bytes,4,opt,name=display_hints,json=displayHints,proto3" json:"display_hints,omitempty"`
// Output only. The capabilities related to this option when editing the
// option.
SchemaCapabilities *Field_SelectionOptions_Choice_SchemaCapabilities `protobuf:"bytes,5,opt,name=schema_capabilities,json=schemaCapabilities,proto3" json:"schema_capabilities,omitempty"`
// Output only. The capabilities related to this choice on applied
// metadata.
AppliedCapabilities *Field_SelectionOptions_Choice_AppliedCapabilities `protobuf:"bytes,6,opt,name=applied_capabilities,json=appliedCapabilities,proto3" json:"applied_capabilities,omitempty"`
// Output only. The user who created this choice.
Creator *UserInfo `protobuf:"bytes,7,opt,name=creator,proto3" json:"creator,omitempty"`
// Output only. The time this choice was created.
CreateTime *timestamppb.Timestamp `protobuf:"bytes,8,opt,name=create_time,json=createTime,proto3" json:"create_time,omitempty"`
// Output only. The user who updated this choice last.
Updater *UserInfo `protobuf:"bytes,9,opt,name=updater,proto3" json:"updater,omitempty"`
// Output only. The time this choice was updated last.
UpdateTime *timestamppb.Timestamp `protobuf:"bytes,10,opt,name=update_time,json=updateTime,proto3" json:"update_time,omitempty"`
// Output only. The user who published this choice. This value has no
// meaning when the choice is not published.
Publisher *UserInfo `protobuf:"bytes,11,opt,name=publisher,proto3" json:"publisher,omitempty"`
// Output only. The time this choice was published. This value has no
// meaning when the choice is not published.
PublishTime *timestamppb.Timestamp `protobuf:"bytes,12,opt,name=publish_time,json=publishTime,proto3" json:"publish_time,omitempty"`
// Output only. The user who disabled this choice. This value has no
// meaning when the option is not disabled.
Disabler *UserInfo `protobuf:"bytes,13,opt,name=disabler,proto3" json:"disabler,omitempty"`
// Output only. The time this choice was disabled. This value has no
// meaning when the choice is not disabled.
DisableTime *timestamppb.Timestamp `protobuf:"bytes,14,opt,name=disable_time,json=disableTime,proto3" json:"disable_time,omitempty"`
// Output only. The LockStatus of this choice.
LockStatus *LockStatus `protobuf:"bytes,15,opt,name=lock_status,json=lockStatus,proto3" json:"lock_status,omitempty"`
// contains filtered or unexported fields
}
func (*Field_SelectionOptions_Choice) Descriptor() ([]byte, []int)
Deprecated: Use Field_SelectionOptions_Choice.ProtoReflect.Descriptor instead.
func (x *Field_SelectionOptions_Choice) GetAppliedCapabilities() *Field_SelectionOptions_Choice_AppliedCapabilities
func (x *Field_SelectionOptions_Choice) GetCreateTime() *timestamppb.Timestamp
func (x *Field_SelectionOptions_Choice) GetCreator() *UserInfo
func (x *Field_SelectionOptions_Choice) GetDisableTime() *timestamppb.Timestamp
func (x *Field_SelectionOptions_Choice) GetDisabler() *UserInfo
func (x *Field_SelectionOptions_Choice) GetDisplayHints() *Field_SelectionOptions_Choice_DisplayHints
func (x *Field_SelectionOptions_Choice) GetId() string
func (x *Field_SelectionOptions_Choice) GetLifecycle() *Lifecycle
func (x *Field_SelectionOptions_Choice) GetLockStatus() *LockStatus
func (x *Field_SelectionOptions_Choice) GetProperties() *Field_SelectionOptions_Choice_Properties
func (x *Field_SelectionOptions_Choice) GetPublishTime() *timestamppb.Timestamp
func (x *Field_SelectionOptions_Choice) GetPublisher() *UserInfo
func (x *Field_SelectionOptions_Choice) GetSchemaCapabilities() *Field_SelectionOptions_Choice_SchemaCapabilities
func (x *Field_SelectionOptions_Choice) GetUpdateTime() *timestamppb.Timestamp
func (x *Field_SelectionOptions_Choice) GetUpdater() *UserInfo
func (*Field_SelectionOptions_Choice) ProtoMessage()
func (x *Field_SelectionOptions_Choice) ProtoReflect() protoreflect.Message
func (x *Field_SelectionOptions_Choice) Reset()
func (x *Field_SelectionOptions_Choice) String() string
The capabilities related to this choice on applied metadata.
type Field_SelectionOptions_Choice_AppliedCapabilities struct {
// Whether the user can read related applied metadata on items.
CanRead bool `protobuf:"varint,1,opt,name=can_read,json=canRead,proto3" json:"can_read,omitempty"`
// Whether the user can use this choice in search queries.
CanSearch bool `protobuf:"varint,2,opt,name=can_search,json=canSearch,proto3" json:"can_search,omitempty"`
// Whether the user can select this choice on an item.
CanSelect bool `protobuf:"varint,3,opt,name=can_select,json=canSelect,proto3" json:"can_select,omitempty"`
// contains filtered or unexported fields
}
func (*Field_SelectionOptions_Choice_AppliedCapabilities) Descriptor() ([]byte, []int)
Deprecated: Use Field_SelectionOptions_Choice_AppliedCapabilities.ProtoReflect.Descriptor instead.
func (x *Field_SelectionOptions_Choice_AppliedCapabilities) GetCanRead() bool
func (x *Field_SelectionOptions_Choice_AppliedCapabilities) GetCanSearch() bool
func (x *Field_SelectionOptions_Choice_AppliedCapabilities) GetCanSelect() bool
func (*Field_SelectionOptions_Choice_AppliedCapabilities) ProtoMessage()
func (x *Field_SelectionOptions_Choice_AppliedCapabilities) ProtoReflect() protoreflect.Message
func (x *Field_SelectionOptions_Choice_AppliedCapabilities) Reset()
func (x *Field_SelectionOptions_Choice_AppliedCapabilities) String() string
UI display hints for rendering an option.
type Field_SelectionOptions_Choice_DisplayHints struct {
// Whether the option should be shown in the UI as disabled.
Disabled bool `protobuf:"varint,1,opt,name=disabled,proto3" json:"disabled,omitempty"`
// This option should be hidden in the search menu when searching for
// Drive items.
HiddenInSearch bool `protobuf:"varint,2,opt,name=hidden_in_search,json=hiddenInSearch,proto3" json:"hidden_in_search,omitempty"`
// This option should be shown in the apply menu when applying values to
// a Drive item.
ShownInApply bool `protobuf:"varint,3,opt,name=shown_in_apply,json=shownInApply,proto3" json:"shown_in_apply,omitempty"`
// The colors to use for the badge. Changed to Google Material colors
// based on the chosen `properties.badge_config.color`.
BadgeColors *BadgeColors `protobuf:"bytes,4,opt,name=badge_colors,json=badgeColors,proto3" json:"badge_colors,omitempty"`
// The dark-mode color to use for the badge. Changed to Google Material
// colors based on the chosen `properties.badge_config.color`.
DarkBadgeColors *BadgeColors `protobuf:"bytes,5,opt,name=dark_badge_colors,json=darkBadgeColors,proto3" json:"dark_badge_colors,omitempty"`
// The priority of this badge. Used to compare and sort between multiple
// badges. A lower number means the badge should be shown first.
// When a badging configuration is not present, this will be 0.
// Otherwise, this will be set to `BadgeConfig.priority_override` or the
// default heuristic which prefers creation date of the label, and field
// and option priority.
BadgePriority int64 `protobuf:"varint,6,opt,name=badge_priority,json=badgePriority,proto3" json:"badge_priority,omitempty"`
// contains filtered or unexported fields
}
func (*Field_SelectionOptions_Choice_DisplayHints) Descriptor() ([]byte, []int)
Deprecated: Use Field_SelectionOptions_Choice_DisplayHints.ProtoReflect.Descriptor instead.
func (x *Field_SelectionOptions_Choice_DisplayHints) GetBadgeColors() *BadgeColors
func (x *Field_SelectionOptions_Choice_DisplayHints) GetBadgePriority() int64
func (x *Field_SelectionOptions_Choice_DisplayHints) GetDarkBadgeColors() *BadgeColors
func (x *Field_SelectionOptions_Choice_DisplayHints) GetDisabled() bool
func (x *Field_SelectionOptions_Choice_DisplayHints) GetHiddenInSearch() bool
func (x *Field_SelectionOptions_Choice_DisplayHints) GetShownInApply() bool
func (*Field_SelectionOptions_Choice_DisplayHints) ProtoMessage()
func (x *Field_SelectionOptions_Choice_DisplayHints) ProtoReflect() protoreflect.Message
func (x *Field_SelectionOptions_Choice_DisplayHints) Reset()
func (x *Field_SelectionOptions_Choice_DisplayHints) String() string
Basic properties of the choice.
type Field_SelectionOptions_Choice_Properties struct {
// Required. The display text to show in the UI identifying this field.
DisplayName string `protobuf:"bytes,1,opt,name=display_name,json=displayName,proto3" json:"display_name,omitempty"`
// The description of this label.
Description string `protobuf:"bytes,2,opt,name=description,proto3" json:"description,omitempty"`
// The badge configuration for this choice. When set, the
// label that owns this choice is considered a "badged label".
BadgeConfig *BadgeConfig `protobuf:"bytes,3,opt,name=badge_config,json=badgeConfig,proto3" json:"badge_config,omitempty"`
// Input only. Insert or move this choice before the indicated choice.
// If empty, the choice is placed at the end of the list.
InsertBeforeChoice string `protobuf:"bytes,4,opt,name=insert_before_choice,json=insertBeforeChoice,proto3" json:"insert_before_choice,omitempty"`
// contains filtered or unexported fields
}
func (*Field_SelectionOptions_Choice_Properties) Descriptor() ([]byte, []int)
Deprecated: Use Field_SelectionOptions_Choice_Properties.ProtoReflect.Descriptor instead.
func (x *Field_SelectionOptions_Choice_Properties) GetBadgeConfig() *BadgeConfig
func (x *Field_SelectionOptions_Choice_Properties) GetDescription() string
func (x *Field_SelectionOptions_Choice_Properties) GetDisplayName() string
func (x *Field_SelectionOptions_Choice_Properties) GetInsertBeforeChoice() string
func (*Field_SelectionOptions_Choice_Properties) ProtoMessage()
func (x *Field_SelectionOptions_Choice_Properties) ProtoReflect() protoreflect.Message
func (x *Field_SelectionOptions_Choice_Properties) Reset()
func (x *Field_SelectionOptions_Choice_Properties) String() string
The capabilities related to this choice when editing the choice.
type Field_SelectionOptions_Choice_SchemaCapabilities struct {
// Whether the user can update this choice.
CanUpdate bool `protobuf:"varint,1,opt,name=can_update,json=canUpdate,proto3" json:"can_update,omitempty"`
// Whether the user can delete this choice.
CanDelete bool `protobuf:"varint,2,opt,name=can_delete,json=canDelete,proto3" json:"can_delete,omitempty"`
// Whether the user can disable this choice.
CanDisable bool `protobuf:"varint,3,opt,name=can_disable,json=canDisable,proto3" json:"can_disable,omitempty"`
// Whether the user can enable this choice.
CanEnable bool `protobuf:"varint,4,opt,name=can_enable,json=canEnable,proto3" json:"can_enable,omitempty"`
// contains filtered or unexported fields
}
func (*Field_SelectionOptions_Choice_SchemaCapabilities) Descriptor() ([]byte, []int)
Deprecated: Use Field_SelectionOptions_Choice_SchemaCapabilities.ProtoReflect.Descriptor instead.
func (x *Field_SelectionOptions_Choice_SchemaCapabilities) GetCanDelete() bool
func (x *Field_SelectionOptions_Choice_SchemaCapabilities) GetCanDisable() bool
func (x *Field_SelectionOptions_Choice_SchemaCapabilities) GetCanEnable() bool
func (x *Field_SelectionOptions_Choice_SchemaCapabilities) GetCanUpdate() bool
func (*Field_SelectionOptions_Choice_SchemaCapabilities) ProtoMessage()
func (x *Field_SelectionOptions_Choice_SchemaCapabilities) ProtoReflect() protoreflect.Message
func (x *Field_SelectionOptions_Choice_SchemaCapabilities) Reset()
func (x *Field_SelectionOptions_Choice_SchemaCapabilities) String() string
Options for the Text field type.
type Field_TextOptions struct {
// Output only. The minimum valid length of values for the text field.
MinLength int32 `protobuf:"varint,1,opt,name=min_length,json=minLength,proto3" json:"min_length,omitempty"`
// Output only. The maximum valid length of values for the text field.
MaxLength int32 `protobuf:"varint,2,opt,name=max_length,json=maxLength,proto3" json:"max_length,omitempty"`
// contains filtered or unexported fields
}
func (*Field_TextOptions) Descriptor() ([]byte, []int)
Deprecated: Use Field_TextOptions.ProtoReflect.Descriptor instead.
func (x *Field_TextOptions) GetMaxLength() int32
func (x *Field_TextOptions) GetMinLength() int32
func (*Field_TextOptions) ProtoMessage()
func (x *Field_TextOptions) ProtoReflect() protoreflect.Message
func (x *Field_TextOptions) Reset()
func (x *Field_TextOptions) String() string
type Field_TextOptions_ struct {
// Text field options.
TextOptions *Field_TextOptions `protobuf:"bytes,16,opt,name=text_options,json=textOptions,proto3,oneof"`
}
Options for the user field type.
type Field_UserOptions struct {
// When specified, indicates that this field supports a list of values.
// Once the field is published, this cannot be changed.
ListOptions *Field_ListOptions `protobuf:"bytes,1,opt,name=list_options,json=listOptions,proto3" json:"list_options,omitempty"`
// contains filtered or unexported fields
}
func (*Field_UserOptions) Descriptor() ([]byte, []int)
Deprecated: Use Field_UserOptions.ProtoReflect.Descriptor instead.
func (x *Field_UserOptions) GetListOptions() *Field_ListOptions
func (*Field_UserOptions) ProtoMessage()
func (x *Field_UserOptions) ProtoReflect() protoreflect.Message
func (x *Field_UserOptions) Reset()
func (x *Field_UserOptions) String() string
type Field_UserOptions_ struct {
// User field options.
UserOptions *Field_UserOptions `protobuf:"bytes,21,opt,name=user_options,json=userOptions,proto3,oneof"`
}
Request to get the limits for a Label.
type GetLabelLimitsRequest struct {
// Required. Label revision resource name
// Must be: "limits/label"
Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
// contains filtered or unexported fields
}
func (*GetLabelLimitsRequest) Descriptor() ([]byte, []int)
Deprecated: Use GetLabelLimitsRequest.ProtoReflect.Descriptor instead.
func (x *GetLabelLimitsRequest) GetName() string
func (*GetLabelLimitsRequest) ProtoMessage()
func (x *GetLabelLimitsRequest) ProtoReflect() protoreflect.Message
func (x *GetLabelLimitsRequest) Reset()
func (x *GetLabelLimitsRequest) String() string
Request to get a label by resource name.
type GetLabelRequest struct {
// Required. Label resource name.
//
// May be any of:
//
// * `labels/{id}` (equivalent to labels/{id}@latest)
// * `labels/{id}@latest`
// * `labels/{id}@published`
// * `labels/{id}@{revision_id}`
Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
// Set to `true` in order to use the user's admin credentials. The server
// verifies that the user is an admin for the label before allowing access.
UseAdminAccess bool `protobuf:"varint,2,opt,name=use_admin_access,json=useAdminAccess,proto3" json:"use_admin_access,omitempty"`
// The BCP-47 language code to use for evaluating localized field labels.
// When not specified, values in the default configured language are used.
LanguageCode string `protobuf:"bytes,3,opt,name=language_code,json=languageCode,proto3" json:"language_code,omitempty"`
// When specified, only certain fields belonging to the indicated view are
// returned.
View LabelView `protobuf:"varint,4,opt,name=view,proto3,enum=google.apps.drive.labels.v2beta.LabelView" json:"view,omitempty"`
// contains filtered or unexported fields
}
func (*GetLabelRequest) Descriptor() ([]byte, []int)
Deprecated: Use GetLabelRequest.ProtoReflect.Descriptor instead.
func (x *GetLabelRequest) GetLanguageCode() string
func (x *GetLabelRequest) GetName() string
func (x *GetLabelRequest) GetUseAdminAccess() bool
func (x *GetLabelRequest) GetView() LabelView
func (*GetLabelRequest) ProtoMessage()
func (x *GetLabelRequest) ProtoReflect() protoreflect.Message
func (x *GetLabelRequest) Reset()
func (x *GetLabelRequest) String() string
Request to get the capabilities for a user.
type GetUserCapabilitiesRequest struct {
// Required. The resource name of the user. Only "users/me/capabilities" is
// supported.
Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
// The customer to scope this request to.
// For example: "customers/abcd1234".
// If unset, will return settings within the current customer.
Customer string `protobuf:"bytes,2,opt,name=customer,proto3" json:"customer,omitempty"`
// contains filtered or unexported fields
}
func (*GetUserCapabilitiesRequest) Descriptor() ([]byte, []int)
Deprecated: Use GetUserCapabilitiesRequest.ProtoReflect.Descriptor instead.
func (x *GetUserCapabilitiesRequest) GetCustomer() string
func (x *GetUserCapabilitiesRequest) GetName() string
func (*GetUserCapabilitiesRequest) ProtoMessage()
func (x *GetUserCapabilitiesRequest) ProtoReflect() protoreflect.Message
func (x *GetUserCapabilitiesRequest) Reset()
func (x *GetUserCapabilitiesRequest) String() string
Limits for integer Field type.
type IntegerLimits struct {
// Minimum value for an integer Field type.
MinValue int64 `protobuf:"varint,1,opt,name=min_value,json=minValue,proto3" json:"min_value,omitempty"`
// Maximum value for an integer Field type.
MaxValue int64 `protobuf:"varint,2,opt,name=max_value,json=maxValue,proto3" json:"max_value,omitempty"`
// contains filtered or unexported fields
}
func (*IntegerLimits) Descriptor() ([]byte, []int)
Deprecated: Use IntegerLimits.ProtoReflect.Descriptor instead.
func (x *IntegerLimits) GetMaxValue() int64
func (x *IntegerLimits) GetMinValue() int64
func (*IntegerLimits) ProtoMessage()
func (x *IntegerLimits) ProtoReflect() protoreflect.Message
func (x *IntegerLimits) Reset()
func (x *IntegerLimits) String() string
Describes violations in a request to create or update a Label or its Fields.
type InvalidArgument struct {
// Describes all violations in a client request.
FieldViolations []*InvalidArgument_FieldViolation `protobuf:"bytes,1,rep,name=field_violations,json=fieldViolations,proto3" json:"field_violations,omitempty"`
// contains filtered or unexported fields
}
func (*InvalidArgument) Descriptor() ([]byte, []int)
Deprecated: Use InvalidArgument.ProtoReflect.Descriptor instead.
func (x *InvalidArgument) GetFieldViolations() []*InvalidArgument_FieldViolation
func (*InvalidArgument) ProtoMessage()
func (x *InvalidArgument) ProtoReflect() protoreflect.Message
func (x *InvalidArgument) Reset()
func (x *InvalidArgument) String() string
Describes the Field in which the violation occurred.
type InvalidArgument_FieldViolation struct {
// The path to the field where this violation occurred. This path is
// specified using `FieldMask` format:
// https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#fieldmask
Field string `protobuf:"bytes,1,opt,name=field,proto3" json:"field,omitempty"`
// The detailed reason for this FieldViolation.
Reason InvalidArgument_FieldViolation_Reason `protobuf:"varint,2,opt,name=reason,proto3,enum=google.apps.drive.labels.v2beta.InvalidArgument_FieldViolation_Reason" json:"reason,omitempty"`
// A message that describes the violation. This message is intended to
// be shown to end users, and is localized into the requesting user's
// preferred language.
DisplayMessage string `protobuf:"bytes,3,opt,name=display_message,json=displayMessage,proto3" json:"display_message,omitempty"`
// contains filtered or unexported fields
}
func (*InvalidArgument_FieldViolation) Descriptor() ([]byte, []int)
Deprecated: Use InvalidArgument_FieldViolation.ProtoReflect.Descriptor instead.
func (x *InvalidArgument_FieldViolation) GetDisplayMessage() string
func (x *InvalidArgument_FieldViolation) GetField() string
func (x *InvalidArgument_FieldViolation) GetReason() InvalidArgument_FieldViolation_Reason
func (*InvalidArgument_FieldViolation) ProtoMessage()
func (x *InvalidArgument_FieldViolation) ProtoReflect() protoreflect.Message
func (x *InvalidArgument_FieldViolation) Reset()
func (x *InvalidArgument_FieldViolation) String() string
Possible reasons a field is invalid.
type InvalidArgument_FieldViolation_Reason int32
const (
// Unknown reason.
InvalidArgument_FieldViolation_REASON_UNSPECIFIED InvalidArgument_FieldViolation_Reason = 0
// The referenced field is required.
InvalidArgument_FieldViolation_FIELD_REQUIRED InvalidArgument_FieldViolation_Reason = 1
// The referenced value was invalid.
InvalidArgument_FieldViolation_INVALID_VALUE InvalidArgument_FieldViolation_Reason = 2
// The specified numeric value is out of the allowed range.
InvalidArgument_FieldViolation_VALUE_OUT_OF_RANGE InvalidArgument_FieldViolation_Reason = 3
// The specified string value was too long.
InvalidArgument_FieldViolation_STRING_VALUE_TOO_LONG InvalidArgument_FieldViolation_Reason = 4
// The number of entries exceeded the maximum.
InvalidArgument_FieldViolation_MAX_ENTRIES_EXCEEDED InvalidArgument_FieldViolation_Reason = 5
// The specified field is not found in the Label.
InvalidArgument_FieldViolation_FIELD_NOT_FOUND InvalidArgument_FieldViolation_Reason = 6
// The specified choice is not found in the Field.
InvalidArgument_FieldViolation_CHOICE_NOT_FOUND InvalidArgument_FieldViolation_Reason = 7
)
func (InvalidArgument_FieldViolation_Reason) Descriptor() protoreflect.EnumDescriptor
func (x InvalidArgument_FieldViolation_Reason) Enum() *InvalidArgument_FieldViolation_Reason
func (InvalidArgument_FieldViolation_Reason) EnumDescriptor() ([]byte, []int)
Deprecated: Use InvalidArgument_FieldViolation_Reason.Descriptor instead.
func (x InvalidArgument_FieldViolation_Reason) Number() protoreflect.EnumNumber
func (x InvalidArgument_FieldViolation_Reason) String() string
func (InvalidArgument_FieldViolation_Reason) Type() protoreflect.EnumType
A label defines a taxonomy that can be applied to Drive items in order to organize and search across items. Labels can be simple strings, or can contain fields that describe additional metadata that can be further used to organize and search Drive items.
type Label struct {
// Output only. Resource name of the label. Will be in the form of either:
// `labels/{id}` or `labels/{id}@{revision_id}` depending on the request.
// See `id` and `revision_id` below.
Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
// Output only. Globally unique identifier of this label. ID makes up part of
// the label `name`, but unlike `name`, ID is consistent between revisions.
// Matches the regex: `([a-zA-Z0-9])+`
Id string `protobuf:"bytes,2,opt,name=id,proto3" json:"id,omitempty"`
// Output only. Revision ID of the label. Revision ID might be part of the
// label `name` depending on the request issued. A new revision is created
// whenever revisioned properties of a label are changed. Matches the regex:
// `([a-zA-Z0-9])+`
RevisionId string `protobuf:"bytes,3,opt,name=revision_id,json=revisionId,proto3" json:"revision_id,omitempty"`
// Required. The type of label.
LabelType Label_LabelType `protobuf:"varint,4,opt,name=label_type,json=labelType,proto3,enum=google.apps.drive.labels.v2beta.Label_LabelType" json:"label_type,omitempty"`
// Output only. The user who created this label.
Creator *UserInfo `protobuf:"bytes,5,opt,name=creator,proto3" json:"creator,omitempty"`
// Output only. The time this label was created.
CreateTime *timestamppb.Timestamp `protobuf:"bytes,6,opt,name=create_time,json=createTime,proto3" json:"create_time,omitempty"`
// Output only. The user who created this label revision.
RevisionCreator *UserInfo `protobuf:"bytes,7,opt,name=revision_creator,json=revisionCreator,proto3" json:"revision_creator,omitempty"`
// Output only. The time this label revision was created.
RevisionCreateTime *timestamppb.Timestamp `protobuf:"bytes,8,opt,name=revision_create_time,json=revisionCreateTime,proto3" json:"revision_create_time,omitempty"`
// Output only. The user who published this label. This value has no meaning
// when the label is not published.
Publisher *UserInfo `protobuf:"bytes,9,opt,name=publisher,proto3" json:"publisher,omitempty"`
// Output only. The time this label was published. This value has no meaning
// when the label is not published.
PublishTime *timestamppb.Timestamp `protobuf:"bytes,10,opt,name=publish_time,json=publishTime,proto3" json:"publish_time,omitempty"`
// Output only. The user who disabled this label. This value has no meaning
// when the label is not disabled.
Disabler *UserInfo `protobuf:"bytes,11,opt,name=disabler,proto3" json:"disabler,omitempty"`
// Output only. The time this label was disabled. This value has no meaning
// when the label is not disabled.
DisableTime *timestamppb.Timestamp `protobuf:"bytes,12,opt,name=disable_time,json=disableTime,proto3" json:"disable_time,omitempty"`
// Output only. The customer this label belongs to.
// For example: "customers/123abc789."
Customer string `protobuf:"bytes,13,opt,name=customer,proto3" json:"customer,omitempty"`
// Required. The basic properties of the label.
Properties *Label_Properties `protobuf:"bytes,14,opt,name=properties,proto3" json:"properties,omitempty"`
// Output only. The lifecycle state of the label including whether it's
// published, deprecated, and has draft changes.
Lifecycle *Lifecycle `protobuf:"bytes,15,opt,name=lifecycle,proto3" json:"lifecycle,omitempty"`
// Output only. UI display hints for rendering the label.
DisplayHints *Label_DisplayHints `protobuf:"bytes,16,opt,name=display_hints,json=displayHints,proto3" json:"display_hints,omitempty"`
// Output only. The capabilities related to this label on applied metadata.
AppliedCapabilities *Label_AppliedCapabilities `protobuf:"bytes,17,opt,name=applied_capabilities,json=appliedCapabilities,proto3" json:"applied_capabilities,omitempty"`
// Output only. The capabilities the user has on this label.
SchemaCapabilities *Label_SchemaCapabilities `protobuf:"bytes,18,opt,name=schema_capabilities,json=schemaCapabilities,proto3" json:"schema_capabilities,omitempty"`
// Output only. Behavior of this label when it's applied to Drive items.
AppliedLabelPolicy *Label_AppliedLabelPolicy `protobuf:"bytes,19,opt,name=applied_label_policy,json=appliedLabelPolicy,proto3" json:"applied_label_policy,omitempty"`
// List of fields in descending priority order.
Fields []*Field `protobuf:"bytes,20,rep,name=fields,proto3" json:"fields,omitempty"`
// Custom URL to present to users to allow them to learn more about this label
// and how it should be used.
LearnMoreUri string `protobuf:"bytes,21,opt,name=learn_more_uri,json=learnMoreUri,proto3" json:"learn_more_uri,omitempty"`
// Output only. The LockStatus of this label.
LockStatus *LockStatus `protobuf:"bytes,22,opt,name=lock_status,json=lockStatus,proto3" json:"lock_status,omitempty"`
// contains filtered or unexported fields
}
func (*Label) Descriptor() ([]byte, []int)
Deprecated: Use Label.ProtoReflect.Descriptor instead.
func (x *Label) GetAppliedCapabilities() *Label_AppliedCapabilities
func (x *Label) GetAppliedLabelPolicy() *Label_AppliedLabelPolicy
func (x *Label) GetCreateTime() *timestamppb.Timestamp
func (x *Label) GetCreator() *UserInfo
func (x *Label) GetCustomer() string
func (x *Label) GetDisableTime() *timestamppb.Timestamp
func (x *Label) GetDisabler() *UserInfo
func (x *Label) GetDisplayHints() *Label_DisplayHints
func (x *Label) GetFields() []*Field
func (x *Label) GetId() string
func (x *Label) GetLabelType() Label_LabelType
func (x *Label) GetLearnMoreUri() string
func (x *Label) GetLifecycle() *Lifecycle
func (x *Label) GetLockStatus() *LockStatus
func (x *Label) GetName() string
func (x *Label) GetProperties() *Label_Properties
func (x *Label) GetPublishTime() *timestamppb.Timestamp
func (x *Label) GetPublisher() *UserInfo
func (x *Label) GetRevisionCreateTime() *timestamppb.Timestamp
func (x *Label) GetRevisionCreator() *UserInfo
func (x *Label) GetRevisionId() string
func (x *Label) GetSchemaCapabilities() *Label_SchemaCapabilities
func (*Label) ProtoMessage()
func (x *Label) ProtoReflect() protoreflect.Message
func (x *Label) Reset()
func (x *Label) String() string
Label constraints governing the structure of a Label; such as, the maximum number of Fields allowed and maximum length of the label title.
type LabelLimits struct {
// Resource name.
Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
// The maximum number of characters allowed for the title.
MaxTitleLength int32 `protobuf:"varint,2,opt,name=max_title_length,json=maxTitleLength,proto3" json:"max_title_length,omitempty"`
// The maximum number of characters allowed for the description.
MaxDescriptionLength int32 `protobuf:"varint,3,opt,name=max_description_length,json=maxDescriptionLength,proto3" json:"max_description_length,omitempty"`
// The maximum number of Fields allowed within the label.
MaxFields int32 `protobuf:"varint,4,opt,name=max_fields,json=maxFields,proto3" json:"max_fields,omitempty"`
// The maximum number of published Fields that can be deleted.
MaxDeletedFields int32 `protobuf:"varint,5,opt,name=max_deleted_fields,json=maxDeletedFields,proto3" json:"max_deleted_fields,omitempty"`
// The maximum number of draft revisions that will be kept before deleting
// old drafts.
MaxDraftRevisions int32 `protobuf:"varint,6,opt,name=max_draft_revisions,json=maxDraftRevisions,proto3" json:"max_draft_revisions,omitempty"`
// The limits for Fields.
FieldLimits *FieldLimits `protobuf:"bytes,7,opt,name=field_limits,json=fieldLimits,proto3" json:"field_limits,omitempty"`
// contains filtered or unexported fields
}
func (*LabelLimits) Descriptor() ([]byte, []int)
Deprecated: Use LabelLimits.ProtoReflect.Descriptor instead.
func (x *LabelLimits) GetFieldLimits() *FieldLimits
func (x *LabelLimits) GetMaxDeletedFields() int32
func (x *LabelLimits) GetMaxDescriptionLength() int32
func (x *LabelLimits) GetMaxDraftRevisions() int32
func (x *LabelLimits) GetMaxFields() int32
func (x *LabelLimits) GetMaxTitleLength() int32
func (x *LabelLimits) GetName() string
func (*LabelLimits) ProtoMessage()
func (x *LabelLimits) ProtoReflect() protoreflect.Message
func (x *LabelLimits) Reset()
func (x *LabelLimits) String() string
A Lock that can be applied to a Label, Field, or Choice.
type LabelLock struct {
// Output only. Resource name of this LabelLock.
Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
// The ID of the Field that should be locked. Empty if the whole
// Label should be locked.
FieldId string `protobuf:"bytes,2,opt,name=field_id,json=fieldId,proto3" json:"field_id,omitempty"`
// The ID of the Selection Field Choice that should be locked. If present,
// `field_id` must also be present.
ChoiceId string `protobuf:"bytes,3,opt,name=choice_id,json=choiceId,proto3" json:"choice_id,omitempty"`
// Output only. The time this LabelLock was created.
CreateTime *timestamppb.Timestamp `protobuf:"bytes,4,opt,name=create_time,json=createTime,proto3" json:"create_time,omitempty"`
// Output only. The user whose credentials were used to create the LabelLock.
// This will not be present if no user was responsible for creating the
// LabelLock.
Creator *UserInfo `protobuf:"bytes,5,opt,name=creator,proto3" json:"creator,omitempty"`
// Output only. A timestamp indicating when this LabelLock was scheduled for
// deletion. This will be present only if this LabelLock is in the DELETING
// state.
DeleteTime *timestamppb.Timestamp `protobuf:"bytes,6,opt,name=delete_time,json=deleteTime,proto3" json:"delete_time,omitempty"`
// Output only. The user's capabilities on this LabelLock.
Capabilities *LabelLock_Capabilities `protobuf:"bytes,8,opt,name=capabilities,proto3" json:"capabilities,omitempty"`
// Output only. This LabelLock's state.
State LabelLock_State `protobuf:"varint,9,opt,name=state,proto3,enum=google.apps.drive.labels.v2beta.LabelLock_State" json:"state,omitempty"`
// contains filtered or unexported fields
}
func (*LabelLock) Descriptor() ([]byte, []int)
Deprecated: Use LabelLock.ProtoReflect.Descriptor instead.
func (x *LabelLock) GetCapabilities() *LabelLock_Capabilities
func (x *LabelLock) GetChoiceId() string
func (x *LabelLock) GetCreateTime() *timestamppb.Timestamp
func (x *LabelLock) GetCreator() *UserInfo
func (x *LabelLock) GetDeleteTime() *timestamppb.Timestamp
func (x *LabelLock) GetFieldId() string
func (x *LabelLock) GetName() string
func (x *LabelLock) GetState() LabelLock_State
func (*LabelLock) ProtoMessage()
func (x *LabelLock) ProtoReflect() protoreflect.Message
func (x *LabelLock) Reset()
func (x *LabelLock) String() string
A description of a user's capabilities on a LabelLock.
type LabelLock_Capabilities struct {
// True if the user is authorized to view the policy.
CanViewPolicy bool `protobuf:"varint,1,opt,name=can_view_policy,json=canViewPolicy,proto3" json:"can_view_policy,omitempty"`
// contains filtered or unexported fields
}
func (*LabelLock_Capabilities) Descriptor() ([]byte, []int)
Deprecated: Use LabelLock_Capabilities.ProtoReflect.Descriptor instead.
func (x *LabelLock_Capabilities) GetCanViewPolicy() bool
func (*LabelLock_Capabilities) ProtoMessage()
func (x *LabelLock_Capabilities) ProtoReflect() protoreflect.Message
func (x *LabelLock_Capabilities) Reset()
func (x *LabelLock_Capabilities) String() string
A description of a LabelLock's state.
type LabelLock_State int32
const (
// Unknown state.
LabelLock_STATE_UNSPECIFIED LabelLock_State = 0
// The LabelLock is active and is being enforced by the server.
LabelLock_ACTIVE LabelLock_State = 1
// The LabelLock is being deleted. The LabelLock will continue to be
// enforced by the server until it has been fully removed.
LabelLock_DELETING LabelLock_State = 2
)
func (LabelLock_State) Descriptor() protoreflect.EnumDescriptor
func (x LabelLock_State) Enum() *LabelLock_State
func (LabelLock_State) EnumDescriptor() ([]byte, []int)
Deprecated: Use LabelLock_State.Descriptor instead.
func (x LabelLock_State) Number() protoreflect.EnumNumber
func (x LabelLock_State) String() string
func (LabelLock_State) Type() protoreflect.EnumType
The permission that applies to a principal (user, group, audience) on a label.
type LabelPermission struct {
// The principal this permission applies to. Must be either an email, user,
// group, or audience.
// Example:
// * people/12345
// * groups/45678
// * audiences/default
//
// Types that are assignable to Principal:
//
// *LabelPermission_Person
// *LabelPermission_Group
// *LabelPermission_Audience
Principal isLabelPermission_Principal `protobuf_oneof:"principal"`
// Resource name of this permission.
Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
// Specifies the email address for a user or group pricinpal. Not populated
// for audience principals. User and Group permissions may only be inserted
// using email address. On update requests, if email address is specified,
// no principal should be specified.
Email string `protobuf:"bytes,2,opt,name=email,proto3" json:"email,omitempty"`
// The role the principal should have.
Role LabelPermission_LabelRole `protobuf:"varint,6,opt,name=role,proto3,enum=google.apps.drive.labels.v2beta.LabelPermission_LabelRole" json:"role,omitempty"`
// contains filtered or unexported fields
}
func (*LabelPermission) Descriptor() ([]byte, []int)
Deprecated: Use LabelPermission.ProtoReflect.Descriptor instead.
func (x *LabelPermission) GetAudience() string
func (x *LabelPermission) GetEmail() string
func (x *LabelPermission) GetGroup() string
func (x *LabelPermission) GetName() string
func (x *LabelPermission) GetPerson() string
func (m *LabelPermission) GetPrincipal() isLabelPermission_Principal
func (x *LabelPermission) GetRole() LabelPermission_LabelRole
func (*LabelPermission) ProtoMessage()
func (x *LabelPermission) ProtoReflect() protoreflect.Message
func (x *LabelPermission) Reset()
func (x *LabelPermission) String() string
type LabelPermission_Audience struct {
// Audience to grant a role to. The magic value of `audiences/default` may
// be used to apply the role to the default audience in the context of the
// organization that owns the Label.
Audience string `protobuf:"bytes,5,opt,name=audience,proto3,oneof"`
}
type LabelPermission_Group struct {
// Group resource name.
Group string `protobuf:"bytes,4,opt,name=group,proto3,oneof"`
}
Roles are concentric with subsequent role.
type LabelPermission_LabelRole int32
const (
// Unknown role.
LabelPermission_LABEL_ROLE_UNSPECIFIED LabelPermission_LabelRole = 0
// A reader can read the label and associated metadata applied to Drive
// items.
LabelPermission_READER LabelPermission_LabelRole = 1
// An applier can write associated metadata on Drive items in which they
// also have write access to. Implies `READER`.
LabelPermission_APPLIER LabelPermission_LabelRole = 2
// An organizer can pin this label in shared drives they manage
// and add new appliers to the label.
LabelPermission_ORGANIZER LabelPermission_LabelRole = 3
// Editors can make any update including deleting the label which
// also deletes the associated Drive item metadata. Implies `APPLIER`.
LabelPermission_EDITOR LabelPermission_LabelRole = 4
)
func (LabelPermission_LabelRole) Descriptor() protoreflect.EnumDescriptor
func (x LabelPermission_LabelRole) Enum() *LabelPermission_LabelRole
func (LabelPermission_LabelRole) EnumDescriptor() ([]byte, []int)
Deprecated: Use LabelPermission_LabelRole.Descriptor instead.
func (x LabelPermission_LabelRole) Number() protoreflect.EnumNumber
func (x LabelPermission_LabelRole) String() string
func (LabelPermission_LabelRole) Type() protoreflect.EnumType
type LabelPermission_Person struct {
// Person resource name.
Person string `protobuf:"bytes,3,opt,name=person,proto3,oneof"`
}
LabelServiceClient is the client API for LabelService service.
For semantics around ctx use and closing/ending streaming RPCs, please refer to https://godoc.org/google.golang.org/grpc#ClientConn.NewStream.
type LabelServiceClient interface {
// Gets the user capabilities.
GetUserCapabilities(ctx context.Context, in *GetUserCapabilitiesRequest, opts ...grpc.CallOption) (*UserCapabilities, error)
// List labels.
ListLabels(ctx context.Context, in *ListLabelsRequest, opts ...grpc.CallOption) (*ListLabelsResponse, error)
// Get a label by its resource name.
// Resource name may be any of:
//
// - `labels/{id}` - See `labels/{id}@latest`
// - `labels/{id}@latest` - Gets the latest revision of the label.
// - `labels/{id}@published` - Gets the current published revision of the
// label.
// - `labels/{id}@{revision_id}` - Gets the label at the specified revision
// ID.
GetLabel(ctx context.Context, in *GetLabelRequest, opts ...grpc.CallOption) (*Label, error)
// Get the constraints on the structure of a Label; such as, the maximum
// number of Fields allowed and maximum length of the label title.
GetLabelLimits(ctx context.Context, in *GetLabelLimitsRequest, opts ...grpc.CallOption) (*LabelLimits, error)
// Creates a new Label.
CreateLabel(ctx context.Context, in *CreateLabelRequest, opts ...grpc.CallOption) (*Label, error)
// Updates a single Label by applying a set of update requests resulting in a
// new draft revision. The batch update is all-or-nothing: If any of the
// update requests are invalid, no changes are applied. The resulting draft
// revision must be published before the changes may be used with Drive Items.
DeltaUpdateLabel(ctx context.Context, in *DeltaUpdateLabelRequest, opts ...grpc.CallOption) (*DeltaUpdateLabelResponse, error)
// Updates a Label's `CopyMode`. Changes to this policy are not revisioned, do
// not require publishing, and take effect immediately.
UpdateLabelCopyMode(ctx context.Context, in *UpdateLabelCopyModeRequest, opts ...grpc.CallOption) (*Label, error)
// Publish all draft changes to the Label. Once published, the Label may not
// return to its draft state. See
// `google.apps.drive.labels.v2.Lifecycle` for more information.
//
// Publishing a Label will result in a new published revision. All previous
// draft revisions will be deleted. Previous published revisions will be kept
// but are subject to automated deletion as needed.
//
// Once published, some changes are no longer permitted. Generally, any change
// that would invalidate or cause new restrictions on existing metadata
// related to the Label will be rejected. For example, the following changes
// to a Label will be rejected after the Label is published:
// - The label cannot be directly deleted. It must be disabled first, then
// deleted.
// - Field.FieldType cannot be changed.
// - Changes to Field validation options cannot reject something that was
// previously accepted.
// - Reducing the max entries.
PublishLabel(ctx context.Context, in *PublishLabelRequest, opts ...grpc.CallOption) (*Label, error)
// Disable a published Label.
// Disabling a Label will result in a new disabled published revision based on
// the current published revision. If there is a draft revision, a new
// disabled draft revision will be created based on the latest draft revision.
// Older draft revisions will be deleted.
//
// Once disabled, a label may be deleted with `DeleteLabel`.
DisableLabel(ctx context.Context, in *DisableLabelRequest, opts ...grpc.CallOption) (*Label, error)
// Enable a disabled Label and restore it to its published state.
// This will result in a new published revision based on the current disabled
// published revision. If there is an existing disabled draft revision, a new
// revision will be created based on that draft and will be enabled.
EnableLabel(ctx context.Context, in *EnableLabelRequest, opts ...grpc.CallOption) (*Label, error)
// Permanently deletes a Label and related metadata on Drive Items.
//
// Once deleted, the Label and related Drive item metadata will be deleted.
// Only draft Labels, and disabled Labels may be deleted.
DeleteLabel(ctx context.Context, in *DeleteLabelRequest, opts ...grpc.CallOption) (*emptypb.Empty, error)
// Lists a Label's permissions.
ListLabelPermissions(ctx context.Context, in *ListLabelPermissionsRequest, opts ...grpc.CallOption) (*ListLabelPermissionsResponse, error)
// Updates a Label's permissions. If a permission for the indicated principal
// doesn't exist, a new Label Permission is created, otherwise the existing
// permission is updated. Permissions affect the Label resource as a whole,
// are not revisioned, and do not require publishing.
CreateLabelPermission(ctx context.Context, in *CreateLabelPermissionRequest, opts ...grpc.CallOption) (*LabelPermission, error)
// Updates a Label's permissions. If a permission for the indicated principal
// doesn't exist, a new Label Permission is created, otherwise the existing
// permission is updated. Permissions affect the Label resource as a whole,
// are not revisioned, and do not require publishing.
UpdateLabelPermission(ctx context.Context, in *UpdateLabelPermissionRequest, opts ...grpc.CallOption) (*LabelPermission, error)
// Deletes a Label's permission. Permissions affect the Label resource as a
// whole, are not revisioned, and do not require publishing.
DeleteLabelPermission(ctx context.Context, in *DeleteLabelPermissionRequest, opts ...grpc.CallOption) (*emptypb.Empty, error)
// Updates Label permissions. If a permission for the
// indicated principal doesn't exist, a new Label Permission is created,
// otherwise the existing permission is updated. Permissions affect the Label
// resource as a whole, are not revisioned, and do not require publishing.
BatchUpdateLabelPermissions(ctx context.Context, in *BatchUpdateLabelPermissionsRequest, opts ...grpc.CallOption) (*BatchUpdateLabelPermissionsResponse, error)
// Deletes Label permissions. Permissions affect the Label resource as a
// whole, are not revisioned, and do not require publishing.
BatchDeleteLabelPermissions(ctx context.Context, in *BatchDeleteLabelPermissionsRequest, opts ...grpc.CallOption) (*emptypb.Empty, error)
// Lists the LabelLocks on a Label.
ListLabelLocks(ctx context.Context, in *ListLabelLocksRequest, opts ...grpc.CallOption) (*ListLabelLocksResponse, error)
}
func NewLabelServiceClient(cc grpc.ClientConnInterface) LabelServiceClient
LabelServiceServer is the server API for LabelService service.
type LabelServiceServer interface {
// Gets the user capabilities.
GetUserCapabilities(context.Context, *GetUserCapabilitiesRequest) (*UserCapabilities, error)
// List labels.
ListLabels(context.Context, *ListLabelsRequest) (*ListLabelsResponse, error)
// Get a label by its resource name.
// Resource name may be any of:
//
// - `labels/{id}` - See `labels/{id}@latest`
// - `labels/{id}@latest` - Gets the latest revision of the label.
// - `labels/{id}@published` - Gets the current published revision of the
// label.
// - `labels/{id}@{revision_id}` - Gets the label at the specified revision
// ID.
GetLabel(context.Context, *GetLabelRequest) (*Label, error)
// Get the constraints on the structure of a Label; such as, the maximum
// number of Fields allowed and maximum length of the label title.
GetLabelLimits(context.Context, *GetLabelLimitsRequest) (*LabelLimits, error)
// Creates a new Label.
CreateLabel(context.Context, *CreateLabelRequest) (*Label, error)
// Updates a single Label by applying a set of update requests resulting in a
// new draft revision. The batch update is all-or-nothing: If any of the
// update requests are invalid, no changes are applied. The resulting draft
// revision must be published before the changes may be used with Drive Items.
DeltaUpdateLabel(context.Context, *DeltaUpdateLabelRequest) (*DeltaUpdateLabelResponse, error)
// Updates a Label's `CopyMode`. Changes to this policy are not revisioned, do
// not require publishing, and take effect immediately.
UpdateLabelCopyMode(context.Context, *UpdateLabelCopyModeRequest) (*Label, error)
// Publish all draft changes to the Label. Once published, the Label may not
// return to its draft state. See
// `google.apps.drive.labels.v2.Lifecycle` for more information.
//
// Publishing a Label will result in a new published revision. All previous
// draft revisions will be deleted. Previous published revisions will be kept
// but are subject to automated deletion as needed.
//
// Once published, some changes are no longer permitted. Generally, any change
// that would invalidate or cause new restrictions on existing metadata
// related to the Label will be rejected. For example, the following changes
// to a Label will be rejected after the Label is published:
// - The label cannot be directly deleted. It must be disabled first, then
// deleted.
// - Field.FieldType cannot be changed.
// - Changes to Field validation options cannot reject something that was
// previously accepted.
// - Reducing the max entries.
PublishLabel(context.Context, *PublishLabelRequest) (*Label, error)
// Disable a published Label.
// Disabling a Label will result in a new disabled published revision based on
// the current published revision. If there is a draft revision, a new
// disabled draft revision will be created based on the latest draft revision.
// Older draft revisions will be deleted.
//
// Once disabled, a label may be deleted with `DeleteLabel`.
DisableLabel(context.Context, *DisableLabelRequest) (*Label, error)
// Enable a disabled Label and restore it to its published state.
// This will result in a new published revision based on the current disabled
// published revision. If there is an existing disabled draft revision, a new
// revision will be created based on that draft and will be enabled.
EnableLabel(context.Context, *EnableLabelRequest) (*Label, error)
// Permanently deletes a Label and related metadata on Drive Items.
//
// Once deleted, the Label and related Drive item metadata will be deleted.
// Only draft Labels, and disabled Labels may be deleted.
DeleteLabel(context.Context, *DeleteLabelRequest) (*emptypb.Empty, error)
// Lists a Label's permissions.
ListLabelPermissions(context.Context, *ListLabelPermissionsRequest) (*ListLabelPermissionsResponse, error)
// Updates a Label's permissions. If a permission for the indicated principal
// doesn't exist, a new Label Permission is created, otherwise the existing
// permission is updated. Permissions affect the Label resource as a whole,
// are not revisioned, and do not require publishing.
CreateLabelPermission(context.Context, *CreateLabelPermissionRequest) (*LabelPermission, error)
// Updates a Label's permissions. If a permission for the indicated principal
// doesn't exist, a new Label Permission is created, otherwise the existing
// permission is updated. Permissions affect the Label resource as a whole,
// are not revisioned, and do not require publishing.
UpdateLabelPermission(context.Context, *UpdateLabelPermissionRequest) (*LabelPermission, error)
// Deletes a Label's permission. Permissions affect the Label resource as a
// whole, are not revisioned, and do not require publishing.
DeleteLabelPermission(context.Context, *DeleteLabelPermissionRequest) (*emptypb.Empty, error)
// Updates Label permissions. If a permission for the
// indicated principal doesn't exist, a new Label Permission is created,
// otherwise the existing permission is updated. Permissions affect the Label
// resource as a whole, are not revisioned, and do not require publishing.
BatchUpdateLabelPermissions(context.Context, *BatchUpdateLabelPermissionsRequest) (*BatchUpdateLabelPermissionsResponse, error)
// Deletes Label permissions. Permissions affect the Label resource as a
// whole, are not revisioned, and do not require publishing.
BatchDeleteLabelPermissions(context.Context, *BatchDeleteLabelPermissionsRequest) (*emptypb.Empty, error)
// Lists the LabelLocks on a Label.
ListLabelLocks(context.Context, *ListLabelLocksRequest) (*ListLabelLocksResponse, error)
}
Resource view that can be applied to label responses. The default value `LABEL_VIEW_BASIC` implies the field mask: `name,id,revision_id,label_type,properties.*`\
type LabelView int32
const (
// Implies the field mask:
// `name,id,revision_id,label_type,properties.*`
LabelView_LABEL_VIEW_BASIC LabelView = 0
// All possible fields.
LabelView_LABEL_VIEW_FULL LabelView = 1
)
func (LabelView) Descriptor() protoreflect.EnumDescriptor
func (x LabelView) Enum() *LabelView
func (LabelView) EnumDescriptor() ([]byte, []int)
Deprecated: Use LabelView.Descriptor instead.
func (x LabelView) Number() protoreflect.EnumNumber
func (x LabelView) String() string
func (LabelView) Type() protoreflect.EnumType
The capabilities a user has on this label's applied metadata.
type Label_AppliedCapabilities struct {
// Whether the user can read applied metadata related to this label.
CanRead bool `protobuf:"varint,1,opt,name=can_read,json=canRead,proto3" json:"can_read,omitempty"`
// Whether the user can apply this label to items.
CanApply bool `protobuf:"varint,2,opt,name=can_apply,json=canApply,proto3" json:"can_apply,omitempty"`
// Whether the user can remove this label from items.
CanRemove bool `protobuf:"varint,3,opt,name=can_remove,json=canRemove,proto3" json:"can_remove,omitempty"`
// contains filtered or unexported fields
}
func (*Label_AppliedCapabilities) Descriptor() ([]byte, []int)
Deprecated: Use Label_AppliedCapabilities.ProtoReflect.Descriptor instead.
func (x *Label_AppliedCapabilities) GetCanApply() bool
func (x *Label_AppliedCapabilities) GetCanRead() bool
func (x *Label_AppliedCapabilities) GetCanRemove() bool
func (*Label_AppliedCapabilities) ProtoMessage()
func (x *Label_AppliedCapabilities) ProtoReflect() protoreflect.Message
func (x *Label_AppliedCapabilities) Reset()
func (x *Label_AppliedCapabilities) String() string
Behavior of this label when it's applied to Drive items.
type Label_AppliedLabelPolicy struct {
// Indicates how the applied label and field values should be copied when
// a Drive item is copied.
CopyMode Label_AppliedLabelPolicy_CopyMode `protobuf:"varint,1,opt,name=copy_mode,json=copyMode,proto3,enum=google.apps.drive.labels.v2beta.Label_AppliedLabelPolicy_CopyMode" json:"copy_mode,omitempty"`
// contains filtered or unexported fields
}
func (*Label_AppliedLabelPolicy) Descriptor() ([]byte, []int)
Deprecated: Use Label_AppliedLabelPolicy.ProtoReflect.Descriptor instead.
func (x *Label_AppliedLabelPolicy) GetCopyMode() Label_AppliedLabelPolicy_CopyMode
func (*Label_AppliedLabelPolicy) ProtoMessage()
func (x *Label_AppliedLabelPolicy) ProtoReflect() protoreflect.Message
func (x *Label_AppliedLabelPolicy) Reset()
func (x *Label_AppliedLabelPolicy) String() string
Indicates how the applied label and field values should be copied when a Drive item is copied.
type Label_AppliedLabelPolicy_CopyMode int32
const (
// Copy mode unspecified.
Label_AppliedLabelPolicy_COPY_MODE_UNSPECIFIED Label_AppliedLabelPolicy_CopyMode = 0
// The applied label and field values are not copied by default when
// the Drive item it's applied to is copied.
Label_AppliedLabelPolicy_DO_NOT_COPY Label_AppliedLabelPolicy_CopyMode = 1
// The applied label and field values are always copied when the
// Drive item it's applied to is copied.
// Only admins can use this mode.
Label_AppliedLabelPolicy_ALWAYS_COPY Label_AppliedLabelPolicy_CopyMode = 2
// The applied label and field values are copied if the
// label is appliable by the user making the copy.
Label_AppliedLabelPolicy_COPY_APPLIABLE Label_AppliedLabelPolicy_CopyMode = 3
)
func (Label_AppliedLabelPolicy_CopyMode) Descriptor() protoreflect.EnumDescriptor
func (x Label_AppliedLabelPolicy_CopyMode) Enum() *Label_AppliedLabelPolicy_CopyMode
func (Label_AppliedLabelPolicy_CopyMode) EnumDescriptor() ([]byte, []int)
Deprecated: Use Label_AppliedLabelPolicy_CopyMode.Descriptor instead.
func (x Label_AppliedLabelPolicy_CopyMode) Number() protoreflect.EnumNumber
func (x Label_AppliedLabelPolicy_CopyMode) String() string
func (Label_AppliedLabelPolicy_CopyMode) Type() protoreflect.EnumType
UI display hints for rendering the label.
type Label_DisplayHints struct {
// Whether the label should be shown in the UI as disabled.
Disabled bool `protobuf:"varint,1,opt,name=disabled,proto3" json:"disabled,omitempty"`
// This label should be hidden in the search menu when searching for Drive
// items.
HiddenInSearch bool `protobuf:"varint,2,opt,name=hidden_in_search,json=hiddenInSearch,proto3" json:"hidden_in_search,omitempty"`
// This label should be shown in the apply menu when applying values to a
// Drive item.
ShownInApply bool `protobuf:"varint,3,opt,name=shown_in_apply,json=shownInApply,proto3" json:"shown_in_apply,omitempty"`
// Order to display label in a list.
Priority int64 `protobuf:"varint,4,opt,name=priority,proto3" json:"priority,omitempty"`
// contains filtered or unexported fields
}
func (*Label_DisplayHints) Descriptor() ([]byte, []int)
Deprecated: Use Label_DisplayHints.ProtoReflect.Descriptor instead.
func (x *Label_DisplayHints) GetDisabled() bool
func (x *Label_DisplayHints) GetHiddenInSearch() bool
func (x *Label_DisplayHints) GetPriority() int64
func (x *Label_DisplayHints) GetShownInApply() bool
func (*Label_DisplayHints) ProtoMessage()
func (x *Label_DisplayHints) ProtoReflect() protoreflect.Message
func (x *Label_DisplayHints) Reset()
func (x *Label_DisplayHints) String() string
The type of this label.
type Label_LabelType int32
const (
// Unknown label type.
Label_LABEL_TYPE_UNSPECIFIED Label_LabelType = 0
// Shared labels may be shared with users to apply to Drive items.
Label_SHARED Label_LabelType = 1
// Admin-owned label. Only creatable and editable by admins. Supports some
// additional admin-only features.
Label_ADMIN Label_LabelType = 2
// A label owned by an internal Google application rather than a customer.
// These labels are read-only.
Label_GOOGLE_APP Label_LabelType = 3
)
func (Label_LabelType) Descriptor() protoreflect.EnumDescriptor
func (x Label_LabelType) Enum() *Label_LabelType
func (Label_LabelType) EnumDescriptor() ([]byte, []int)
Deprecated: Use Label_LabelType.Descriptor instead.
func (x Label_LabelType) Number() protoreflect.EnumNumber
func (x Label_LabelType) String() string
func (Label_LabelType) Type() protoreflect.EnumType
Basic properties of the label.
type Label_Properties struct {
// Required. Title of the label.
Title string `protobuf:"bytes,1,opt,name=title,proto3" json:"title,omitempty"`
// The description of the label.
Description string `protobuf:"bytes,2,opt,name=description,proto3" json:"description,omitempty"`
// contains filtered or unexported fields
}
func (*Label_Properties) Descriptor() ([]byte, []int)
Deprecated: Use Label_Properties.ProtoReflect.Descriptor instead.
func (x *Label_Properties) GetDescription() string
func (x *Label_Properties) GetTitle() string
func (*Label_Properties) ProtoMessage()
func (x *Label_Properties) ProtoReflect() protoreflect.Message
func (x *Label_Properties) Reset()
func (x *Label_Properties) String() string
The capabilities related to this label when editing the label.
type Label_SchemaCapabilities struct {
// Whether the user can change this label.
CanUpdate bool `protobuf:"varint,1,opt,name=can_update,json=canUpdate,proto3" json:"can_update,omitempty"`
// Whether the user can delete this label.
// The user must have permission and the label must be disabled.
CanDelete bool `protobuf:"varint,2,opt,name=can_delete,json=canDelete,proto3" json:"can_delete,omitempty"`
// Whether the user can disable this label.
// The user must have permission and this label must not already be
// disabled.
CanDisable bool `protobuf:"varint,3,opt,name=can_disable,json=canDisable,proto3" json:"can_disable,omitempty"`
// Whether the user can enable this label.
// The user must have permission and this label must be disabled.
CanEnable bool `protobuf:"varint,4,opt,name=can_enable,json=canEnable,proto3" json:"can_enable,omitempty"`
// contains filtered or unexported fields
}
func (*Label_SchemaCapabilities) Descriptor() ([]byte, []int)
Deprecated: Use Label_SchemaCapabilities.ProtoReflect.Descriptor instead.
func (x *Label_SchemaCapabilities) GetCanDelete() bool
func (x *Label_SchemaCapabilities) GetCanDisable() bool
func (x *Label_SchemaCapabilities) GetCanEnable() bool
func (x *Label_SchemaCapabilities) GetCanUpdate() bool
func (*Label_SchemaCapabilities) ProtoMessage()
func (x *Label_SchemaCapabilities) ProtoReflect() protoreflect.Message
func (x *Label_SchemaCapabilities) Reset()
func (x *Label_SchemaCapabilities) String() string
The lifecycle state of an object, such as label, field, or choice. The lifecycle enforces the following transitions:
* `UNPUBLISHED_DRAFT` (starting state) * `UNPUBLISHED_DRAFT` -> `PUBLISHED` * `UNPUBLISHED_DRAFT` -> (Deleted) * `PUBLISHED` -> `DISABLED` * `DISABLED` -> `PUBLISHED` * `DISABLED` -> (Deleted)
The published and disabled states have some distinct characteristics:
type Lifecycle struct {
// Output only. The state of the object associated with this lifecycle.
State Lifecycle_State `protobuf:"varint,1,opt,name=state,proto3,enum=google.apps.drive.labels.v2beta.Lifecycle_State" json:"state,omitempty"`
// Output only. Whether the object associated with this lifecycle has
// unpublished changes.
HasUnpublishedChanges bool `protobuf:"varint,2,opt,name=has_unpublished_changes,json=hasUnpublishedChanges,proto3" json:"has_unpublished_changes,omitempty"`
// The policy that governs how to show a disabled label, field, or selection
// choice.
DisabledPolicy *Lifecycle_DisabledPolicy `protobuf:"bytes,3,opt,name=disabled_policy,json=disabledPolicy,proto3" json:"disabled_policy,omitempty"`
// contains filtered or unexported fields
}
func (*Lifecycle) Descriptor() ([]byte, []int)
Deprecated: Use Lifecycle.ProtoReflect.Descriptor instead.
func (x *Lifecycle) GetDisabledPolicy() *Lifecycle_DisabledPolicy
func (x *Lifecycle) GetHasUnpublishedChanges() bool
func (x *Lifecycle) GetState() Lifecycle_State
func (*Lifecycle) ProtoMessage()
func (x *Lifecycle) ProtoReflect() protoreflect.Message
func (x *Lifecycle) Reset()
func (x *Lifecycle) String() string
The policy that governs how to treat a disabled label, field, or selection choice in different contexts.
type Lifecycle_DisabledPolicy struct {
// Whether to hide this disabled object in the search menu for Drive items.
//
// * When `false`, the object is generally shown in the UI as disabled but
// it appears in the search results when searching for Drive items.
// - When `true`, the object is generally hidden in the UI when
// searching for Drive items.
HideInSearch bool `protobuf:"varint,1,opt,name=hide_in_search,json=hideInSearch,proto3" json:"hide_in_search,omitempty"`
// Whether to show this disabled object in the apply menu on Drive items.
//
// - When `true`, the object is generally shown in the UI as disabled
// and is unselectable.
// - When `false`, the object is generally hidden in the UI.
ShowInApply bool `protobuf:"varint,2,opt,name=show_in_apply,json=showInApply,proto3" json:"show_in_apply,omitempty"`
// contains filtered or unexported fields
}
func (*Lifecycle_DisabledPolicy) Descriptor() ([]byte, []int)
Deprecated: Use Lifecycle_DisabledPolicy.ProtoReflect.Descriptor instead.
func (x *Lifecycle_DisabledPolicy) GetHideInSearch() bool
func (x *Lifecycle_DisabledPolicy) GetShowInApply() bool
func (*Lifecycle_DisabledPolicy) ProtoMessage()
func (x *Lifecycle_DisabledPolicy) ProtoReflect() protoreflect.Message
func (x *Lifecycle_DisabledPolicy) Reset()
func (x *Lifecycle_DisabledPolicy) String() string
The state of the object associated with this lifecycle.
type Lifecycle_State int32
const (
// Unknown State.
Lifecycle_STATE_UNSPECIFIED Lifecycle_State = 0
// The initial state of an object. Once published, the object can never
// return to this state. Once an object is published, certain kinds of
// changes are no longer permitted.
Lifecycle_UNPUBLISHED_DRAFT Lifecycle_State = 1
// The object has been published. The object might have unpublished draft
// changes as indicated by `has_unpublished_changes`.
Lifecycle_PUBLISHED Lifecycle_State = 2
// The object has been published and has since been disabled. The object
// might have unpublished draft changes as indicated by
// `has_unpublished_changes`.
Lifecycle_DISABLED Lifecycle_State = 3
// The object has been deleted.
Lifecycle_DELETED Lifecycle_State = 4
)
func (Lifecycle_State) Descriptor() protoreflect.EnumDescriptor
func (x Lifecycle_State) Enum() *Lifecycle_State
func (Lifecycle_State) EnumDescriptor() ([]byte, []int)
Deprecated: Use Lifecycle_State.Descriptor instead.
func (x Lifecycle_State) Number() protoreflect.EnumNumber
func (x Lifecycle_State) String() string
func (Lifecycle_State) Type() protoreflect.EnumType
A request to list the LabelLocks on a Label.
type ListLabelLocksRequest struct {
// Required. Label on which Locks are applied.
// Format: labels/{label}
Parent string `protobuf:"bytes,1,opt,name=parent,proto3" json:"parent,omitempty"`
// Maximum number of Locks to return per page. Default: 100. Max: 200.
PageSize int32 `protobuf:"varint,2,opt,name=page_size,json=pageSize,proto3" json:"page_size,omitempty"`
// The token of the page to return.
PageToken string `protobuf:"bytes,3,opt,name=page_token,json=pageToken,proto3" json:"page_token,omitempty"`
// contains filtered or unexported fields
}
func (*ListLabelLocksRequest) Descriptor() ([]byte, []int)
Deprecated: Use ListLabelLocksRequest.ProtoReflect.Descriptor instead.
func (x *ListLabelLocksRequest) GetPageSize() int32
func (x *ListLabelLocksRequest) GetPageToken() string
func (x *ListLabelLocksRequest) GetParent() string
func (*ListLabelLocksRequest) ProtoMessage()
func (x *ListLabelLocksRequest) ProtoReflect() protoreflect.Message
func (x *ListLabelLocksRequest) Reset()
func (x *ListLabelLocksRequest) String() string
The response to a ListLabelLocksRequest.
type ListLabelLocksResponse struct {
// LabelLocks.
LabelLocks []*LabelLock `protobuf:"bytes,1,rep,name=label_locks,json=labelLocks,proto3" json:"label_locks,omitempty"`
// The token of the next page in the response.
NextPageToken string `protobuf:"bytes,2,opt,name=next_page_token,json=nextPageToken,proto3" json:"next_page_token,omitempty"`
// contains filtered or unexported fields
}
func (*ListLabelLocksResponse) Descriptor() ([]byte, []int)
Deprecated: Use ListLabelLocksResponse.ProtoReflect.Descriptor instead.
func (x *ListLabelLocksResponse) GetLabelLocks() []*LabelLock
func (x *ListLabelLocksResponse) GetNextPageToken() string
func (*ListLabelLocksResponse) ProtoMessage()
func (x *ListLabelLocksResponse) ProtoReflect() protoreflect.Message
func (x *ListLabelLocksResponse) Reset()
func (x *ListLabelLocksResponse) String() string
Request to list the permissions on a Label.
type ListLabelPermissionsRequest struct {
// Required. The parent Label resource name on which Label Permission are
// listed. Format: labels/{label}
Parent string `protobuf:"bytes,1,opt,name=parent,proto3" json:"parent,omitempty"`
// Set to `true` in order to use the user's admin credentials. The server will
// verify the user is an admin for the Label before allowing access.
UseAdminAccess bool `protobuf:"varint,2,opt,name=use_admin_access,json=useAdminAccess,proto3" json:"use_admin_access,omitempty"`
// Maximum number of permissions to return per page. Default: 50. Max: 200.
PageSize int32 `protobuf:"varint,3,opt,name=page_size,json=pageSize,proto3" json:"page_size,omitempty"`
// The token of the page to return.
PageToken string `protobuf:"bytes,4,opt,name=page_token,json=pageToken,proto3" json:"page_token,omitempty"`
// contains filtered or unexported fields
}
func (*ListLabelPermissionsRequest) Descriptor() ([]byte, []int)
Deprecated: Use ListLabelPermissionsRequest.ProtoReflect.Descriptor instead.
func (x *ListLabelPermissionsRequest) GetPageSize() int32
func (x *ListLabelPermissionsRequest) GetPageToken() string
func (x *ListLabelPermissionsRequest) GetParent() string
func (x *ListLabelPermissionsRequest) GetUseAdminAccess() bool
func (*ListLabelPermissionsRequest) ProtoMessage()
func (x *ListLabelPermissionsRequest) ProtoReflect() protoreflect.Message
func (x *ListLabelPermissionsRequest) Reset()
func (x *ListLabelPermissionsRequest) String() string
Response for listing the permissions on a Label.
type ListLabelPermissionsResponse struct {
// Label permissions.
LabelPermissions []*LabelPermission `protobuf:"bytes,1,rep,name=label_permissions,json=labelPermissions,proto3" json:"label_permissions,omitempty"`
// The token of the next page in the response.
NextPageToken string `protobuf:"bytes,2,opt,name=next_page_token,json=nextPageToken,proto3" json:"next_page_token,omitempty"`
// contains filtered or unexported fields
}
func (*ListLabelPermissionsResponse) Descriptor() ([]byte, []int)
Deprecated: Use ListLabelPermissionsResponse.ProtoReflect.Descriptor instead.
func (x *ListLabelPermissionsResponse) GetLabelPermissions() []*LabelPermission
func (x *ListLabelPermissionsResponse) GetNextPageToken() string
func (*ListLabelPermissionsResponse) ProtoMessage()
func (x *ListLabelPermissionsResponse) ProtoReflect() protoreflect.Message
func (x *ListLabelPermissionsResponse) Reset()
func (x *ListLabelPermissionsResponse) String() string
Request to list labels available to the current user.
type ListLabelsRequest struct {
// Types that are assignable to Access:
//
// *ListLabelsRequest_UseAdminAccess
// *ListLabelsRequest_MinimumRole
Access isListLabelsRequest_Access `protobuf_oneof:"access"`
// Whether to include only published labels in the results.
//
// - When `true`, only the current published label revisions are returned.
// Disabled labels are included. Returned label resource names
// reference the published revision (`labels/{id}/{revision_id}`).
// - When `false`, the current label revisions are returned, which might not
// be published. Returned label resource names don't reference a specific
// revision (`labels/{id}`).
PublishedOnly bool `protobuf:"varint,1,opt,name=published_only,json=publishedOnly,proto3" json:"published_only,omitempty"`
// The customer to scope this list request to.
// For example: "customers/abcd1234".
// If unset, will return all labels within the current customer.
Customer string `protobuf:"bytes,2,opt,name=customer,proto3" json:"customer,omitempty"`
// The BCP-47 language code to use for evaluating localized field labels.
// When not specified, values in the default configured language are used.
LanguageCode string `protobuf:"bytes,5,opt,name=language_code,json=languageCode,proto3" json:"language_code,omitempty"`
// Maximum number of labels to return per page. Default: 50. Max: 200.
PageSize int32 `protobuf:"varint,6,opt,name=page_size,json=pageSize,proto3" json:"page_size,omitempty"`
// The token of the page to return.
PageToken string `protobuf:"bytes,7,opt,name=page_token,json=pageToken,proto3" json:"page_token,omitempty"`
// When specified, only certain fields belonging to the indicated view are
// returned.
View LabelView `protobuf:"varint,8,opt,name=view,proto3,enum=google.apps.drive.labels.v2beta.LabelView" json:"view,omitempty"`
// contains filtered or unexported fields
}
func (*ListLabelsRequest) Descriptor() ([]byte, []int)
Deprecated: Use ListLabelsRequest.ProtoReflect.Descriptor instead.
func (m *ListLabelsRequest) GetAccess() isListLabelsRequest_Access
func (x *ListLabelsRequest) GetCustomer() string
func (x *ListLabelsRequest) GetLanguageCode() string
func (x *ListLabelsRequest) GetMinimumRole() LabelPermission_LabelRole
func (x *ListLabelsRequest) GetPageSize() int32
func (x *ListLabelsRequest) GetPageToken() string
func (x *ListLabelsRequest) GetPublishedOnly() bool
func (x *ListLabelsRequest) GetUseAdminAccess() bool
func (x *ListLabelsRequest) GetView() LabelView
func (*ListLabelsRequest) ProtoMessage()
func (x *ListLabelsRequest) ProtoReflect() protoreflect.Message
func (x *ListLabelsRequest) Reset()
func (x *ListLabelsRequest) String() string
type ListLabelsRequest_MinimumRole struct {
// Specifies the level of access the user must have on the returned Labels.
// The minimum role a user must have on a label.
// Defaults to `READER`.
MinimumRole LabelPermission_LabelRole `protobuf:"varint,4,opt,name=minimum_role,json=minimumRole,proto3,enum=google.apps.drive.labels.v2beta.LabelPermission_LabelRole,oneof"`
}
type ListLabelsRequest_UseAdminAccess struct {
// Set to `true` in order to use the user's admin credentials. This will
// return all Labels within the customer.
UseAdminAccess bool `protobuf:"varint,3,opt,name=use_admin_access,json=useAdminAccess,proto3,oneof"`
}
Response for listing Labels.
type ListLabelsResponse struct {
// Labels.
Labels []*Label `protobuf:"bytes,1,rep,name=labels,proto3" json:"labels,omitempty"`
// The token of the next page in the response.
NextPageToken string `protobuf:"bytes,2,opt,name=next_page_token,json=nextPageToken,proto3" json:"next_page_token,omitempty"`
// contains filtered or unexported fields
}
func (*ListLabelsResponse) Descriptor() ([]byte, []int)
Deprecated: Use ListLabelsResponse.ProtoReflect.Descriptor instead.
func (x *ListLabelsResponse) GetLabels() []*Label
func (x *ListLabelsResponse) GetNextPageToken() string
func (*ListLabelsResponse) ProtoMessage()
func (x *ListLabelsResponse) ProtoReflect() protoreflect.Message
func (x *ListLabelsResponse) Reset()
func (x *ListLabelsResponse) String() string
Limits for list-variant of a Field type.
type ListLimits struct {
// Maximum number of values allowed for the Field type.
MaxEntries int32 `protobuf:"varint,1,opt,name=max_entries,json=maxEntries,proto3" json:"max_entries,omitempty"`
// contains filtered or unexported fields
}
func (*ListLimits) Descriptor() ([]byte, []int)
Deprecated: Use ListLimits.ProtoReflect.Descriptor instead.
func (x *ListLimits) GetMaxEntries() int32
func (*ListLimits) ProtoMessage()
func (x *ListLimits) ProtoReflect() protoreflect.Message
func (x *ListLimits) Reset()
func (x *ListLimits) String() string
Contains information about whether a label component should be considered locked.
type LockStatus struct {
// Output only. Indicates whether this label component is the (direct) target
// of a LabelLock. A label component can be implicitly locked even if it's
// not the direct target of a LabelLock, in which case this field is set to
// false.
Locked bool `protobuf:"varint,1,opt,name=locked,proto3" json:"locked,omitempty"`
// contains filtered or unexported fields
}
func (*LockStatus) Descriptor() ([]byte, []int)
Deprecated: Use LockStatus.ProtoReflect.Descriptor instead.
func (x *LockStatus) GetLocked() bool
func (*LockStatus) ProtoMessage()
func (x *LockStatus) ProtoReflect() protoreflect.Message
func (x *LockStatus) Reset()
func (x *LockStatus) String() string
Limits for long text Field type.
type LongTextLimits struct {
// Minimum length allowed for a long text Field type.
MinLength int32 `protobuf:"varint,1,opt,name=min_length,json=minLength,proto3" json:"min_length,omitempty"`
// Maximum length allowed for a long text Field type.
MaxLength int32 `protobuf:"varint,2,opt,name=max_length,json=maxLength,proto3" json:"max_length,omitempty"`
// contains filtered or unexported fields
}
func (*LongTextLimits) Descriptor() ([]byte, []int)
Deprecated: Use LongTextLimits.ProtoReflect.Descriptor instead.
func (x *LongTextLimits) GetMaxLength() int32
func (x *LongTextLimits) GetMinLength() int32
func (*LongTextLimits) ProtoMessage()
func (x *LongTextLimits) ProtoReflect() protoreflect.Message
func (x *LongTextLimits) Reset()
func (x *LongTextLimits) String() string
Describes what preconditions have failed.
type PreconditionFailure struct {
// Describes all violations in a client request.
Violation []*PreconditionFailure_Violation `protobuf:"bytes,1,rep,name=violation,proto3" json:"violation,omitempty"`
// contains filtered or unexported fields
}
func (*PreconditionFailure) Descriptor() ([]byte, []int)
Deprecated: Use PreconditionFailure.ProtoReflect.Descriptor instead.
func (x *PreconditionFailure) GetViolation() []*PreconditionFailure_Violation
func (*PreconditionFailure) ProtoMessage()
func (x *PreconditionFailure) ProtoReflect() protoreflect.Message
func (x *PreconditionFailure) Reset()
func (x *PreconditionFailure) String() string
Specific failure reason.
type PreconditionFailure_Violation struct {
// The path to the field where this violation occurred. This path is
// specified using `FieldMask` format:
// https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#fieldmask
Field string `protobuf:"bytes,1,opt,name=field,proto3" json:"field,omitempty"`
// The type of this violation.
Reason PreconditionFailure_Violation_Reason `protobuf:"varint,2,opt,name=reason,proto3,enum=google.apps.drive.labels.v2beta.PreconditionFailure_Violation_Reason" json:"reason,omitempty"`
// A message that describes the violation. This message is intended to
// be shown to end users, and is localized into the requesting user's
// preferred language.
DisplayMessage string `protobuf:"bytes,3,opt,name=display_message,json=displayMessage,proto3" json:"display_message,omitempty"`
// contains filtered or unexported fields
}
func (*PreconditionFailure_Violation) Descriptor() ([]byte, []int)
Deprecated: Use PreconditionFailure_Violation.ProtoReflect.Descriptor instead.
func (x *PreconditionFailure_Violation) GetDisplayMessage() string
func (x *PreconditionFailure_Violation) GetField() string
func (x *PreconditionFailure_Violation) GetReason() PreconditionFailure_Violation_Reason
func (*PreconditionFailure_Violation) ProtoMessage()
func (x *PreconditionFailure_Violation) ProtoReflect() protoreflect.Message
func (x *PreconditionFailure_Violation) Reset()
func (x *PreconditionFailure_Violation) String() string
The possible reasons a the violation occurred.
type PreconditionFailure_Violation_Reason int32
const (
// Unknown violation type.
PreconditionFailure_Violation_REASON_UNSPECIFIED PreconditionFailure_Violation_Reason = 0
// This Resource cannot be Disabled. Only Published resources can be
// Disabled.
PreconditionFailure_Violation_CANNOT_DISABLE PreconditionFailure_Violation_Reason = 1
// This Resource cannot be Enabled. Only Disabled resources can be
// Enabled.
PreconditionFailure_Violation_CANNOT_ENABLE PreconditionFailure_Violation_Reason = 2
// This Resource cannot be Published. Only Draft or Disabled resources
// can be Published.
PreconditionFailure_Violation_CANNOT_PUBLISH PreconditionFailure_Violation_Reason = 3
// This Resource cannot be Unpublished. Once published, resources may
// not be set in "Draft" state.
PreconditionFailure_Violation_CANNOT_UNPUBLISH PreconditionFailure_Violation_Reason = 4
// This Resource cannot be Deleted. Only Disabled resources
// can be Deleted.
PreconditionFailure_Violation_CANNOT_DELETE PreconditionFailure_Violation_Reason = 5
// The request modified a range in a Field, but the new range does
// not include the previous range. When this error happens, `field` points
// at the Field where the violation occurred.
PreconditionFailure_Violation_CANNOT_RESTRICT_RANGE PreconditionFailure_Violation_Reason = 6
// The specified change cannot be made to published Resources.
PreconditionFailure_Violation_CANNOT_CHANGE_PUBLISHED_FIELD PreconditionFailure_Violation_Reason = 7
// The customer cannot create new labels because the maximum number
// of labels for the customer has been reached.
PreconditionFailure_Violation_CANNOT_CREATE_MORE_LABELS PreconditionFailure_Violation_Reason = 8
// The Field type cannot be changed because the Field has been published.
PreconditionFailure_Violation_CANNOT_CHANGE_PUBLISHED_FIELD_TYPE PreconditionFailure_Violation_Reason = 9
// The Label component is locked and cannot be modified
PreconditionFailure_Violation_CANNOT_MODIFY_LOCKED_COMPONENT PreconditionFailure_Violation_Reason = 10
)
func (PreconditionFailure_Violation_Reason) Descriptor() protoreflect.EnumDescriptor
func (x PreconditionFailure_Violation_Reason) Enum() *PreconditionFailure_Violation_Reason
func (PreconditionFailure_Violation_Reason) EnumDescriptor() ([]byte, []int)
Deprecated: Use PreconditionFailure_Violation_Reason.Descriptor instead.
func (x PreconditionFailure_Violation_Reason) Number() protoreflect.EnumNumber
func (x PreconditionFailure_Violation_Reason) String() string
func (PreconditionFailure_Violation_Reason) Type() protoreflect.EnumType
Request to publish a label.
type PublishLabelRequest struct {
// Required. Label resource name.
Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
// Set to `true` in order to use the user's admin credentials. The server
// will verify the user is an admin for the Label before allowing access.
UseAdminAccess bool `protobuf:"varint,2,opt,name=use_admin_access,json=useAdminAccess,proto3" json:"use_admin_access,omitempty"`
// Provides control over how write requests are executed. Defaults to unset,
// which means last write wins.
WriteControl *WriteControl `protobuf:"bytes,3,opt,name=write_control,json=writeControl,proto3" json:"write_control,omitempty"`
// The BCP-47 language code to use for evaluating localized field labels.
// When not specified, values in the default configured language will be used.
LanguageCode string `protobuf:"bytes,4,opt,name=language_code,json=languageCode,proto3" json:"language_code,omitempty"`
// contains filtered or unexported fields
}
func (*PublishLabelRequest) Descriptor() ([]byte, []int)
Deprecated: Use PublishLabelRequest.ProtoReflect.Descriptor instead.
func (x *PublishLabelRequest) GetLanguageCode() string
func (x *PublishLabelRequest) GetName() string
func (x *PublishLabelRequest) GetUseAdminAccess() bool
func (x *PublishLabelRequest) GetWriteControl() *WriteControl
func (*PublishLabelRequest) ProtoMessage()
func (x *PublishLabelRequest) ProtoReflect() protoreflect.Message
func (x *PublishLabelRequest) Reset()
func (x *PublishLabelRequest) String() string
Limits for selection Field type.
type SelectionLimits struct {
// Limits for list-variant of a Field type.
ListLimits *ListLimits `protobuf:"bytes,1,opt,name=list_limits,json=listLimits,proto3" json:"list_limits,omitempty"`
// Maximum ID length for a selection options.
MaxIdLength int32 `protobuf:"varint,2,opt,name=max_id_length,json=maxIdLength,proto3" json:"max_id_length,omitempty"`
// Maximum length for display name.
MaxDisplayNameLength int32 `protobuf:"varint,3,opt,name=max_display_name_length,json=maxDisplayNameLength,proto3" json:"max_display_name_length,omitempty"`
// The max number of choices.
MaxChoices int32 `protobuf:"varint,4,opt,name=max_choices,json=maxChoices,proto3" json:"max_choices,omitempty"`
// Maximum number of deleted choices.
MaxDeletedChoices int32 `protobuf:"varint,5,opt,name=max_deleted_choices,json=maxDeletedChoices,proto3" json:"max_deleted_choices,omitempty"`
// contains filtered or unexported fields
}
func (*SelectionLimits) Descriptor() ([]byte, []int)
Deprecated: Use SelectionLimits.ProtoReflect.Descriptor instead.
func (x *SelectionLimits) GetListLimits() *ListLimits
func (x *SelectionLimits) GetMaxChoices() int32
func (x *SelectionLimits) GetMaxDeletedChoices() int32
func (x *SelectionLimits) GetMaxDisplayNameLength() int32
func (x *SelectionLimits) GetMaxIdLength() int32
func (*SelectionLimits) ProtoMessage()
func (x *SelectionLimits) ProtoReflect() protoreflect.Message
func (x *SelectionLimits) Reset()
func (x *SelectionLimits) String() string
Limits for text Field type.
type TextLimits struct {
// Minimum length allowed for a text Field type.
MinLength int32 `protobuf:"varint,1,opt,name=min_length,json=minLength,proto3" json:"min_length,omitempty"`
// Maximum length allowed for a text Field type.
MaxLength int32 `protobuf:"varint,2,opt,name=max_length,json=maxLength,proto3" json:"max_length,omitempty"`
// contains filtered or unexported fields
}
func (*TextLimits) Descriptor() ([]byte, []int)
Deprecated: Use TextLimits.ProtoReflect.Descriptor instead.
func (x *TextLimits) GetMaxLength() int32
func (x *TextLimits) GetMinLength() int32
func (*TextLimits) ProtoMessage()
func (x *TextLimits) ProtoReflect() protoreflect.Message
func (x *TextLimits) Reset()
func (x *TextLimits) String() string
UnimplementedLabelServiceServer can be embedded to have forward compatible implementations.
type UnimplementedLabelServiceServer struct {
}
func (*UnimplementedLabelServiceServer) BatchDeleteLabelPermissions(context.Context, *BatchDeleteLabelPermissionsRequest) (*emptypb.Empty, error)
func (*UnimplementedLabelServiceServer) BatchUpdateLabelPermissions(context.Context, *BatchUpdateLabelPermissionsRequest) (*BatchUpdateLabelPermissionsResponse, error)
func (*UnimplementedLabelServiceServer) CreateLabel(context.Context, *CreateLabelRequest) (*Label, error)
func (*UnimplementedLabelServiceServer) CreateLabelPermission(context.Context, *CreateLabelPermissionRequest) (*LabelPermission, error)
func (*UnimplementedLabelServiceServer) DeleteLabel(context.Context, *DeleteLabelRequest) (*emptypb.Empty, error)
func (*UnimplementedLabelServiceServer) DeleteLabelPermission(context.Context, *DeleteLabelPermissionRequest) (*emptypb.Empty, error)
func (*UnimplementedLabelServiceServer) DeltaUpdateLabel(context.Context, *DeltaUpdateLabelRequest) (*DeltaUpdateLabelResponse, error)
func (*UnimplementedLabelServiceServer) DisableLabel(context.Context, *DisableLabelRequest) (*Label, error)
func (*UnimplementedLabelServiceServer) EnableLabel(context.Context, *EnableLabelRequest) (*Label, error)
func (*UnimplementedLabelServiceServer) GetLabel(context.Context, *GetLabelRequest) (*Label, error)
func (*UnimplementedLabelServiceServer) GetLabelLimits(context.Context, *GetLabelLimitsRequest) (*LabelLimits, error)
func (*UnimplementedLabelServiceServer) GetUserCapabilities(context.Context, *GetUserCapabilitiesRequest) (*UserCapabilities, error)
func (*UnimplementedLabelServiceServer) ListLabelLocks(context.Context, *ListLabelLocksRequest) (*ListLabelLocksResponse, error)
func (*UnimplementedLabelServiceServer) ListLabelPermissions(context.Context, *ListLabelPermissionsRequest) (*ListLabelPermissionsResponse, error)
func (*UnimplementedLabelServiceServer) ListLabels(context.Context, *ListLabelsRequest) (*ListLabelsResponse, error)
func (*UnimplementedLabelServiceServer) PublishLabel(context.Context, *PublishLabelRequest) (*Label, error)
func (*UnimplementedLabelServiceServer) UpdateLabelCopyMode(context.Context, *UpdateLabelCopyModeRequest) (*Label, error)
func (*UnimplementedLabelServiceServer) UpdateLabelPermission(context.Context, *UpdateLabelPermissionRequest) (*LabelPermission, error)
Request to update the `CopyMode` of the given Label. Changes to this policy are not revisioned, do not require publishing, and take effect immediately. \
type UpdateLabelCopyModeRequest struct {
// Required. The resource name of the Label to update.
Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
// Required. Indicates how the applied Label, and Field values should be copied
// when a Drive item is copied.
CopyMode Label_AppliedLabelPolicy_CopyMode `protobuf:"varint,2,opt,name=copy_mode,json=copyMode,proto3,enum=google.apps.drive.labels.v2beta.Label_AppliedLabelPolicy_CopyMode" json:"copy_mode,omitempty"`
// Set to `true` in order to use the user's admin credentials. The server
// will verify the user is an admin for the Label before allowing access.
UseAdminAccess bool `protobuf:"varint,3,opt,name=use_admin_access,json=useAdminAccess,proto3" json:"use_admin_access,omitempty"`
// The BCP-47 language code to use for evaluating localized field labels.
// When not specified, values in the default configured language will be used.
LanguageCode string `protobuf:"bytes,4,opt,name=language_code,json=languageCode,proto3" json:"language_code,omitempty"`
// When specified, only certain fields belonging to the indicated view will be
// returned.
View LabelView `protobuf:"varint,5,opt,name=view,proto3,enum=google.apps.drive.labels.v2beta.LabelView" json:"view,omitempty"`
// contains filtered or unexported fields
}
func (*UpdateLabelCopyModeRequest) Descriptor() ([]byte, []int)
Deprecated: Use UpdateLabelCopyModeRequest.ProtoReflect.Descriptor instead.
func (x *UpdateLabelCopyModeRequest) GetCopyMode() Label_AppliedLabelPolicy_CopyMode
func (x *UpdateLabelCopyModeRequest) GetLanguageCode() string
func (x *UpdateLabelCopyModeRequest) GetName() string
func (x *UpdateLabelCopyModeRequest) GetUseAdminAccess() bool
func (x *UpdateLabelCopyModeRequest) GetView() LabelView
func (*UpdateLabelCopyModeRequest) ProtoMessage()
func (x *UpdateLabelCopyModeRequest) ProtoReflect() protoreflect.Message
func (x *UpdateLabelCopyModeRequest) Reset()
func (x *UpdateLabelCopyModeRequest) String() string
Updates a Label Permission. Permissions affect the Label resource as a whole, are not revisioned, and do not require publishing.
type UpdateLabelPermissionRequest struct {
// Required. The parent Label resource name.
Parent string `protobuf:"bytes,1,opt,name=parent,proto3" json:"parent,omitempty"`
// Required. The permission to create or update on the Label.
LabelPermission *LabelPermission `protobuf:"bytes,2,opt,name=label_permission,json=labelPermission,proto3" json:"label_permission,omitempty"`
// Set to `true` in order to use the user's admin credentials. The server
// will verify the user is an admin for the Label before allowing access.
UseAdminAccess bool `protobuf:"varint,3,opt,name=use_admin_access,json=useAdminAccess,proto3" json:"use_admin_access,omitempty"`
// contains filtered or unexported fields
}
func (*UpdateLabelPermissionRequest) Descriptor() ([]byte, []int)
Deprecated: Use UpdateLabelPermissionRequest.ProtoReflect.Descriptor instead.
func (x *UpdateLabelPermissionRequest) GetLabelPermission() *LabelPermission
func (x *UpdateLabelPermissionRequest) GetParent() string
func (x *UpdateLabelPermissionRequest) GetUseAdminAccess() bool
func (*UpdateLabelPermissionRequest) ProtoMessage()
func (x *UpdateLabelPermissionRequest) ProtoReflect() protoreflect.Message
func (x *UpdateLabelPermissionRequest) Reset()
func (x *UpdateLabelPermissionRequest) String() string
The capabilities of a user.
type UserCapabilities struct {
// Output only. Resource name for the user capabilities.
Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
// Output only. Whether the user is allowed access to the label manager.
CanAccessLabelManager bool `protobuf:"varint,2,opt,name=can_access_label_manager,json=canAccessLabelManager,proto3" json:"can_access_label_manager,omitempty"`
// Output only. Whether the user is an administrator for the shared labels
// feature.
CanAdministrateLabels bool `protobuf:"varint,3,opt,name=can_administrate_labels,json=canAdministrateLabels,proto3" json:"can_administrate_labels,omitempty"`
// Output only. Whether the user is allowed to create new shared labels.
CanCreateSharedLabels bool `protobuf:"varint,4,opt,name=can_create_shared_labels,json=canCreateSharedLabels,proto3" json:"can_create_shared_labels,omitempty"`
// Output only. Whether the user is allowed to create new admin labels.
CanCreateAdminLabels bool `protobuf:"varint,5,opt,name=can_create_admin_labels,json=canCreateAdminLabels,proto3" json:"can_create_admin_labels,omitempty"`
// contains filtered or unexported fields
}
func (*UserCapabilities) Descriptor() ([]byte, []int)
Deprecated: Use UserCapabilities.ProtoReflect.Descriptor instead.
func (x *UserCapabilities) GetCanAccessLabelManager() bool
func (x *UserCapabilities) GetCanAdministrateLabels() bool
func (x *UserCapabilities) GetCanCreateAdminLabels() bool
func (x *UserCapabilities) GetCanCreateSharedLabels() bool
func (x *UserCapabilities) GetName() string
func (*UserCapabilities) ProtoMessage()
func (x *UserCapabilities) ProtoReflect() protoreflect.Message
func (x *UserCapabilities) Reset()
func (x *UserCapabilities) String() string
Information about a user.
type UserInfo struct {
// The identifier for this user that can be used with the People API to get
// more information.
// For example, people/12345678.
Person string `protobuf:"bytes,1,opt,name=person,proto3" json:"person,omitempty"`
// contains filtered or unexported fields
}
func (*UserInfo) Descriptor() ([]byte, []int)
Deprecated: Use UserInfo.ProtoReflect.Descriptor instead.
func (x *UserInfo) GetPerson() string
func (*UserInfo) ProtoMessage()
func (x *UserInfo) ProtoReflect() protoreflect.Message
func (x *UserInfo) Reset()
func (x *UserInfo) String() string
Limits for Field.Type.USER.
type UserLimits struct {
// Limits for list-variant of a Field type.
ListLimits *ListLimits `protobuf:"bytes,1,opt,name=list_limits,json=listLimits,proto3" json:"list_limits,omitempty"`
// contains filtered or unexported fields
}
func (*UserLimits) Descriptor() ([]byte, []int)
Deprecated: Use UserLimits.ProtoReflect.Descriptor instead.
func (x *UserLimits) GetListLimits() *ListLimits
func (*UserLimits) ProtoMessage()
func (x *UserLimits) ProtoReflect() protoreflect.Message
func (x *UserLimits) Reset()
func (x *UserLimits) String() string
Provides control over how write requests are executed. When not specified, the last write wins.
type WriteControl struct {
// Determines the revision of the label to write to and how the request
// should behave if that revision is not the current revision of the
// label.
//
// Types that are assignable to Control:
//
// *WriteControl_RequiredRevisionId
Control isWriteControl_Control `protobuf_oneof:"control"`
// contains filtered or unexported fields
}
func (*WriteControl) Descriptor() ([]byte, []int)
Deprecated: Use WriteControl.ProtoReflect.Descriptor instead.
func (m *WriteControl) GetControl() isWriteControl_Control
func (x *WriteControl) GetRequiredRevisionId() string
func (*WriteControl) ProtoMessage()
func (x *WriteControl) ProtoReflect() protoreflect.Message
func (x *WriteControl) Reset()
func (x *WriteControl) String() string
type WriteControl_RequiredRevisionId struct {
// The [revision_id][google.apps.drive.labels.v1.Label.revision_id] of the
// label that the write request will be applied to. If this is not the
// latest revision of the label, the request will not be processed and will
// return a 400 Bad Request error.
RequiredRevisionId string `protobuf:"bytes,1,opt,name=required_revision_id,json=requiredRevisionId,proto3,oneof"`
}