cmi

type CreateMachineRequest struct {
	// MachineName is the name of the machine object CRD for whom a VM is to be created.
	// This field is REQUIRED.
	MachineName string `protobuf:"bytes,1,opt,name=MachineName,proto3" json:"MachineName,omitempty"`
	// ProviderSpec is the configuration needed to create a machine in bytes.
	// Plugin should parse this raw data into pre-defined spec in their respective projects.
	// This field is REQUIRED.
	ProviderSpec []byte `protobuf:"bytes,2,opt,name=ProviderSpec,proto3" json:"ProviderSpec,omitempty"`
	// Secrets is the map containing necessary credentials for cloud-provider to create the machine.
	// This field is OPTIONAL.
	Secrets map[string][]byte `` /* 155-byte string literal not displayed */
	// LastKnownState is any additional information (if required) that can used by the plugin.
	// It can be used by the plugin to recover from the last execution/error state.
	// Plugin should parse this raw data into it's desired format.
	// This field is OPTIONAL.
	LastKnownState       []byte   `protobuf:"bytes,4,opt,name=LastKnownState,proto3" json:"LastKnownState,omitempty"`
	XXX_NoUnkeyedLiteral struct{} `json:"-"`
	XXX_unrecognized     []byte   `json:"-"`
	XXX_sizecache        int32    `json:"-"`
}

type CreateMachineResponse struct {
	// ProviderID is the unique identification of the VM at the cloud provider.
	// This could be the same/different from req.Name.
	// ProviderID typically matches with the node.Spec.ProviderID on the node object.
	// Eg: gce://project-name/region/vm-ID
	// This field is REQUIRED.
	ProviderID string `protobuf:"bytes,1,opt,name=ProviderID,proto3" json:"ProviderID,omitempty"`
	// NodeName is the name of the node-object registered to kubernetes.
	// This field is REQUIRED.
	NodeName string `protobuf:"bytes,2,opt,name=NodeName,proto3" json:"NodeName,omitempty"`
	// LastKnownState is any additional information (if required) that can used by the plugin.
	// It can be the final state of the executing call.
	// Could be used by the plugin to recover from the current execution/error state in any future calls.
	// Plugin should return a raw bytes string.
	// This field is OPTIONAL.
	LastKnownState       []byte   `protobuf:"bytes,3,opt,name=LastKnownState,proto3" json:"LastKnownState,omitempty"`
	XXX_NoUnkeyedLiteral struct{} `json:"-"`
	XXX_unrecognized     []byte   `json:"-"`
	XXX_sizecache        int32    `json:"-"`
}

type DeleteMachineRequest struct {
	// MachineName is the name of the machine object for which a VM is to be deleted.
	// This field is REQUIRED.
	MachineName string `protobuf:"bytes,1,opt,name=MachineName,proto3" json:"MachineName,omitempty"`
	// ProviderSpec is needed to filter VMs based a cluster before deleting.
	// Plugin should parse this raw data into pre-defined spec in their respective projects.
	// This field is REQUIRED.
	ProviderSpec []byte `protobuf:"bytes,2,opt,name=ProviderSpec,proto3" json:"ProviderSpec,omitempty"`
	// Secrets is the map containing necessary credentials for cloud-provider to delete the machine.
	// This field is OPTIONAL.
	Secrets map[string][]byte `` /* 155-byte string literal not displayed */
	// ProviderID is the unique identification of the VM at the cloud provider.
	// This could be the same/different from req.Name.
	// ProviderID typically matches with the node.Spec.ProviderID on the node object.
	// Eg: gce://project-name/region/vm-ID
	// This field is OPTIONAL.
	ProviderID string `protobuf:"bytes,4,opt,name=ProviderID,proto3" json:"ProviderID,omitempty"`
	// LastKnownState is any additional information (if required) that can used by the plugin.
	// It can be used by the plugin to recover from the last execution/error state.
	// Plugin should parse this raw data into it's desired format.
	// This field is OPTIONAL.
	LastKnownState       []byte   `protobuf:"bytes,5,opt,name=LastKnownState,proto3" json:"LastKnownState,omitempty"`
	XXX_NoUnkeyedLiteral struct{} `json:"-"`
	XXX_unrecognized     []byte   `json:"-"`
	XXX_sizecache        int32    `json:"-"`
}

