apipb

package
v0.3.0 Latest Latest
Warning

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

Go to latest
Published: Jan 8, 2026 License: Apache-2.0 Imports: 10 Imported by: 0

Documentation

Index

Constants

View Source
const (
	Maintenance_SummarizeMaintenances_FullMethodName    = "/google.cloud.maintenance.api.v1.Maintenance/SummarizeMaintenances"
	Maintenance_ListResourceMaintenances_FullMethodName = "/google.cloud.maintenance.api.v1.Maintenance/ListResourceMaintenances"
	Maintenance_GetResourceMaintenance_FullMethodName   = "/google.cloud.maintenance.api.v1.Maintenance/GetResourceMaintenance"
)

Variables

View Source
var (
	MaintenanceCategory_name = map[int32]string{
		0: "MAINTENANCE_CATEGORY_UNSPECIFIED",
		1: "INFRASTRUCTURE",
		3: "SERVICE_UPDATE",
	}
	MaintenanceCategory_value = map[string]int32{
		"MAINTENANCE_CATEGORY_UNSPECIFIED": 0,
		"INFRASTRUCTURE":                   1,
		"SERVICE_UPDATE":                   3,
	}
)

Enum value maps for MaintenanceCategory.

View Source
var (
	ResourceMaintenance_State_name = map[int32]string{
		0: "STATE_UNSPECIFIED",
		1: "SCHEDULED",
		2: "RUNNING",
		3: "CANCELLED",
		4: "SUCCEEDED",
	}
	ResourceMaintenance_State_value = map[string]int32{
		"STATE_UNSPECIFIED": 0,
		"SCHEDULED":         1,
		"RUNNING":           2,
		"CANCELLED":         3,
		"SUCCEEDED":         4,
	}
)

Enum value maps for ResourceMaintenance_State.

View Source
var (
	MaintenanceControl_Control_name = map[int32]string{
		0: "CONTROL_UNSPECIFIED",
		1: "APPLY",
		2: "MANAGE_POLICY",
		3: "RESCHEDULE",
	}
	MaintenanceControl_Control_value = map[string]int32{
		"CONTROL_UNSPECIFIED": 0,
		"APPLY":               1,
		"MANAGE_POLICY":       2,
		"RESCHEDULE":          3,
	}
)

Enum value maps for MaintenanceControl_Control.

View Source
var File_google_cloud_maintenance_api_v1_maintenance_service_proto protoreflect.FileDescriptor
View Source
var Maintenance_ServiceDesc = grpc.ServiceDesc{
	ServiceName: "google.cloud.maintenance.api.v1.Maintenance",
	HandlerType: (*MaintenanceServer)(nil),
	Methods: []grpc.MethodDesc{
		{
			MethodName: "SummarizeMaintenances",
			Handler:    _Maintenance_SummarizeMaintenances_Handler,
		},
		{
			MethodName: "ListResourceMaintenances",
			Handler:    _Maintenance_ListResourceMaintenances_Handler,
		},
		{
			MethodName: "GetResourceMaintenance",
			Handler:    _Maintenance_GetResourceMaintenance_Handler,
		},
	},
	Streams:  []grpc.StreamDesc{},
	Metadata: "google/cloud/maintenance/api/v1/maintenance_service.proto",
}

Maintenance_ServiceDesc is the grpc.ServiceDesc for Maintenance service. It's only intended for direct use with grpc.RegisterService, and not to be introspected or modified (even as a copy)

Functions

func RegisterMaintenanceServer

func RegisterMaintenanceServer(s grpc.ServiceRegistrar, srv MaintenanceServer)

Types

type GetResourceMaintenanceRequest