type DeleteMachineResponse struct {
	// LastKnownState is any additional information (if required) that can used by the plugin.
	// It can be the final state of the executing call.
	// Could be used by the plugin to recover from the current execution/error state in any future calls.
	// Plugin should return a raw bytes string.
	// This field is OPTIONAL.
	LastKnownState       []byte   `protobuf:"bytes,1,opt,name=LastKnownState,proto3" json:"LastKnownState,omitempty"`
	XXX_NoUnkeyedLiteral struct{} `json:"-"`
	XXX_unrecognized     []byte   `json:"-"`
	XXX_sizecache        int32    `json:"-"`
}

type GetMachineStatusRequest struct {
	// MachineName is name of the machine object from which the VM is to be identified.
	// The plugin is responsible to issuing a get call for a VM backed by this machine name.
	// This field is REQUIRED.
	MachineName string `protobuf:"bytes,1,opt,name=MachineName,proto3" json:"MachineName,omitempty"`
	// ProviderSpec is needed to filter VMs based a cluster before getting the status.
	// Plugin should parse this raw data into pre-defined spec in their respective projects.
	// This field is REQUIRED.
	ProviderSpec []byte `protobuf:"bytes,2,opt,name=ProviderSpec,proto3" json:"ProviderSpec,omitempty"`
	// Secrets is the map containing necessary credentials for cloud-provider to list the machines.
	// This field is OPTIONAL.
	Secrets map[string][]byte `` /* 155-byte string literal not displayed */
	// ProviderID is the unique identification of the VM at the cloud provider.
	// This could be the same/different from req.Name.
	// ProviderID typically matches with the node.Spec.ProviderID on the node object.
	// Eg: gce://project-name/region/vm-ID
	// This field is OPTIONAL.
	ProviderID           string   `protobuf:"bytes,4,opt,name=ProviderID,proto3" json:"ProviderID,omitempty"`
	XXX_NoUnkeyedLiteral struct{} `json:"-"`
	XXX_unrecognized     []byte   `json:"-"`
	XXX_sizecache        int32    `json:"-"`
}

type GetMachineStatusResponse struct {
	// ProviderID is the unique identification of the VM at the cloud provider.
	// This could be the same/different from req.Name.
	// ProviderID typically matches with the node.Spec.ProviderID on the node object.
	// Eg: gce://project-name/region/vm-ID
	// This field is REQUIRED.
	ProviderID string `protobuf:"bytes,1,opt,name=ProviderID,proto3" json:"ProviderID,omitempty"`
	// NodeName is the name of the node-object registered to kubernetes.
	// This field is REQUIRED.
	NodeName             string   `protobuf:"bytes,2,opt,name=NodeName,proto3" json:"NodeName,omitempty"`
	XXX_NoUnkeyedLiteral struct{} `json:"-"`
	XXX_unrecognized     []byte   `json:"-"`
	XXX_sizecache        int32    `json:"-"`
}

type GetPluginCapabilitiesRequest struct {
	XXX_NoUnkeyedLiteral struct{} `json:"-"`
	XXX_unrecognized     []byte   `json:"-"`
	XXX_sizecache        int32    `json:"-"`
}

type GetPluginCapabilitiesResponse struct {
	// All the capabilities that the controller service supports.
	// This field is OPTIONAL.
	Capabilities         []*PluginCapability `protobuf:"bytes,1,rep,name=capabilities,proto3" json:"capabilities,omitempty"`
	XXX_NoUnkeyedLiteral struct{}            `json:"-"`
	XXX_unrecognized     []byte              `json:"-"`
	XXX_sizecache        int32               `json:"-"`
}

type GetPluginInfoRequest struct {
	XXX_NoUnkeyedLiteral struct{} `json:"-"`
	XXX_unrecognized     []byte   `json:"-"`
	XXX_sizecache        int32    `json:"-"`
}

type GetPluginInfoResponse struct {
	// The name MUST follow domain name notation format
	// (https://tools.ietf.org/html/rfc1035#section-2.3.1). It SHOULD
	// include the plugin's host company name and the plugin name,
	// to minimize the possibility of collisions. It MUST be 63
	// characters or less, beginning and ending with an alphanumeric
	// character ([a-z0-9A-Z]) with dashes (-), dots (.), and
	// alphanumerics between.
	// This field is REQUIRED.
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	// The version specifies the plugin version
	// Value of this field is opaque to the CMI-Client.
	// This field is REQUIRED.
	Version string `protobuf:"bytes,2,opt,name=version,proto3" json:"version,omitempty"`
	// manifest contains a map of key-value pairs to pass
	// any additonal information about the plugin.
	// Values are opaque to the CMI-Client.
	// This field is OPTIONAL.
	Manifest             map[string]string `` /* 157-byte string literal not displayed */
	XXX_NoUnkeyedLiteral struct{}          `json:"-"`
	XXX_unrecognized     []byte            `json:"-"`
	XXX_sizecache        int32             `json:"-"`
}

type GetVolumeIDsRequest struct {
	// PVSpecsList is a list of PV specs for whom volume-IDs are required
	// Plugin should parse this raw data into pre-defined list of PVSpecs
	// This field is REQUIRED.
	PVSpecList           []byte   `protobuf:"bytes,1,opt,name=PVSpecList,proto3" json:"PVSpecList,omitempty"`
	XXX_NoUnkeyedLiteral struct{} `json:"-"`
	XXX_unrecognized     []byte   `json:"-"`
	XXX_sizecache        int32    `json:"-"`
}

type GetVolumeIDsResponse struct {
	// VolumeIDs is a list of VolumeIDs.
	// This field is REQUIRED.
	VolumeIDs            []string `protobuf:"bytes,1,rep,name=VolumeIDs,proto3" json:"VolumeIDs,omitempty"`
	XXX_NoUnkeyedLiteral struct{} `json:"-"`
	XXX_unrecognized     []byte   `json:"-"`
	XXX_sizecache        int32    `json:"-"`
}

type IdentityClient interface {
	// GetPluginInfo returns basic details about the plugin
	// This method is REQUIRED.
	GetPluginInfo(ctx context.Context, in *GetPluginInfoRequest, opts ...grpc.CallOption) (*GetPluginInfoResponse, error)
	// GetPluginCapabilities returns the set of capabilities for the plugin
	// This method is REQUIRED.
	GetPluginCapabilities(ctx context.Context, in *GetPluginCapabilitiesRequest, opts ...grpc.CallOption) (*GetPluginCapabilitiesResponse, error)
	// Probe returns the status of the plugin
	// This method is REQUIRED.
	Probe(ctx context.Context, in *ProbeRequest, opts ...grpc.CallOption) (*ProbeResponse, error)
}

type IdentityServer interface {
	// GetPluginInfo returns basic details about the plugin
	// This method is REQUIRED.
	GetPluginInfo(context.Context, *GetPluginInfoRequest) (*GetPluginInfoResponse, error)
	// GetPluginCapabilities returns the set of capabilities for the plugin
	// This method is REQUIRED.
	GetPluginCapabilities(context.Context, *GetPluginCapabilitiesRequest) (*GetPluginCapabilitiesResponse, error)
	// Probe returns the status of the plugin
	// This method is REQUIRED.
	Probe(context.Context, *ProbeRequest) (*ProbeResponse, error)
}

type ListMachinesRequest struct {
	// ProviderSpec is the configuration needed to list machines.
	// Plugin should parse this raw data into pre-defined spec in their respective projects.
	// This field is REQUIRED.
	ProviderSpec []byte `protobuf:"bytes,1,opt,name=ProviderSpec,proto3" json:"ProviderSpec,omitempty"`
	// Secrets is the map containing necessary credentials for cloud-provider to list the machines.
	// This field is OPTIONAL.
	Secrets              map[string][]byte `` /* 155-byte string literal not displayed */
	XXX_NoUnkeyedLiteral struct{}          `json:"-"`
	XXX_unrecognized     []byte            `json:"-"`
	XXX_sizecache        int32             `json:"-"`
}