type GetResourceMaintenanceRequest struct {

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

The request structure for the GetResourceMaintenance method.

func (*GetResourceMaintenanceRequest) Descriptor deprecated

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

Deprecated: Use GetResourceMaintenanceRequest.ProtoReflect.Descriptor instead.

func (*GetResourceMaintenanceRequest) GetName

func (*GetResourceMaintenanceRequest) ProtoMessage

func (*GetResourceMaintenanceRequest) ProtoMessage()

func (*GetResourceMaintenanceRequest) ProtoReflect

func (*GetResourceMaintenanceRequest) Reset

func (x *GetResourceMaintenanceRequest) Reset()

func (*GetResourceMaintenanceRequest) String

type ListResourceMaintenancesRequest

type ListResourceMaintenancesRequest struct {

	// Required. The parent of the resource maintenance.
	Parent string `protobuf:"bytes,10006,opt,name=parent,proto3" json:"parent,omitempty"`
	// The maximum number of resource maintenances to send per page.
	PageSize int32 `protobuf:"varint,10505,opt,name=page_size,json=pageSize,proto3" json:"page_size,omitempty"`
	// The page token: If the next_page_token from a previous response
	// is provided, this request will send the subsequent page.
	PageToken string `protobuf:"bytes,10506,opt,name=page_token,json=pageToken,proto3" json:"page_token,omitempty"`
	// Filter the list as specified in https://google.aip.dev/160.
	Filter string `protobuf:"bytes,10507,opt,name=filter,proto3" json:"filter,omitempty"`
	// Order results as specified in https://google.aip.dev/132.
	OrderBy string `protobuf:"bytes,10508,opt,name=order_by,json=orderBy,proto3" json:"order_by,omitempty"`
	// contains filtered or unexported fields
}

The request structure for the ListResourceMaintenances method.

func (*ListResourceMaintenancesRequest) Descriptor deprecated

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

Deprecated: Use ListResourceMaintenancesRequest.ProtoReflect.Descriptor instead.

func (*ListResourceMaintenancesRequest) GetFilter

func (x *ListResourceMaintenancesRequest) GetFilter() string

func (*ListResourceMaintenancesRequest) GetOrderBy

func (x *ListResourceMaintenancesRequest) GetOrderBy() string

func (*ListResourceMaintenancesRequest) GetPageSize

func (x *ListResourceMaintenancesRequest) GetPageSize() int32

func (*ListResourceMaintenancesRequest) GetPageToken

func (x *ListResourceMaintenancesRequest) GetPageToken() string

func (*ListResourceMaintenancesRequest) GetParent

func (x *ListResourceMaintenancesRequest) GetParent() string

func (*ListResourceMaintenancesRequest) ProtoMessage

func (*ListResourceMaintenancesRequest) ProtoMessage()

func (*ListResourceMaintenancesRequest) ProtoReflect

func (*ListResourceMaintenancesRequest) Reset

func (*ListResourceMaintenancesRequest) String

type ListResourceMaintenancesResponse

type ListResourceMaintenancesResponse struct {

	// The resulting resource maintenances.
	ResourceMaintenances []*ResourceMaintenance `protobuf:"bytes,10509,rep,name=resource_maintenances,json=resourceMaintenances,proto3" json:"resource_maintenances,omitempty"`
	// If present, the next page token can be provided to a subsequent
	// ListResourceMaintenances call to list the next page.
	// If empty, there are no more pages.
	NextPageToken string `protobuf:"bytes,10510,opt,name=next_page_token,json=nextPageToken,proto3" json:"next_page_token,omitempty"`
	// Locations that could not be reached.
	Unreachable []string `protobuf:"bytes,10511,rep,name=unreachable,proto3" json:"unreachable,omitempty"`
	// contains filtered or unexported fields
}

The response structure for the ListResourceMaintenances method.

func (*ListResourceMaintenancesResponse) Descriptor deprecated

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

Deprecated: Use ListResourceMaintenancesResponse.ProtoReflect.Descriptor instead.

func (*ListResourceMaintenancesResponse) GetNextPageToken

func (x *ListResourceMaintenancesResponse) GetNextPageToken() string

func (*ListResourceMaintenancesResponse) GetResourceMaintenances

func (x *ListResourceMaintenancesResponse) GetResourceMaintenances() []*ResourceMaintenance

func (*ListResourceMaintenancesResponse) GetUnreachable

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

func (*ListResourceMaintenancesResponse) ProtoMessage

func (*ListResourceMaintenancesResponse) ProtoMessage()

func (*ListResourceMaintenancesResponse) ProtoReflect

func (*ListResourceMaintenancesResponse) Reset

func (*ListResourceMaintenancesResponse) String

type MaintenanceCategory

type MaintenanceCategory int32

The Category of the maintenance.

const (
	// Unspecified category.
	MaintenanceCategory_MAINTENANCE_CATEGORY_UNSPECIFIED MaintenanceCategory = 0
	// Infrastructure maintenance events are times that Google Cloud performs
	// regular maintenance on network equipment e.g. Google Cloud Interconnect
	// These events are usually scheduled in advance and we provide
	// notification, when possible, so that users can plan for the
	// infrastructure maintenance event and prevent downtime. Infrastructure
	// maintenance events don't have a set interval between occurrences, but
	// generally occur several times a year.
	MaintenanceCategory_INFRASTRUCTURE MaintenanceCategory = 1
	// Updates that can include bug fixes, changes, or new features that are
	// backward compatible with existing versions (including patches).
	// Some SPs allow users to control the scheduling of these maintenance
	// events using maintenance windows and/or deny maintenance features.
	MaintenanceCategory_SERVICE_UPDATE MaintenanceCategory = 3
)

func (MaintenanceCategory) Descriptor

func (MaintenanceCategory) Enum

func (MaintenanceCategory) EnumDescriptor deprecated

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

Deprecated: Use MaintenanceCategory.Descriptor instead.

func (MaintenanceCategory) Number

func (MaintenanceCategory) String

func (x MaintenanceCategory) String() string

func (MaintenanceCategory) Type

type MaintenanceClient

type MaintenanceClient interface {
	// Retrieves the statistics of a specific maintenance.
	SummarizeMaintenances(ctx context.Context, in *SummarizeMaintenancesRequest, opts ...grpc.CallOption) (*SummarizeMaintenancesResponse, error)
	// Retrieve a collection of resource maintenances.
	ListResourceMaintenances(ctx context.Context, in *ListResourceMaintenancesRequest, opts ...grpc.CallOption) (*ListResourceMaintenancesResponse, error)
	// Retrieve a single resource maintenance.
	GetResourceMaintenance(ctx context.Context, in *GetResourceMaintenanceRequest, opts ...grpc.CallOption) (*ResourceMaintenance, error)
}

MaintenanceClient is the client API for Maintenance service.

For semantics around ctx use and closing/ending streaming RPCs, please refer to https://pkg.go.dev/google.golang.org/grpc/?tab=doc#ClientConn.NewStream.

type MaintenanceControl

type MaintenanceControl struct {

	// The control of the resource maintenance.
	Control MaintenanceControl_Control `` /* 132-byte string literal not displayed */
	// Indicates whether the control is available only in Service Producer API
	// (not through Unified Maintenance).
	IsCustom bool `protobuf:"varint,2,opt,name=is_custom,json=isCustom,proto3" json:"is_custom,omitempty"`
	// Link to Service Producer documentation about maintenance control. Provided
	// only when `isCustom` is `true`.
	Documentation string `protobuf:"bytes,3,opt,name=documentation,proto3" json:"documentation,omitempty"`
	// contains filtered or unexported fields
}

The control of the maintenance.

func (*MaintenanceControl) Descriptor deprecated

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

Deprecated: Use MaintenanceControl.ProtoReflect.Descriptor instead.

func (*MaintenanceControl) GetControl

func (*MaintenanceControl) GetDocumentation

func (x *MaintenanceControl) GetDocumentation() string

func (*MaintenanceControl) GetIsCustom

func (x *MaintenanceControl) GetIsCustom() bool

func (*MaintenanceControl) ProtoMessage

func (*MaintenanceControl) ProtoMessage()

func (*MaintenanceControl) ProtoReflect

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

func (*MaintenanceControl) Reset

func (x *MaintenanceControl) Reset()

func (*MaintenanceControl) String

func (x *MaintenanceControl) String() string

type MaintenanceControl_Control

type MaintenanceControl_Control int32

Sets the type of control supported. comment (as in logs).

const (
	// Unspecified control.
	MaintenanceControl_CONTROL_UNSPECIFIED MaintenanceControl_Control = 0
	// Apply control.
	MaintenanceControl_APPLY MaintenanceControl_Control = 1
	// Manage policy control.
	MaintenanceControl_MANAGE_POLICY MaintenanceControl_Control = 2
	// Reschedule control.
	MaintenanceControl_RESCHEDULE MaintenanceControl_Control = 3
)

func (MaintenanceControl_Control) Descriptor

func (MaintenanceControl_Control) Enum

func (MaintenanceControl_Control) EnumDescriptor deprecated

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

Deprecated: Use MaintenanceControl_Control.Descriptor instead.

func (MaintenanceControl_Control) Number

func (MaintenanceControl_Control) String

func (MaintenanceControl_Control) Type

type MaintenanceServer

type MaintenanceServer interface {
	// Retrieves the statistics of a specific maintenance.
	SummarizeMaintenances(context.Context, *SummarizeMaintenancesRequest) (*SummarizeMaintenancesResponse, error)
	// Retrieve a collection of resource maintenances.
	ListResourceMaintenances(context.Context, *ListResourceMaintenancesRequest) (*ListResourceMaintenancesResponse, error)
	// Retrieve a single resource maintenance.
	GetResourceMaintenance(context.Context, *GetResourceMaintenanceRequest) (*ResourceMaintenance, error)
}

MaintenanceServer is the server API for Maintenance service. All implementations should embed UnimplementedMaintenanceServer for forward compatibility

type MaintenanceSummary

type MaintenanceSummary struct {

	// Output only. The name of the maintenance.
	MaintenanceName string `protobuf:"bytes,1,opt,name=maintenance_name,json=maintenanceName,proto3" json:"maintenance_name,omitempty"`
	// Output only. The title of the maintenance.
	Title string `protobuf:"bytes,2,opt,name=title,proto3" json:"title,omitempty"`
	// Output only. The description of the maintenance.
	Description string `protobuf:"bytes,3,opt,name=description,proto3" json:"description,omitempty"`
	// Output only. The category of the maintenance event.
	Category MaintenanceCategory `` /* 128-byte string literal not displayed */
	// Output only. Scheduled start time of the maintenance. The maintenance will
	// start at `maintenanceScheduledStartTime` or later, with best effort to
	// finish before `maintenanceScheduledEndTime`.
	MaintenanceScheduledStartTime *timestamppb.Timestamp `` /* 152-byte string literal not displayed */
	// Output only. An estimated (best effort, not guaranteed) end time of the
	// scheduled maintenance.
	MaintenanceScheduledEndTime *timestamppb.Timestamp `` /* 146-byte string literal not displayed */
	// Output only. Actual date when the maintenance started. Field present only
	// after the state changed to `RUNNING`.
	MaintenanceStartTime *timestamppb.Timestamp `protobuf:"bytes,8,opt,name=maintenance_start_time,json=maintenanceStartTime,proto3" json:"maintenance_start_time,omitempty"`
	// Output only. Actual date when the maintenance successfully completed. Field
	// present only after the state changed to `SUCCEEDED`.
	MaintenanceEndTime *timestamppb.Timestamp `protobuf:"bytes,9,opt,name=maintenance_end_time,json=maintenanceEndTime,proto3" json:"maintenance_end_time,omitempty"`
	// Output only. Indicates whether the user has some control over that
	// maintenance, either proactively before maintenance was scheduled with
	// maintenance policy or with reactive controls after it was scheduled (see
	// controls field).
	UserControllable bool `protobuf:"varint,10,opt,name=user_controllable,json=userControllable,proto3" json:"user_controllable,omitempty"`
	// Output only. Control available for that Maintenance (might not be available
	// for every resource that maintenance is applied to).
	Controls []*MaintenanceControl `protobuf:"bytes,14,rep,name=controls,proto3" json:"controls,omitempty"`
	// Output only. Stats is a field of ResourceMaintenance used to aggregate the
	// stats.
	Stats []*MaintenanceSummary_Stats `protobuf:"bytes,12,rep,name=stats,proto3" json:"stats,omitempty"`
	// contains filtered or unexported fields
}

MaintenanceSummary contains maintenance statistics calculated based on ResourceMaintenances within the scope: project and location.

func (*MaintenanceSummary) Descriptor deprecated

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

Deprecated: Use MaintenanceSummary.ProtoReflect.Descriptor instead.

func (*MaintenanceSummary) GetCategory

func (x *MaintenanceSummary) GetCategory() MaintenanceCategory

func (*MaintenanceSummary) GetControls

func (x *MaintenanceSummary) GetControls() []*MaintenanceControl

func (*MaintenanceSummary) GetDescription

func (x *MaintenanceSummary) GetDescription() string

func (*MaintenanceSummary) GetMaintenanceEndTime

func (x *MaintenanceSummary) GetMaintenanceEndTime() *timestamppb.Timestamp

func (*MaintenanceSummary) GetMaintenanceName

func (x *MaintenanceSummary) GetMaintenanceName() string

func (*MaintenanceSummary) GetMaintenanceScheduledEndTime

func (x *MaintenanceSummary) GetMaintenanceScheduledEndTime() *timestamppb.Timestamp

func (*MaintenanceSummary) GetMaintenanceScheduledStartTime

func (x *MaintenanceSummary) GetMaintenanceScheduledStartTime() *timestamppb.Timestamp

func (*MaintenanceSummary) GetMaintenanceStartTime

func (x *MaintenanceSummary) GetMaintenanceStartTime() *timestamppb.Timestamp

func (*MaintenanceSummary) GetStats

func (*MaintenanceSummary) GetTitle

func (x *MaintenanceSummary) GetTitle() string

func (*MaintenanceSummary) GetUserControllable

func (x *MaintenanceSummary) GetUserControllable() bool

func (*MaintenanceSummary) ProtoMessage

func (*MaintenanceSummary) ProtoMessage()

func (*MaintenanceSummary) ProtoReflect

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

func (*MaintenanceSummary) Reset

func (x *MaintenanceSummary) Reset()

func (*MaintenanceSummary) String

func (x *MaintenanceSummary) String() string

type MaintenanceSummary_Aggregate

type MaintenanceSummary_Aggregate struct {

	// Specifies what specific value of the group_by the count represents. For
	// example if group_by is `"state"` its corresponding group could be
	// `"SCHEDULED"`.
	Group string `protobuf:"bytes,1,opt,name=group,proto3" json:"group,omitempty"`
	// The count of the group.
	Count int64 `protobuf:"varint,2,opt,name=count,proto3" json:"count,omitempty"`
	// contains filtered or unexported fields
}

Aggregate is a <group, count> pair.

func (*MaintenanceSummary_Aggregate) Descriptor deprecated

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

Deprecated: Use MaintenanceSummary_Aggregate.ProtoReflect.Descriptor instead.

func (*MaintenanceSummary_Aggregate) GetCount

func (x *MaintenanceSummary_Aggregate) GetCount() int64

func (*MaintenanceSummary_Aggregate) GetGroup

func (x *MaintenanceSummary_Aggregate) GetGroup() string

func (*MaintenanceSummary_Aggregate) ProtoMessage

func (*MaintenanceSummary_Aggregate) ProtoMessage()

func (*MaintenanceSummary_Aggregate) ProtoReflect

func (*MaintenanceSummary_Aggregate) Reset

func (x *MaintenanceSummary_Aggregate) Reset()

func (*MaintenanceSummary_Aggregate) String

type MaintenanceSummary_Stats

type MaintenanceSummary_Stats struct {

	// groupBy specifies the type of aggregate.
	// For example a group_by might be `"state"`
	GroupBy string `protobuf:"bytes,1,opt,name=group_by,json=groupBy,proto3" json:"group_by,omitempty"`
	// Aggregates is a list <group, count> pairs. For example, if the
	// group_by is `"state"` a possible tuple in the aggregates list could be
	// "SCHEDULED" : `11`,
	Aggregates []*MaintenanceSummary_Aggregate `protobuf:"bytes,2,rep,name=aggregates,proto3" json:"aggregates,omitempty"`
	// contains filtered or unexported fields
}

Stats indicates the type of aggregate and the corresponding aggregates.

func (*MaintenanceSummary_Stats) Descriptor deprecated

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

Deprecated: Use MaintenanceSummary_Stats.ProtoReflect.Descriptor instead.

func (*MaintenanceSummary_Stats) GetAggregates

func (*MaintenanceSummary_Stats) GetGroupBy

func (x *MaintenanceSummary_Stats) GetGroupBy() string

func (*MaintenanceSummary_Stats) ProtoMessage

func (*MaintenanceSummary_Stats) ProtoMessage()

func (*MaintenanceSummary_Stats) ProtoReflect

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

func (*MaintenanceSummary_Stats) Reset

func (x *MaintenanceSummary_Stats) Reset()

func (*MaintenanceSummary_Stats) String

func (x *MaintenanceSummary_Stats) String() string

type ResourceMaintenance

type ResourceMaintenance struct {

	// Identifier. The name of the resource_maintenance resource.
	// Format:
	// `"projects/{project}/locations/{location}/resourceMaintenance/{resource-maintenance-id}"`
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	// Output only. The resource spec of the resource maintenance.
	Resource *ResourceMaintenance_Resource `protobuf:"bytes,2,opt,name=resource,proto3" json:"resource,omitempty"`
	// Output only. The details of the maintenance.
	Maintenance *ResourceMaintenance_Maintenance `protobuf:"bytes,3,opt,name=maintenance,proto3" json:"maintenance,omitempty"`
	// Output only. The state of the resource maintenance.
	State ResourceMaintenance_State `` /* 127-byte string literal not displayed */
	// Output only. The create time of the resource maintenance.
	CreateTime *timestamppb.Timestamp `protobuf:"bytes,5,opt,name=create_time,json=createTime,proto3" json:"create_time,omitempty"`
	// Output only. The update time of the resource maintenance.
	UpdateTime *timestamppb.Timestamp `protobuf:"bytes,6,opt,name=update_time,json=updateTime,proto3" json:"update_time,omitempty"`
	// Output only. The time when the resource maintenance has started.
	MaintenanceStartTime *timestamppb.Timestamp `protobuf:"bytes,7,opt,name=maintenance_start_time,json=maintenanceStartTime,proto3" json:"maintenance_start_time,omitempty"`
	// Output only. The time when the resource maintenance has completed.
	MaintenanceEndTime *timestamppb.Timestamp `protobuf:"bytes,8,opt,name=maintenance_end_time,json=maintenanceEndTime,proto3" json:"maintenance_end_time,omitempty"`
	// Output only. The time when the resource maintenance was cancelled.
	MaintenanceCancelTime *timestamppb.Timestamp `` /* 126-byte string literal not displayed */
	// Output only. The time when the maintenance on the resource was scheduled to
	// start.
	MaintenanceScheduledStartTime *timestamppb.Timestamp `` /* 153-byte string literal not displayed */
	// Output only. The time when the maintenance on the resource was scheduled to
	// end.
	MaintenanceScheduledEndTime *timestamppb.Timestamp `` /* 147-byte string literal not displayed */
	// Output only. Indicates whether the user has some control over that
	// maintenance, either proactively before maintenance was scheduled with
	// maintenance policy or with reactive controls after it was scheduled (see
	// controls field)
	UserControllable bool `protobuf:"varint,12,opt,name=user_controllable,json=userControllable,proto3" json:"user_controllable,omitempty"`
	// Output only. The controls of the maintenance.
	Controls []*MaintenanceControl `protobuf:"bytes,13,rep,name=controls,proto3" json:"controls,omitempty"`
	// Optional. The labels on the resource, which can be used for categorization.
	// similar to Kubernetes resource labels.
	Labels map[string]string `` /* 157-byte string literal not displayed */
	// Optional. Annotations is an unstructured key-value map stored with a
	// resource that may be set by external tools to store and retrieve arbitrary
	// metadata. They are not queryable and should be preserved when modifying
	// objects.
	//
	// More info: https://kubernetes.io/docs/user-guide/annotations
	Annotations map[string]string `` /* 167-byte string literal not displayed */
	// Output only. The unique identifier of the resource. UID is unique in the
	// time and space for this resource within the scope of the service. It is
	// typically generated by the server on successful creation of a resource
	// and must not be changed. UID is used to uniquely identify resources
	// with resource name reuses. This should be a UUID4.
	Uid string `protobuf:"bytes,10201,opt,name=uid,proto3" json:"uid,omitempty"`
	// Output only. An opaque value that uniquely identifies a version or
	// generation of a resource. It can be used to confirm that the client
	// and server agree on the ordering of a resource being written.
	Etag string `protobuf:"bytes,10202,opt,name=etag,proto3" json:"etag,omitempty"`
	// contains filtered or unexported fields
}

ResourceMaintenance is a resource that represents a maintenance operation on a resource.

func (*ResourceMaintenance) Descriptor deprecated

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

Deprecated: Use ResourceMaintenance.ProtoReflect.Descriptor instead.

func (*ResourceMaintenance) GetAnnotations

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

func (*ResourceMaintenance) GetControls

func (x *ResourceMaintenance) GetControls() []*MaintenanceControl

func (*ResourceMaintenance) GetCreateTime

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

func (*ResourceMaintenance) GetEtag

func (x *ResourceMaintenance) GetEtag() string

func (*ResourceMaintenance) GetLabels

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

func (*ResourceMaintenance) GetMaintenance

func (*ResourceMaintenance) GetMaintenanceCancelTime

func (x *ResourceMaintenance) GetMaintenanceCancelTime() *timestamppb.Timestamp

func (*ResourceMaintenance) GetMaintenanceEndTime

func (x *ResourceMaintenance) GetMaintenanceEndTime() *timestamppb.Timestamp

func (*ResourceMaintenance) GetMaintenanceScheduledEndTime

func (x *ResourceMaintenance) GetMaintenanceScheduledEndTime() *timestamppb.Timestamp

func (*ResourceMaintenance) GetMaintenanceScheduledStartTime

func (x *ResourceMaintenance) GetMaintenanceScheduledStartTime() *timestamppb.Timestamp

func (*ResourceMaintenance) GetMaintenanceStartTime

func (x *ResourceMaintenance) GetMaintenanceStartTime() *timestamppb.Timestamp

func (*ResourceMaintenance) GetName

func (x *ResourceMaintenance) GetName() string

func (*ResourceMaintenance) GetResource

func (*ResourceMaintenance) GetState

func (*ResourceMaintenance) GetUid

func (x *ResourceMaintenance) GetUid() string

func (*ResourceMaintenance) GetUpdateTime

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

func (*ResourceMaintenance) GetUserControllable

func (x *ResourceMaintenance) GetUserControllable() bool

func (*ResourceMaintenance) ProtoMessage

func (*ResourceMaintenance) ProtoMessage()

func (*ResourceMaintenance) ProtoReflect

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

func (*ResourceMaintenance) Reset

func (x *ResourceMaintenance) Reset()

func (*ResourceMaintenance) String

func (x *ResourceMaintenance) String() string

type ResourceMaintenance_Maintenance

type ResourceMaintenance_Maintenance struct {

	// Maintenance is the name of the corresponding maintenance resource
	// following the standard naming scheme: `"{maintenance-id}"`
	MaintenanceName string `protobuf:"bytes,1,opt,name=maintenance_name,json=maintenanceName,proto3" json:"maintenance_name,omitempty"`
	// Output only. The title of the maintenance.
	Title string `protobuf:"bytes,2,opt,name=title,proto3" json:"title,omitempty"`
	// Output only. The description of the maintenance.
	Description string `protobuf:"bytes,3,opt,name=description,proto3" json:"description,omitempty"`
	// Output only. The category of the maintenance.
	Category MaintenanceCategory `` /* 127-byte string literal not displayed */
	// contains filtered or unexported fields
}

Maintenance is the maintenance details of a resource's maintenance.

func (*ResourceMaintenance_Maintenance) Descriptor deprecated

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

Deprecated: Use ResourceMaintenance_Maintenance.ProtoReflect.Descriptor instead.

func (*ResourceMaintenance_Maintenance) GetCategory

func (*ResourceMaintenance_Maintenance) GetDescription

func (x *ResourceMaintenance_Maintenance) GetDescription() string

func (*ResourceMaintenance_Maintenance) GetMaintenanceName

func (x *ResourceMaintenance_Maintenance) GetMaintenanceName() string

func (*ResourceMaintenance_Maintenance) GetTitle

func (*ResourceMaintenance_Maintenance) ProtoMessage

func (*ResourceMaintenance_Maintenance) ProtoMessage()

func (*ResourceMaintenance_Maintenance) ProtoReflect

func (*ResourceMaintenance_Maintenance) Reset

func (*ResourceMaintenance_Maintenance) String

type ResourceMaintenance_Resource

type ResourceMaintenance_Resource struct {

	// Output only. Name is the reference to the consumer resource affected by
	// the maintenance. Available values can be found here:
	// https://cloud.google.com/asset-inventory/docs/asset-names
	ResourceName string `protobuf:"bytes,1,opt,name=resource_name,json=resourceName,proto3" json:"resource_name,omitempty"`
	// Output only. The location of the resource.
	// Format:
	// `us-central1`
	Location string `protobuf:"bytes,2,opt,name=location,proto3" json:"location,omitempty"`
	// Output only. The type of the resource.
	// Available values can be found here:
	// https://cloud.google.com/asset-inventory/docs/asset-types#supported_resource_types
	// Please note that not all the resource types will have their maintenances
	// reported.
	Type string `protobuf:"bytes,3,opt,name=type,proto3" json:"type,omitempty"`
	// contains filtered or unexported fields
}

Resource contains information about the resource affected by maintenance.

func (*ResourceMaintenance_Resource) Descriptor deprecated

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

Deprecated: Use ResourceMaintenance_Resource.ProtoReflect.Descriptor instead.

func (*ResourceMaintenance_Resource) GetLocation

func (x *ResourceMaintenance_Resource) GetLocation() string

func (*ResourceMaintenance_Resource) GetResourceName

func (x *ResourceMaintenance_Resource) GetResourceName() string

func (*ResourceMaintenance_Resource) GetType

func (x *ResourceMaintenance_Resource) GetType() string

func (*ResourceMaintenance_Resource) ProtoMessage

func (*ResourceMaintenance_Resource) ProtoMessage()

func (*ResourceMaintenance_Resource) ProtoReflect

func (*ResourceMaintenance_Resource) Reset

func (x *ResourceMaintenance_Resource) Reset()

func (*ResourceMaintenance_Resource) String

type ResourceMaintenance_State

type ResourceMaintenance_State int32

State is the state of a resource maintenance.

const (
	// Unspecified state.
	ResourceMaintenance_STATE_UNSPECIFIED ResourceMaintenance_State = 0
	// Scheduled for a particular window. For disruptive maintenance it should
	// respect maintenance policy, i.e. its available windows, exclusions and
	// notification period.
	ResourceMaintenance_SCHEDULED ResourceMaintenance_State = 1
	// Maintenance is ongoing.
	ResourceMaintenance_RUNNING ResourceMaintenance_State = 2
	// No longer planned, typically when other maintenance (e.g. upgrade to
	// newer version) already happened, or the user skipped the maintenance.
	ResourceMaintenance_CANCELLED ResourceMaintenance_State = 3
	// Successfully completed.
	ResourceMaintenance_SUCCEEDED ResourceMaintenance_State = 4
)

func (ResourceMaintenance_State) Descriptor

func (ResourceMaintenance_State) Enum

func (ResourceMaintenance_State) EnumDescriptor deprecated

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

Deprecated: Use ResourceMaintenance_State.Descriptor instead.

func (ResourceMaintenance_State) Number

func (ResourceMaintenance_State) String

func (x ResourceMaintenance_State) String() string

func (ResourceMaintenance_State) Type

type SummarizeMaintenancesRequest

type SummarizeMaintenancesRequest struct {

	// Required. The parent of the resource maintenance.
	// eg. `projects/123/locations/*`
	Parent string `protobuf:"bytes,10006,opt,name=parent,proto3" json:"parent,omitempty"`
	// The maximum number of resource maintenances to send per page. The default
	// page size is 20 and the maximum is 1000.
	PageSize int32 `protobuf:"varint,10505,opt,name=page_size,json=pageSize,proto3" json:"page_size,omitempty"`
	// The page token: If the next_page_token from a previous response
	// is provided, this request will send the subsequent page.
	PageToken string `protobuf:"bytes,10506,opt,name=page_token,json=pageToken,proto3" json:"page_token,omitempty"`
	// Filter the list as specified in https://google.aip.dev/160.
	// Supported fields include:
	// - `maintenance.maintenanceName`
	// Examples:
	// - `maintenance.maintenanceName="eb3b709c-9ca1-5472-9fb6-800a3849eda1"`
	Filter string `protobuf:"bytes,10507,opt,name=filter,proto3" json:"filter,omitempty"`
	// Order results as specified in https://google.aip.dev/132.
	OrderBy string `protobuf:"bytes,10508,opt,name=order_by,json=orderBy,proto3" json:"order_by,omitempty"`
	// contains filtered or unexported fields
}

Request message for SummarizeMaintenances custom method.

func (*SummarizeMaintenancesRequest) Descriptor deprecated

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

Deprecated: Use SummarizeMaintenancesRequest.ProtoReflect.Descriptor instead.

func (*SummarizeMaintenancesRequest) GetFilter

func (x *SummarizeMaintenancesRequest) GetFilter() string

func (*SummarizeMaintenancesRequest) GetOrderBy

func (x *SummarizeMaintenancesRequest) GetOrderBy() string

func (*SummarizeMaintenancesRequest) GetPageSize

func (x *SummarizeMaintenancesRequest) GetPageSize() int32

func (*SummarizeMaintenancesRequest) GetPageToken

func (x *SummarizeMaintenancesRequest) GetPageToken() string

func (*SummarizeMaintenancesRequest) GetParent

func (x *SummarizeMaintenancesRequest) GetParent() string

func (*SummarizeMaintenancesRequest) ProtoMessage

func (*SummarizeMaintenancesRequest) ProtoMessage()

func (*SummarizeMaintenancesRequest) ProtoReflect

func (*SummarizeMaintenancesRequest) Reset

func (x *SummarizeMaintenancesRequest) Reset()

func (*SummarizeMaintenancesRequest) String

type SummarizeMaintenancesResponse

type SummarizeMaintenancesResponse struct {

	// The resulting summaries.
	Maintenances []*MaintenanceSummary `protobuf:"bytes,10509,rep,name=maintenances,proto3" json:"maintenances,omitempty"`
	// If present, the next page token can be provided to a subsequent
	// SummarizeMaintenances call to list the next page.
	// If empty, there are no more pages.
	NextPageToken string `protobuf:"bytes,10510,opt,name=next_page_token,json=nextPageToken,proto3" json:"next_page_token,omitempty"`
	// Unordered list. Locations that could not be reached.
	Unreachable []string `protobuf:"bytes,10511,rep,name=unreachable,proto3" json:"unreachable,omitempty"`
	// contains filtered or unexported fields
}

Request message for SummarizeMaintenances custom method.

func (*SummarizeMaintenancesResponse) Descriptor deprecated

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

Deprecated: Use SummarizeMaintenancesResponse.ProtoReflect.Descriptor instead.

func (*SummarizeMaintenancesResponse) GetMaintenances

func (x *SummarizeMaintenancesResponse) GetMaintenances() []*MaintenanceSummary

func (*SummarizeMaintenancesResponse) GetNextPageToken

func (x *SummarizeMaintenancesResponse) GetNextPageToken() string

func (*SummarizeMaintenancesResponse) GetUnreachable

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

func (*SummarizeMaintenancesResponse) ProtoMessage

func (*SummarizeMaintenancesResponse) ProtoMessage()

func (*SummarizeMaintenancesResponse) ProtoReflect

func (*SummarizeMaintenancesResponse) Reset

func (x *SummarizeMaintenancesResponse) Reset()

func (*SummarizeMaintenancesResponse) String

type UnimplementedMaintenanceServer

type UnimplementedMaintenanceServer struct {
}

UnimplementedMaintenanceServer should be embedded to have forward compatible implementations.

func (UnimplementedMaintenanceServer) GetResourceMaintenance

type UnsafeMaintenanceServer

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

UnsafeMaintenanceServer may be embedded to opt out of forward compatibility for this service. Use of this interface is not recommended, as added methods to MaintenanceServer will result in compilation errors.

Jump to

Keyboard shortcuts

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