type ListMachinesResponse struct {
	// MachineList is the map of list of machines. Format for the map should be map<ProviderID, MachineName>.
	// This field is REQUIRED.
	MachineList          map[string]string `` /* 163-byte string literal not displayed */
	XXX_NoUnkeyedLiteral struct{}          `json:"-"`
	XXX_unrecognized     []byte            `json:"-"`
	XXX_sizecache        int32             `json:"-"`
}

type MachineClient interface {
	// CreateMachine is the gRPC call to create a machine.
	// This method is REQUIRED.
	CreateMachine(ctx context.Context, in *CreateMachineRequest, opts ...grpc.CallOption) (*CreateMachineResponse, error)
	// DeleteMachine is the gRPC call to delete a machine.
	// This method is REQUIRED.
	DeleteMachine(ctx context.Context, in *DeleteMachineRequest, opts ...grpc.CallOption) (*DeleteMachineResponse, error)
	// GetMachineStatus is the gRPC call to get the status of a machine.
	// This method is OPTIONAL.
	GetMachineStatus(ctx context.Context, in *GetMachineStatusRequest, opts ...grpc.CallOption) (*GetMachineStatusResponse, error)
	// ListMachines is the gRPC call to list machines backed by the providerSpec.
	// This method is OPTIONAL.
	ListMachines(ctx context.Context, in *ListMachinesRequest, opts ...grpc.CallOption) (*ListMachinesResponse, error)
	// ShutDownMachine is the gRPC call to shutdown/power-off a machine.
	// This method is OPTIONAL.
	ShutDownMachine(ctx context.Context, in *ShutDownMachineRequest, opts ...grpc.CallOption) (*ShutDownMachineResponse, error)
	// GetVolumeIDs() is the gRPC call to list VolumeIDs
	// (if exists) for PVs provided by PVSpecList.
	// This method is OPTIONAL.
	GetVolumeIDs(ctx context.Context, in *GetVolumeIDsRequest, opts ...grpc.CallOption) (*GetVolumeIDsResponse, error)
}

type MachineServer interface {
	// CreateMachine is the gRPC call to create a machine.
	// This method is REQUIRED.
	CreateMachine(context.Context, *CreateMachineRequest) (*CreateMachineResponse, error)
	// DeleteMachine is the gRPC call to delete a machine.
	// This method is REQUIRED.
	DeleteMachine(context.Context, *DeleteMachineRequest) (*DeleteMachineResponse, error)
	// GetMachineStatus is the gRPC call to get the status of a machine.
	// This method is OPTIONAL.
	GetMachineStatus(context.Context, *GetMachineStatusRequest) (*GetMachineStatusResponse, error)
	// ListMachines is the gRPC call to list machines backed by the providerSpec.
	// This method is OPTIONAL.
	ListMachines(context.Context, *ListMachinesRequest) (*ListMachinesResponse, error)
	// ShutDownMachine is the gRPC call to shutdown/power-off a machine.
	// This method is OPTIONAL.
	ShutDownMachine(context.Context, *ShutDownMachineRequest) (*ShutDownMachineResponse, error)
	// GetVolumeIDs() is the gRPC call to list VolumeIDs
	// (if exists) for PVs provided by PVSpecList.
	// This method is OPTIONAL.
	GetVolumeIDs(context.Context, *GetVolumeIDsRequest) (*GetVolumeIDsResponse, error)
}

type PluginCapability struct {
	// Types that are valid to be assigned to Type:
	//	*PluginCapability_Rpc
	Type                 isPluginCapability_Type `protobuf_oneof:"type"`
	XXX_NoUnkeyedLiteral struct{}                `json:"-"`
	XXX_unrecognized     []byte                  `json:"-"`
	XXX_sizecache        int32                   `json:"-"`
}

type PluginCapability_RPC struct {
	Type                 PluginCapability_RPC_Type `protobuf:"varint,1,opt,name=type,proto3,enum=cmi.v1.PluginCapability_RPC_Type" json:"type,omitempty"`
	XXX_NoUnkeyedLiteral struct{}                  `json:"-"`
	XXX_unrecognized     []byte                    `json:"-"`
	XXX_sizecache        int32                     `json:"-"`
}

type PluginCapability_RPC_Type int32

type PluginCapability_Rpc struct {
	Rpc *PluginCapability_RPC `protobuf:"bytes,1,opt,name=rpc,proto3,oneof"`
}

type ProbeRequest struct {
	XXX_NoUnkeyedLiteral struct{} `json:"-"`
	XXX_unrecognized     []byte   `json:"-"`
	XXX_sizecache        int32    `json:"-"`
}

type ProbeResponse struct {
	// Readiness allows a plugin to report its initialization status back
	// to the CMI-Client. Initialization for some plugins MAY be time consuming
	// and it is important for a CMI-Client to distinguish between the following
	// cases:
	//
	// 1) The plugin is in an unhealthy state and MAY need restarting. In
	//    this case a gRPC error code SHALL be returned.
	// 2) The plugin is still initializing, but is otherwise perfectly
	//    healthy. In this case a successful response SHALL be returned
	//    with a readiness value of `false`. Calls to the plugin's
	//    Machine services MAY fail due to an incomplete
	//    initialization state.
	// 3) The plugin has finished initializing and is ready to service
	//    calls to its Machine services. A successful
	//    response is returned with a readiness value of `true`.
	//
	// This field is OPTIONAL. If not present, the caller SHALL assume
	// that the plugin is in a ready state and is accepting calls to its
	// Machine services (according to the plugin's reported
	// capabilities).
	Ready                *wrappers.BoolValue `protobuf:"bytes,1,opt,name=ready,proto3" json:"ready,omitempty"`
	XXX_NoUnkeyedLiteral struct{}            `json:"-"`
	XXX_unrecognized     []byte              `json:"-"`
	XXX_sizecache        int32               `json:"-"`
}

type ShutDownMachineRequest struct {
	// MachineName is the machine object name for whose VM, the shutdown call is to be invoked.
	// The plugin is responsible to issuing a shutdown call for a VM backed by this machine name.
	// This field is REQUIRED.
	MachineName string `protobuf:"bytes,1,opt,name=MachineName,proto3" json:"MachineName,omitempty"`
	// ProviderSpec is needed to filter VMs based a cluster before shutting down.
	// Plugin should parse this raw data into pre-defined spec in their respective projects.
	// This field is REQUIRED.
	ProviderSpec []byte `protobuf:"bytes,2,opt,name=ProviderSpec,proto3" json:"ProviderSpec,omitempty"`
	// Secrets is the map containing necessary credentials for cloud-provider to shut down the machine.
	// This field is OPTIONAL.
	Secrets map[string][]byte `` /* 155-byte string literal not displayed */
	// ProviderID is the unique identification of the VM at the cloud provider.
	// This could be the same/different from req.Name.
	// ProviderID typically matches with the node.Spec.ProviderID on the node object.
	// Eg: gce://project-name/region/vm-ID
	// This field is OPTIONAL.
	ProviderID string `protobuf:"bytes,4,opt,name=ProviderID,proto3" json:"ProviderID,omitempty"`
	// LastKnownState is any additional information (if required) that can used by the plugin.
	// It can be used by the plugin to recover from the last execution/error state.
	// Plugin should parse this raw data into it's desired format.
	// This field is OPTIONAL.
	LastKnownState       []byte   `protobuf:"bytes,5,opt,name=LastKnownState,proto3" json:"LastKnownState,omitempty"`
	XXX_NoUnkeyedLiteral struct{} `json:"-"`
	XXX_unrecognized     []byte   `json:"-"`
	XXX_sizecache        int32    `json:"-"`
}

type ShutDownMachineResponse struct {
	// LastKnownState is any additional information (if required) that can used by the plugin.
	// It can be the final state of the executing call.
	// Could be used by the plugin to recover from the current execution/error state in any future calls.
	// Plugin should return a raw bytes string.
	// This field is OPTIONAL.
	LastKnownState       []byte   `protobuf:"bytes,1,opt,name=LastKnownState,proto3" json:"LastKnownState,omitempty"`
	XXX_NoUnkeyedLiteral struct{} `json:"-"`
	XXX_unrecognized     []byte   `json:"-"`
	XXX_sizecache        int32    `json:"-"`
}