Documentation ¶
Index ¶
- Variables
- func RegisterBatchServiceServer(s *grpc.Server, srv BatchServiceServer)
- type AllocationPolicy
- func (*AllocationPolicy) Descriptor() ([]byte, []int)deprecated
- func (x *AllocationPolicy) GetInstances() []*AllocationPolicy_InstancePolicyOrTemplate
- func (x *AllocationPolicy) GetLabels() map[string]string
- func (x *AllocationPolicy) GetLocation() *AllocationPolicy_LocationPolicy
- func (x *AllocationPolicy) GetNetwork() *AllocationPolicy_NetworkPolicy
- func (x *AllocationPolicy) GetPlacement() *AllocationPolicy_PlacementPolicy
- func (x *AllocationPolicy) GetServiceAccount() *ServiceAccount
- func (x *AllocationPolicy) GetTags() []string
- func (*AllocationPolicy) ProtoMessage()
- func (x *AllocationPolicy) ProtoReflect() protoreflect.Message
- func (x *AllocationPolicy) Reset()
- func (x *AllocationPolicy) String() string
- type AllocationPolicy_Accelerator
- func (*AllocationPolicy_Accelerator) Descriptor() ([]byte, []int)deprecated
- func (x *AllocationPolicy_Accelerator) GetCount() int64
- func (x *AllocationPolicy_Accelerator) GetDriverVersion() string
- func (x *AllocationPolicy_Accelerator) GetInstallGpuDrivers() booldeprecated
- func (x *AllocationPolicy_Accelerator) GetType() string
- func (*AllocationPolicy_Accelerator) ProtoMessage()
- func (x *AllocationPolicy_Accelerator) ProtoReflect() protoreflect.Message
- func (x *AllocationPolicy_Accelerator) Reset()
- func (x *AllocationPolicy_Accelerator) String() string
- type AllocationPolicy_AttachedDisk
- func (*AllocationPolicy_AttachedDisk) Descriptor() ([]byte, []int)deprecated
- func (m *AllocationPolicy_AttachedDisk) GetAttached() isAllocationPolicy_AttachedDisk_Attached
- func (x *AllocationPolicy_AttachedDisk) GetDeviceName() string
- func (x *AllocationPolicy_AttachedDisk) GetExistingDisk() string
- func (x *AllocationPolicy_AttachedDisk) GetNewDisk() *AllocationPolicy_Disk
- func (*AllocationPolicy_AttachedDisk) ProtoMessage()
- func (x *AllocationPolicy_AttachedDisk) ProtoReflect() protoreflect.Message
- func (x *AllocationPolicy_AttachedDisk) Reset()
- func (x *AllocationPolicy_AttachedDisk) String() string
- type AllocationPolicy_AttachedDisk_ExistingDisk
- type AllocationPolicy_AttachedDisk_NewDisk
- type AllocationPolicy_Disk
- func (*AllocationPolicy_Disk) Descriptor() ([]byte, []int)deprecated
- func (m *AllocationPolicy_Disk) GetDataSource() isAllocationPolicy_Disk_DataSource
- func (x *AllocationPolicy_Disk) GetDiskInterface() string
- func (x *AllocationPolicy_Disk) GetImage() string
- func (x *AllocationPolicy_Disk) GetSizeGb() int64
- func (x *AllocationPolicy_Disk) GetSnapshot() string
- func (x *AllocationPolicy_Disk) GetType() string
- func (*AllocationPolicy_Disk) ProtoMessage()
- func (x *AllocationPolicy_Disk) ProtoReflect() protoreflect.Message
- func (x *AllocationPolicy_Disk) Reset()
- func (x *AllocationPolicy_Disk) String() string
- type AllocationPolicy_Disk_Image
- type AllocationPolicy_Disk_Snapshot
- type AllocationPolicy_InstancePolicy
- func (*AllocationPolicy_InstancePolicy) Descriptor() ([]byte, []int)deprecated
- func (x *AllocationPolicy_InstancePolicy) GetAccelerators() []*AllocationPolicy_Accelerator
- func (x *AllocationPolicy_InstancePolicy) GetBootDisk() *AllocationPolicy_Disk
- func (x *AllocationPolicy_InstancePolicy) GetDisks() []*AllocationPolicy_AttachedDisk
- func (x *AllocationPolicy_InstancePolicy) GetMachineType() string
- func (x *AllocationPolicy_InstancePolicy) GetMinCpuPlatform() string
- func (x *AllocationPolicy_InstancePolicy) GetProvisioningModel() AllocationPolicy_ProvisioningModel
- func (x *AllocationPolicy_InstancePolicy) GetReservation() string
- func (*AllocationPolicy_InstancePolicy) ProtoMessage()
- func (x *AllocationPolicy_InstancePolicy) ProtoReflect() protoreflect.Message
- func (x *AllocationPolicy_InstancePolicy) Reset()
- func (x *AllocationPolicy_InstancePolicy) String() string
- type AllocationPolicy_InstancePolicyOrTemplate
- func (*AllocationPolicy_InstancePolicyOrTemplate) Descriptor() ([]byte, []int)deprecated
- func (x *AllocationPolicy_InstancePolicyOrTemplate) GetInstallGpuDrivers() bool
- func (x *AllocationPolicy_InstancePolicyOrTemplate) GetInstanceTemplate() string
- func (x *AllocationPolicy_InstancePolicyOrTemplate) GetPolicy() *AllocationPolicy_InstancePolicy
- func (m *AllocationPolicy_InstancePolicyOrTemplate) GetPolicyTemplate() isAllocationPolicy_InstancePolicyOrTemplate_PolicyTemplate
- func (*AllocationPolicy_InstancePolicyOrTemplate) ProtoMessage()
- func (x *AllocationPolicy_InstancePolicyOrTemplate) ProtoReflect() protoreflect.Message
- func (x *AllocationPolicy_InstancePolicyOrTemplate) Reset()
- func (x *AllocationPolicy_InstancePolicyOrTemplate) String() string
- type AllocationPolicy_InstancePolicyOrTemplate_InstanceTemplate
- type AllocationPolicy_InstancePolicyOrTemplate_Policy
- type AllocationPolicy_LocationPolicy
- func (*AllocationPolicy_LocationPolicy) Descriptor() ([]byte, []int)deprecated
- func (x *AllocationPolicy_LocationPolicy) GetAllowedLocations() []string
- func (*AllocationPolicy_LocationPolicy) ProtoMessage()
- func (x *AllocationPolicy_LocationPolicy) ProtoReflect() protoreflect.Message
- func (x *AllocationPolicy_LocationPolicy) Reset()
- func (x *AllocationPolicy_LocationPolicy) String() string
- type AllocationPolicy_NetworkInterface
- func (*AllocationPolicy_NetworkInterface) Descriptor() ([]byte, []int)deprecated
- func (x *AllocationPolicy_NetworkInterface) GetNetwork() string
- func (x *AllocationPolicy_NetworkInterface) GetNoExternalIpAddress() bool
- func (x *AllocationPolicy_NetworkInterface) GetSubnetwork() string
- func (*AllocationPolicy_NetworkInterface) ProtoMessage()
- func (x *AllocationPolicy_NetworkInterface) ProtoReflect() protoreflect.Message
- func (x *AllocationPolicy_NetworkInterface) Reset()
- func (x *AllocationPolicy_NetworkInterface) String() string
- type AllocationPolicy_NetworkPolicy
- func (*AllocationPolicy_NetworkPolicy) Descriptor() ([]byte, []int)deprecated
- func (x *AllocationPolicy_NetworkPolicy) GetNetworkInterfaces() []*AllocationPolicy_NetworkInterface
- func (*AllocationPolicy_NetworkPolicy) ProtoMessage()
- func (x *AllocationPolicy_NetworkPolicy) ProtoReflect() protoreflect.Message
- func (x *AllocationPolicy_NetworkPolicy) Reset()
- func (x *AllocationPolicy_NetworkPolicy) String() string
- type AllocationPolicy_PlacementPolicy
- func (*AllocationPolicy_PlacementPolicy) Descriptor() ([]byte, []int)deprecated
- func (x *AllocationPolicy_PlacementPolicy) GetCollocation() string
- func (x *AllocationPolicy_PlacementPolicy) GetMaxDistance() int64
- func (*AllocationPolicy_PlacementPolicy) ProtoMessage()
- func (x *AllocationPolicy_PlacementPolicy) ProtoReflect() protoreflect.Message
- func (x *AllocationPolicy_PlacementPolicy) Reset()
- func (x *AllocationPolicy_PlacementPolicy) String() string
- type AllocationPolicy_ProvisioningModel
- func (AllocationPolicy_ProvisioningModel) Descriptor() protoreflect.EnumDescriptor
- func (x AllocationPolicy_ProvisioningModel) Enum() *AllocationPolicy_ProvisioningModel
- func (AllocationPolicy_ProvisioningModel) EnumDescriptor() ([]byte, []int)deprecated
- func (x AllocationPolicy_ProvisioningModel) Number() protoreflect.EnumNumber
- func (x AllocationPolicy_ProvisioningModel) String() string
- func (AllocationPolicy_ProvisioningModel) Type() protoreflect.EnumType
- type BatchServiceClient
- type BatchServiceServer
- type ComputeResource
- func (*ComputeResource) Descriptor() ([]byte, []int)deprecated
- func (x *ComputeResource) GetBootDiskMib() int64
- func (x *ComputeResource) GetCpuMilli() int64
- func (x *ComputeResource) GetMemoryMib() int64
- func (*ComputeResource) ProtoMessage()
- func (x *ComputeResource) ProtoReflect() protoreflect.Message
- func (x *ComputeResource) Reset()
- func (x *ComputeResource) String() string
- type CreateJobRequest
- func (*CreateJobRequest) Descriptor() ([]byte, []int)deprecated
- func (x *CreateJobRequest) GetJob() *Job
- func (x *CreateJobRequest) GetJobId() string
- func (x *CreateJobRequest) GetParent() string
- func (x *CreateJobRequest) GetRequestId() string
- func (*CreateJobRequest) ProtoMessage()
- func (x *CreateJobRequest) ProtoReflect() protoreflect.Message
- func (x *CreateJobRequest) Reset()
- func (x *CreateJobRequest) String() string
- type DeleteJobRequest
- func (*DeleteJobRequest) Descriptor() ([]byte, []int)deprecated
- func (x *DeleteJobRequest) GetName() string
- func (x *DeleteJobRequest) GetReason() string
- func (x *DeleteJobRequest) GetRequestId() string
- func (*DeleteJobRequest) ProtoMessage()
- func (x *DeleteJobRequest) ProtoReflect() protoreflect.Message
- func (x *DeleteJobRequest) Reset()
- func (x *DeleteJobRequest) String() string
- type Environment
- func (*Environment) Descriptor() ([]byte, []int)deprecated
- func (x *Environment) GetEncryptedVariables() *Environment_KMSEnvMap
- func (x *Environment) GetSecretVariables() map[string]string
- func (x *Environment) GetVariables() map[string]string
- func (*Environment) ProtoMessage()
- func (x *Environment) ProtoReflect() protoreflect.Message
- func (x *Environment) Reset()
- func (x *Environment) String() string
- type Environment_KMSEnvMap
- func (*Environment_KMSEnvMap) Descriptor() ([]byte, []int)deprecated
- func (x *Environment_KMSEnvMap) GetCipherText() string
- func (x *Environment_KMSEnvMap) GetKeyName() string
- func (*Environment_KMSEnvMap) ProtoMessage()
- func (x *Environment_KMSEnvMap) ProtoReflect() protoreflect.Message
- func (x *Environment_KMSEnvMap) Reset()
- func (x *Environment_KMSEnvMap) String() string
- type GCS
- type GetJobRequest
- type GetTaskRequest
- type Job
- func (*Job) Descriptor() ([]byte, []int)deprecated
- func (x *Job) GetAllocationPolicy() *AllocationPolicy
- func (x *Job) GetCreateTime() *timestamppb.Timestamp
- func (x *Job) GetLabels() map[string]string
- func (x *Job) GetLogsPolicy() *LogsPolicy
- func (x *Job) GetName() string
- func (x *Job) GetNotifications() []*JobNotification
- func (x *Job) GetPriority() int64
- func (x *Job) GetStatus() *JobStatus
- func (x *Job) GetTaskGroups() []*TaskGroup
- func (x *Job) GetUid() string
- func (x *Job) GetUpdateTime() *timestamppb.Timestamp
- func (*Job) ProtoMessage()
- func (x *Job) ProtoReflect() protoreflect.Message
- func (x *Job) Reset()
- func (x *Job) String() string
- type JobNotification
- func (*JobNotification) Descriptor() ([]byte, []int)deprecated
- func (x *JobNotification) GetMessage() *JobNotification_Message
- func (x *JobNotification) GetPubsubTopic() string
- func (*JobNotification) ProtoMessage()
- func (x *JobNotification) ProtoReflect() protoreflect.Message
- func (x *JobNotification) Reset()
- func (x *JobNotification) String() string
- type JobNotification_Message
- func (*JobNotification_Message) Descriptor() ([]byte, []int)deprecated
- func (x *JobNotification_Message) GetNewJobState() JobStatus_State
- func (x *JobNotification_Message) GetNewTaskState() TaskStatus_State
- func (x *JobNotification_Message) GetType() JobNotification_Type
- func (*JobNotification_Message) ProtoMessage()
- func (x *JobNotification_Message) ProtoReflect() protoreflect.Message
- func (x *JobNotification_Message) Reset()
- func (x *JobNotification_Message) String() string
- type JobNotification_Type
- func (JobNotification_Type) Descriptor() protoreflect.EnumDescriptor
- func (x JobNotification_Type) Enum() *JobNotification_Type
- func (JobNotification_Type) EnumDescriptor() ([]byte, []int)deprecated
- func (x JobNotification_Type) Number() protoreflect.EnumNumber
- func (x JobNotification_Type) String() string
- func (JobNotification_Type) Type() protoreflect.EnumType
- type JobStatus
- func (*JobStatus) Descriptor() ([]byte, []int)deprecated
- func (x *JobStatus) GetRunDuration() *durationpb.Duration
- func (x *JobStatus) GetState() JobStatus_State
- func (x *JobStatus) GetStatusEvents() []*StatusEvent
- func (x *JobStatus) GetTaskGroups() map[string]*JobStatus_TaskGroupStatus
- func (*JobStatus) ProtoMessage()
- func (x *JobStatus) ProtoReflect() protoreflect.Message
- func (x *JobStatus) Reset()
- func (x *JobStatus) String() string
- type JobStatus_InstanceStatus
- func (*JobStatus_InstanceStatus) Descriptor() ([]byte, []int)deprecated
- func (x *JobStatus_InstanceStatus) GetBootDisk() *AllocationPolicy_Disk
- func (x *JobStatus_InstanceStatus) GetMachineType() string
- func (x *JobStatus_InstanceStatus) GetProvisioningModel() AllocationPolicy_ProvisioningModel
- func (x *JobStatus_InstanceStatus) GetTaskPack() int64
- func (*JobStatus_InstanceStatus) ProtoMessage()
- func (x *JobStatus_InstanceStatus) ProtoReflect() protoreflect.Message
- func (x *JobStatus_InstanceStatus) Reset()
- func (x *JobStatus_InstanceStatus) String() string
- type JobStatus_State
- func (JobStatus_State) Descriptor() protoreflect.EnumDescriptor
- func (x JobStatus_State) Enum() *JobStatus_State
- func (JobStatus_State) EnumDescriptor() ([]byte, []int)deprecated
- func (x JobStatus_State) Number() protoreflect.EnumNumber
- func (x JobStatus_State) String() string
- func (JobStatus_State) Type() protoreflect.EnumType
- type JobStatus_TaskGroupStatus
- func (*JobStatus_TaskGroupStatus) Descriptor() ([]byte, []int)deprecated
- func (x *JobStatus_TaskGroupStatus) GetCounts() map[string]int64
- func (x *JobStatus_TaskGroupStatus) GetInstances() []*JobStatus_InstanceStatus
- func (*JobStatus_TaskGroupStatus) ProtoMessage()
- func (x *JobStatus_TaskGroupStatus) ProtoReflect() protoreflect.Message
- func (x *JobStatus_TaskGroupStatus) Reset()
- func (x *JobStatus_TaskGroupStatus) String() string
- type LifecyclePolicy
- func (*LifecyclePolicy) Descriptor() ([]byte, []int)deprecated
- func (x *LifecyclePolicy) GetAction() LifecyclePolicy_Action
- func (x *LifecyclePolicy) GetActionCondition() *LifecyclePolicy_ActionCondition
- func (*LifecyclePolicy) ProtoMessage()
- func (x *LifecyclePolicy) ProtoReflect() protoreflect.Message
- func (x *LifecyclePolicy) Reset()
- func (x *LifecyclePolicy) String() string
- type LifecyclePolicy_Action
- func (LifecyclePolicy_Action) Descriptor() protoreflect.EnumDescriptor
- func (x LifecyclePolicy_Action) Enum() *LifecyclePolicy_Action
- func (LifecyclePolicy_Action) EnumDescriptor() ([]byte, []int)deprecated
- func (x LifecyclePolicy_Action) Number() protoreflect.EnumNumber
- func (x LifecyclePolicy_Action) String() string
- func (LifecyclePolicy_Action) Type() protoreflect.EnumType
- type LifecyclePolicy_ActionCondition
- func (*LifecyclePolicy_ActionCondition) Descriptor() ([]byte, []int)deprecated
- func (x *LifecyclePolicy_ActionCondition) GetExitCodes() []int32
- func (*LifecyclePolicy_ActionCondition) ProtoMessage()
- func (x *LifecyclePolicy_ActionCondition) ProtoReflect() protoreflect.Message
- func (x *LifecyclePolicy_ActionCondition) Reset()
- func (x *LifecyclePolicy_ActionCondition) String() string
- type ListJobsRequest
- func (*ListJobsRequest) Descriptor() ([]byte, []int)deprecated
- func (x *ListJobsRequest) GetFilter() string
- func (x *ListJobsRequest) GetOrderBy() string
- func (x *ListJobsRequest) GetPageSize() int32
- func (x *ListJobsRequest) GetPageToken() string
- func (x *ListJobsRequest) GetParent() string
- func (*ListJobsRequest) ProtoMessage()
- func (x *ListJobsRequest) ProtoReflect() protoreflect.Message
- func (x *ListJobsRequest) Reset()
- func (x *ListJobsRequest) String() string
- type ListJobsResponse
- func (*ListJobsResponse) Descriptor() ([]byte, []int)deprecated
- func (x *ListJobsResponse) GetJobs() []*Job
- func (x *ListJobsResponse) GetNextPageToken() string
- func (x *ListJobsResponse) GetUnreachable() []string
- func (*ListJobsResponse) ProtoMessage()
- func (x *ListJobsResponse) ProtoReflect() protoreflect.Message
- func (x *ListJobsResponse) Reset()
- func (x *ListJobsResponse) String() string
- type ListTasksRequest
- func (*ListTasksRequest) Descriptor() ([]byte, []int)deprecated
- func (x *ListTasksRequest) GetFilter() string
- func (x *ListTasksRequest) GetPageSize() int32
- func (x *ListTasksRequest) GetPageToken() string
- func (x *ListTasksRequest) GetParent() string
- func (*ListTasksRequest) ProtoMessage()
- func (x *ListTasksRequest) ProtoReflect() protoreflect.Message
- func (x *ListTasksRequest) Reset()
- func (x *ListTasksRequest) String() string
- type ListTasksResponse
- func (*ListTasksResponse) Descriptor() ([]byte, []int)deprecated
- func (x *ListTasksResponse) GetNextPageToken() string
- func (x *ListTasksResponse) GetTasks() []*Task
- func (x *ListTasksResponse) GetUnreachable() []string
- func (*ListTasksResponse) ProtoMessage()
- func (x *ListTasksResponse) ProtoReflect() protoreflect.Message
- func (x *ListTasksResponse) Reset()
- func (x *ListTasksResponse) String() string
- type LogsPolicy
- func (*LogsPolicy) Descriptor() ([]byte, []int)deprecated
- func (x *LogsPolicy) GetCloudLoggingOption() *LogsPolicy_CloudLoggingOption
- func (x *LogsPolicy) GetDestination() LogsPolicy_Destination
- func (x *LogsPolicy) GetLogsPath() string
- func (*LogsPolicy) ProtoMessage()
- func (x *LogsPolicy) ProtoReflect() protoreflect.Message
- func (x *LogsPolicy) Reset()
- func (x *LogsPolicy) String() string
- type LogsPolicy_CloudLoggingOption
- func (*LogsPolicy_CloudLoggingOption) Descriptor() ([]byte, []int)deprecated
- func (x *LogsPolicy_CloudLoggingOption) GetUseGenericTaskMonitoredResource() bool
- func (*LogsPolicy_CloudLoggingOption) ProtoMessage()
- func (x *LogsPolicy_CloudLoggingOption) ProtoReflect() protoreflect.Message
- func (x *LogsPolicy_CloudLoggingOption) Reset()
- func (x *LogsPolicy_CloudLoggingOption) String() string
- type LogsPolicy_Destination
- func (LogsPolicy_Destination) Descriptor() protoreflect.EnumDescriptor
- func (x LogsPolicy_Destination) Enum() *LogsPolicy_Destination
- func (LogsPolicy_Destination) EnumDescriptor() ([]byte, []int)deprecated
- func (x LogsPolicy_Destination) Number() protoreflect.EnumNumber
- func (x LogsPolicy_Destination) String() string
- func (LogsPolicy_Destination) Type() protoreflect.EnumType
- type NFS
- type OperationMetadata
- func (*OperationMetadata) Descriptor() ([]byte, []int)deprecated
- func (x *OperationMetadata) GetApiVersion() string
- func (x *OperationMetadata) GetCreateTime() *timestamppb.Timestamp
- func (x *OperationMetadata) GetEndTime() *timestamppb.Timestamp
- func (x *OperationMetadata) GetRequestedCancellation() bool
- func (x *OperationMetadata) GetStatusMessage() string
- func (x *OperationMetadata) GetTarget() string
- func (x *OperationMetadata) GetVerb() string
- func (*OperationMetadata) ProtoMessage()
- func (x *OperationMetadata) ProtoReflect() protoreflect.Message
- func (x *OperationMetadata) Reset()
- func (x *OperationMetadata) String() string
- type Runnable
- func (*Runnable) Descriptor() ([]byte, []int)deprecated
- func (x *Runnable) GetAlwaysRun() bool
- func (x *Runnable) GetBackground() bool
- func (x *Runnable) GetBarrier() *Runnable_Barrier
- func (x *Runnable) GetContainer() *Runnable_Container
- func (x *Runnable) GetDisplayName() string
- func (x *Runnable) GetEnvironment() *Environment
- func (m *Runnable) GetExecutable() isRunnable_Executable
- func (x *Runnable) GetIgnoreExitStatus() bool
- func (x *Runnable) GetLabels() map[string]string
- func (x *Runnable) GetScript() *Runnable_Script
- func (x *Runnable) GetTimeout() *durationpb.Duration
- func (*Runnable) ProtoMessage()
- func (x *Runnable) ProtoReflect() protoreflect.Message
- func (x *Runnable) Reset()
- func (x *Runnable) String() string
- type Runnable_Barrier
- type Runnable_Barrier_
- type Runnable_Container
- func (*Runnable_Container) Descriptor() ([]byte, []int)deprecated
- func (x *Runnable_Container) GetBlockExternalNetwork() bool
- func (x *Runnable_Container) GetCommands() []string
- func (x *Runnable_Container) GetEnableImageStreaming() bool
- func (x *Runnable_Container) GetEntrypoint() string
- func (x *Runnable_Container) GetImageUri() string
- func (x *Runnable_Container) GetOptions() string
- func (x *Runnable_Container) GetPassword() string
- func (x *Runnable_Container) GetUsername() string
- func (x *Runnable_Container) GetVolumes() []string
- func (*Runnable_Container) ProtoMessage()
- func (x *Runnable_Container) ProtoReflect() protoreflect.Message
- func (x *Runnable_Container) Reset()
- func (x *Runnable_Container) String() string
- type Runnable_Container_
- type Runnable_Script
- func (*Runnable_Script) Descriptor() ([]byte, []int)deprecated
- func (m *Runnable_Script) GetCommand() isRunnable_Script_Command
- func (x *Runnable_Script) GetPath() string
- func (x *Runnable_Script) GetText() string
- func (*Runnable_Script) ProtoMessage()
- func (x *Runnable_Script) ProtoReflect() protoreflect.Message
- func (x *Runnable_Script) Reset()
- func (x *Runnable_Script) String() string
- type Runnable_Script_
- type Runnable_Script_Path
- type Runnable_Script_Text
- type ServiceAccount
- func (*ServiceAccount) Descriptor() ([]byte, []int)deprecated
- func (x *ServiceAccount) GetEmail() string
- func (x *ServiceAccount) GetScopes() []string
- func (*ServiceAccount) ProtoMessage()
- func (x *ServiceAccount) ProtoReflect() protoreflect.Message
- func (x *ServiceAccount) Reset()
- func (x *ServiceAccount) String() string
- type StatusEvent
- func (*StatusEvent) Descriptor() ([]byte, []int)deprecated
- func (x *StatusEvent) GetDescription() string
- func (x *StatusEvent) GetEventTime() *timestamppb.Timestamp
- func (x *StatusEvent) GetTaskExecution() *TaskExecution
- func (x *StatusEvent) GetTaskState() TaskStatus_State
- func (x *StatusEvent) GetType() string
- func (*StatusEvent) ProtoMessage()
- func (x *StatusEvent) ProtoReflect() protoreflect.Message
- func (x *StatusEvent) Reset()
- func (x *StatusEvent) String() string
- type Task
- type TaskExecution
- type TaskGroup
- func (*TaskGroup) Descriptor() ([]byte, []int)deprecated
- func (x *TaskGroup) GetName() string
- func (x *TaskGroup) GetParallelism() int64
- func (x *TaskGroup) GetPermissiveSsh() bool
- func (x *TaskGroup) GetRequireHostsFile() bool
- func (x *TaskGroup) GetRunAsNonRoot() bool
- func (x *TaskGroup) GetSchedulingPolicy() TaskGroup_SchedulingPolicy
- func (x *TaskGroup) GetTaskCount() int64
- func (x *TaskGroup) GetTaskCountPerNode() int64
- func (x *TaskGroup) GetTaskEnvironments() []*Environment
- func (x *TaskGroup) GetTaskSpec() *TaskSpec
- func (*TaskGroup) ProtoMessage()
- func (x *TaskGroup) ProtoReflect() protoreflect.Message
- func (x *TaskGroup) Reset()
- func (x *TaskGroup) String() string
- type TaskGroup_SchedulingPolicy
- func (TaskGroup_SchedulingPolicy) Descriptor() protoreflect.EnumDescriptor
- func (x TaskGroup_SchedulingPolicy) Enum() *TaskGroup_SchedulingPolicy
- func (TaskGroup_SchedulingPolicy) EnumDescriptor() ([]byte, []int)deprecated
- func (x TaskGroup_SchedulingPolicy) Number() protoreflect.EnumNumber
- func (x TaskGroup_SchedulingPolicy) String() string
- func (TaskGroup_SchedulingPolicy) Type() protoreflect.EnumType
- type TaskSpec
- func (*TaskSpec) Descriptor() ([]byte, []int)deprecated
- func (x *TaskSpec) GetComputeResource() *ComputeResource
- func (x *TaskSpec) GetEnvironment() *Environment
- func (x *TaskSpec) GetEnvironments() map[string]stringdeprecated
- func (x *TaskSpec) GetLifecyclePolicies() []*LifecyclePolicy
- func (x *TaskSpec) GetMaxRetryCount() int32
- func (x *TaskSpec) GetMaxRunDuration() *durationpb.Duration
- func (x *TaskSpec) GetRunnables() []*Runnable
- func (x *TaskSpec) GetVolumes() []*Volume
- func (*TaskSpec) ProtoMessage()
- func (x *TaskSpec) ProtoReflect() protoreflect.Message
- func (x *TaskSpec) Reset()
- func (x *TaskSpec) String() string
- type TaskStatus
- func (*TaskStatus) Descriptor() ([]byte, []int)deprecated
- func (x *TaskStatus) GetState() TaskStatus_State
- func (x *TaskStatus) GetStatusEvents() []*StatusEvent
- func (*TaskStatus) ProtoMessage()
- func (x *TaskStatus) ProtoReflect() protoreflect.Message
- func (x *TaskStatus) Reset()
- func (x *TaskStatus) String() string
- type TaskStatus_State
- func (TaskStatus_State) Descriptor() protoreflect.EnumDescriptor
- func (x TaskStatus_State) Enum() *TaskStatus_State
- func (TaskStatus_State) EnumDescriptor() ([]byte, []int)deprecated
- func (x TaskStatus_State) Number() protoreflect.EnumNumber
- func (x TaskStatus_State) String() string
- func (TaskStatus_State) Type() protoreflect.EnumType
- type UnimplementedBatchServiceServer
- func (*UnimplementedBatchServiceServer) CreateJob(context.Context, *CreateJobRequest) (*Job, error)
- func (*UnimplementedBatchServiceServer) DeleteJob(context.Context, *DeleteJobRequest) (*longrunningpb.Operation, error)
- func (*UnimplementedBatchServiceServer) GetJob(context.Context, *GetJobRequest) (*Job, error)
- func (*UnimplementedBatchServiceServer) GetTask(context.Context, *GetTaskRequest) (*Task, error)
- func (*UnimplementedBatchServiceServer) ListJobs(context.Context, *ListJobsRequest) (*ListJobsResponse, error)
- func (*UnimplementedBatchServiceServer) ListTasks(context.Context, *ListTasksRequest) (*ListTasksResponse, error)
- type Volume
- func (*Volume) Descriptor() ([]byte, []int)deprecated
- func (x *Volume) GetDeviceName() string
- func (x *Volume) GetGcs() *GCS
- func (x *Volume) GetMountOptions() []string
- func (x *Volume) GetMountPath() string
- func (x *Volume) GetNfs() *NFS
- func (m *Volume) GetSource() isVolume_Source
- func (*Volume) ProtoMessage()
- func (x *Volume) ProtoReflect() protoreflect.Message
- func (x *Volume) Reset()
- func (x *Volume) String() string
- type Volume_DeviceName
- type Volume_Gcs
- type Volume_Nfs
Constants ¶
This section is empty.
Variables ¶
var ( LogsPolicy_Destination_name = map[int32]string{ 0: "DESTINATION_UNSPECIFIED", 1: "CLOUD_LOGGING", 2: "PATH", } LogsPolicy_Destination_value = map[string]int32{ "DESTINATION_UNSPECIFIED": 0, "CLOUD_LOGGING": 1, "PATH": 2, } )
Enum value maps for LogsPolicy_Destination.
var ( JobStatus_State_name = map[int32]string{ 0: "STATE_UNSPECIFIED", 1: "QUEUED", 2: "SCHEDULED", 3: "RUNNING", 4: "SUCCEEDED", 5: "FAILED", 6: "DELETION_IN_PROGRESS", } JobStatus_State_value = map[string]int32{ "STATE_UNSPECIFIED": 0, "QUEUED": 1, "SCHEDULED": 2, "RUNNING": 3, "SUCCEEDED": 4, "FAILED": 5, "DELETION_IN_PROGRESS": 6, } )
Enum value maps for JobStatus_State.
var ( JobNotification_Type_name = map[int32]string{ 0: "TYPE_UNSPECIFIED", 1: "JOB_STATE_CHANGED", 2: "TASK_STATE_CHANGED", } JobNotification_Type_value = map[string]int32{ "TYPE_UNSPECIFIED": 0, "JOB_STATE_CHANGED": 1, "TASK_STATE_CHANGED": 2, } )
Enum value maps for JobNotification_Type.
var ( AllocationPolicy_ProvisioningModel_name = map[int32]string{ 0: "PROVISIONING_MODEL_UNSPECIFIED", 1: "STANDARD", 2: "SPOT", 3: "PREEMPTIBLE", } AllocationPolicy_ProvisioningModel_value = map[string]int32{ "PROVISIONING_MODEL_UNSPECIFIED": 0, "STANDARD": 1, "SPOT": 2, "PREEMPTIBLE": 3, } )
Enum value maps for AllocationPolicy_ProvisioningModel.
var ( TaskGroup_SchedulingPolicy_name = map[int32]string{ 0: "SCHEDULING_POLICY_UNSPECIFIED", 1: "AS_SOON_AS_POSSIBLE", 2: "IN_ORDER", } TaskGroup_SchedulingPolicy_value = map[string]int32{ "SCHEDULING_POLICY_UNSPECIFIED": 0, "AS_SOON_AS_POSSIBLE": 1, "IN_ORDER": 2, } )
Enum value maps for TaskGroup_SchedulingPolicy.
var ( TaskStatus_State_name = map[int32]string{ 0: "STATE_UNSPECIFIED", 1: "PENDING", 2: "ASSIGNED", 3: "RUNNING", 4: "FAILED", 5: "SUCCEEDED", 6: "UNEXECUTED", } TaskStatus_State_value = map[string]int32{ "STATE_UNSPECIFIED": 0, "PENDING": 1, "ASSIGNED": 2, "RUNNING": 3, "FAILED": 4, "SUCCEEDED": 5, "UNEXECUTED": 6, } )
Enum value maps for TaskStatus_State.
var ( LifecyclePolicy_Action_name = map[int32]string{ 0: "ACTION_UNSPECIFIED", 1: "RETRY_TASK", 2: "FAIL_TASK", } LifecyclePolicy_Action_value = map[string]int32{ "ACTION_UNSPECIFIED": 0, "RETRY_TASK": 1, "FAIL_TASK": 2, } )
Enum value maps for LifecyclePolicy_Action.
var File_google_cloud_batch_v1_batch_proto protoreflect.FileDescriptor
var File_google_cloud_batch_v1_job_proto protoreflect.FileDescriptor
var File_google_cloud_batch_v1_task_proto protoreflect.FileDescriptor
var File_google_cloud_batch_v1_volume_proto protoreflect.FileDescriptor
Functions ¶
func RegisterBatchServiceServer ¶
func RegisterBatchServiceServer(s *grpc.Server, srv BatchServiceServer)
Types ¶
type AllocationPolicy ¶
type AllocationPolicy struct { // Location where compute resources should be allocated for the Job. Location *AllocationPolicy_LocationPolicy `protobuf:"bytes,1,opt,name=location,proto3" json:"location,omitempty"` // Describe instances that can be created by this AllocationPolicy. // Only instances[0] is supported now. Instances []*AllocationPolicy_InstancePolicyOrTemplate `protobuf:"bytes,8,rep,name=instances,proto3" json:"instances,omitempty"` // Service account that VMs will run as. ServiceAccount *ServiceAccount `protobuf:"bytes,9,opt,name=service_account,json=serviceAccount,proto3" json:"service_account,omitempty"` // Labels applied to all VM instances and other resources // created by AllocationPolicy. // Labels could be user provided or system generated. // You can assign up to 64 labels. [Google Compute Engine label // restrictions](https://cloud.google.com/compute/docs/labeling-resources#restrictions) // apply. // Label names that start with "goog-" or "google-" are reserved. Labels map[string]string `` /* 153-byte string literal not displayed */ // The network policy. // // If you define an instance template in the `InstancePolicyOrTemplate` field, // Batch will use the network settings in the instance template instead of // this field. Network *AllocationPolicy_NetworkPolicy `protobuf:"bytes,7,opt,name=network,proto3" json:"network,omitempty"` // The placement policy. Placement *AllocationPolicy_PlacementPolicy `protobuf:"bytes,10,opt,name=placement,proto3" json:"placement,omitempty"` // Optional. Tags applied to the VM instances. // // The tags identify valid sources or targets for network firewalls. // Each tag must be 1-63 characters long, and comply with // [RFC1035](https://www.ietf.org/rfc/rfc1035.txt). Tags []string `protobuf:"bytes,11,rep,name=tags,proto3" json:"tags,omitempty"` // contains filtered or unexported fields }
A Job's resource allocation policy describes when, where, and how compute resources should be allocated for the Job.
func (*AllocationPolicy) Descriptor
deprecated
func (*AllocationPolicy) Descriptor() ([]byte, []int)
Deprecated: Use AllocationPolicy.ProtoReflect.Descriptor instead.
func (*AllocationPolicy) GetInstances ¶
func (x *AllocationPolicy) GetInstances() []*AllocationPolicy_InstancePolicyOrTemplate
func (*AllocationPolicy) GetLabels ¶
func (x *AllocationPolicy) GetLabels() map[string]string
func (*AllocationPolicy) GetLocation ¶
func (x *AllocationPolicy) GetLocation() *AllocationPolicy_LocationPolicy
func (*AllocationPolicy) GetNetwork ¶
func (x *AllocationPolicy) GetNetwork() *AllocationPolicy_NetworkPolicy
func (*AllocationPolicy) GetPlacement ¶ added in v1.1.0
func (x *AllocationPolicy) GetPlacement() *AllocationPolicy_PlacementPolicy
func (*AllocationPolicy) GetServiceAccount ¶
func (x *AllocationPolicy) GetServiceAccount() *ServiceAccount
func (*AllocationPolicy) GetTags ¶ added in v1.8.0
func (x *AllocationPolicy) GetTags() []string
func (*AllocationPolicy) ProtoMessage ¶
func (*AllocationPolicy) ProtoMessage()
func (*AllocationPolicy) ProtoReflect ¶
func (x *AllocationPolicy) ProtoReflect() protoreflect.Message
func (*AllocationPolicy) Reset ¶
func (x *AllocationPolicy) Reset()
func (*AllocationPolicy) String ¶
func (x *AllocationPolicy) String() string
type AllocationPolicy_Accelerator ¶
type AllocationPolicy_Accelerator struct { // The accelerator type. For example, "nvidia-tesla-t4". // See `gcloud compute accelerator-types list`. Type string `protobuf:"bytes,1,opt,name=type,proto3" json:"type,omitempty"` // The number of accelerators of this type. Count int64 `protobuf:"varint,2,opt,name=count,proto3" json:"count,omitempty"` // Deprecated: please use instances[0].install_gpu_drivers instead. // // Deprecated: Marked as deprecated in google/cloud/batch/v1/job.proto. InstallGpuDrivers bool `protobuf:"varint,3,opt,name=install_gpu_drivers,json=installGpuDrivers,proto3" json:"install_gpu_drivers,omitempty"` // Optional. The NVIDIA GPU driver version that should be installed for this // type. // // You can define the specific driver version such as "470.103.01", // following the driver version requirements in // https://cloud.google.com/compute/docs/gpus/install-drivers-gpu#minimum-driver. // Batch will install the specific accelerator driver if qualified. DriverVersion string `protobuf:"bytes,4,opt,name=driver_version,json=driverVersion,proto3" json:"driver_version,omitempty"` // contains filtered or unexported fields }
Accelerator describes Compute Engine accelerators to be attached to the VM.
func (*AllocationPolicy_Accelerator) Descriptor
deprecated
func (*AllocationPolicy_Accelerator) Descriptor() ([]byte, []int)
Deprecated: Use AllocationPolicy_Accelerator.ProtoReflect.Descriptor instead.
func (*AllocationPolicy_Accelerator) GetCount ¶
func (x *AllocationPolicy_Accelerator) GetCount() int64
func (*AllocationPolicy_Accelerator) GetDriverVersion ¶ added in v1.4.0
func (x *AllocationPolicy_Accelerator) GetDriverVersion() string
func (*AllocationPolicy_Accelerator) GetInstallGpuDrivers
deprecated
func (x *AllocationPolicy_Accelerator) GetInstallGpuDrivers() bool
Deprecated: Marked as deprecated in google/cloud/batch/v1/job.proto.
func (*AllocationPolicy_Accelerator) GetType ¶
func (x *AllocationPolicy_Accelerator) GetType() string
func (*AllocationPolicy_Accelerator) ProtoMessage ¶
func (*AllocationPolicy_Accelerator) ProtoMessage()
func (*AllocationPolicy_Accelerator) ProtoReflect ¶
func (x *AllocationPolicy_Accelerator) ProtoReflect() protoreflect.Message
func (*AllocationPolicy_Accelerator) Reset ¶
func (x *AllocationPolicy_Accelerator) Reset()
func (*AllocationPolicy_Accelerator) String ¶
func (x *AllocationPolicy_Accelerator) String() string
type AllocationPolicy_AttachedDisk ¶
type AllocationPolicy_AttachedDisk struct { // Types that are assignable to Attached: // // *AllocationPolicy_AttachedDisk_NewDisk // *AllocationPolicy_AttachedDisk_ExistingDisk Attached isAllocationPolicy_AttachedDisk_Attached `protobuf_oneof:"attached"` // Device name that the guest operating system will see. // It is used by Runnable.volumes field to mount disks. So please specify // the device_name if you want Batch to help mount the disk, and it should // match the device_name field in volumes. DeviceName string `protobuf:"bytes,3,opt,name=device_name,json=deviceName,proto3" json:"device_name,omitempty"` // contains filtered or unexported fields }
A new or an existing persistent disk (PD) or a local ssd attached to a VM instance.
func (*AllocationPolicy_AttachedDisk) Descriptor
deprecated
func (*AllocationPolicy_AttachedDisk) Descriptor() ([]byte, []int)
Deprecated: Use AllocationPolicy_AttachedDisk.ProtoReflect.Descriptor instead.
func (*AllocationPolicy_AttachedDisk) GetAttached ¶
func (m *AllocationPolicy_AttachedDisk) GetAttached() isAllocationPolicy_AttachedDisk_Attached
func (*AllocationPolicy_AttachedDisk) GetDeviceName ¶
func (x *AllocationPolicy_AttachedDisk) GetDeviceName() string
func (*AllocationPolicy_AttachedDisk) GetExistingDisk ¶
func (x *AllocationPolicy_AttachedDisk) GetExistingDisk() string
func (*AllocationPolicy_AttachedDisk) GetNewDisk ¶
func (x *AllocationPolicy_AttachedDisk) GetNewDisk() *AllocationPolicy_Disk
func (*AllocationPolicy_AttachedDisk) ProtoMessage ¶
func (*AllocationPolicy_AttachedDisk) ProtoMessage()
func (*AllocationPolicy_AttachedDisk) ProtoReflect ¶
func (x *AllocationPolicy_AttachedDisk) ProtoReflect() protoreflect.Message
func (*AllocationPolicy_AttachedDisk) Reset ¶
func (x *AllocationPolicy_AttachedDisk) Reset()
func (*AllocationPolicy_AttachedDisk) String ¶
func (x *AllocationPolicy_AttachedDisk) String() string
type AllocationPolicy_AttachedDisk_ExistingDisk ¶
type AllocationPolicy_AttachedDisk_ExistingDisk struct { // Name of an existing PD. ExistingDisk string `protobuf:"bytes,2,opt,name=existing_disk,json=existingDisk,proto3,oneof"` }
type AllocationPolicy_AttachedDisk_NewDisk ¶
type AllocationPolicy_AttachedDisk_NewDisk struct {
NewDisk *AllocationPolicy_Disk `protobuf:"bytes,1,opt,name=new_disk,json=newDisk,proto3,oneof"`
}
type AllocationPolicy_Disk ¶
type AllocationPolicy_Disk struct { // A data source from which a PD will be created. // // Types that are assignable to DataSource: // // *AllocationPolicy_Disk_Image // *AllocationPolicy_Disk_Snapshot DataSource isAllocationPolicy_Disk_DataSource `protobuf_oneof:"data_source"` // Disk type as shown in `gcloud compute disk-types list`. // For example, local SSD uses type "local-ssd". // Persistent disks and boot disks use "pd-balanced", "pd-extreme", "pd-ssd" // or "pd-standard". Type string `protobuf:"bytes,1,opt,name=type,proto3" json:"type,omitempty"` // Disk size in GB. // // **Non-Boot Disk**: // If the `type` specifies a persistent disk, this field // is ignored if `data_source` is set as `image` or `snapshot`. // If the `type` specifies a local SSD, this field should be a multiple of // 375 GB, otherwise, the final size will be the next greater multiple of // 375 GB. // // **Boot Disk**: // Batch will calculate the boot disk size based on source // image and task requirements if you do not speicify the size. // If both this field and the `boot_disk_mib` field in task spec's // `compute_resource` are defined, Batch will only honor this field. // Also, this field should be no smaller than the source disk's // size when the `data_source` is set as `snapshot` or `image`. // For example, if you set an image as the `data_source` field and the // image's default disk size 30 GB, you can only use this field to make the // disk larger or equal to 30 GB. SizeGb int64 `protobuf:"varint,2,opt,name=size_gb,json=sizeGb,proto3" json:"size_gb,omitempty"` // Local SSDs are available through both "SCSI" and "NVMe" interfaces. // If not indicated, "NVMe" will be the default one for local ssds. // This field is ignored for persistent disks as the interface is chosen // automatically. See // https://cloud.google.com/compute/docs/disks/persistent-disks#choose_an_interface. DiskInterface string `protobuf:"bytes,6,opt,name=disk_interface,json=diskInterface,proto3" json:"disk_interface,omitempty"` // contains filtered or unexported fields }
A new persistent disk or a local ssd. A VM can only have one local SSD setting but multiple local SSD partitions. See https://cloud.google.com/compute/docs/disks#pdspecs and https://cloud.google.com/compute/docs/disks#localssds.
func (*AllocationPolicy_Disk) Descriptor
deprecated
func (*AllocationPolicy_Disk) Descriptor() ([]byte, []int)
Deprecated: Use AllocationPolicy_Disk.ProtoReflect.Descriptor instead.
func (*AllocationPolicy_Disk) GetDataSource ¶
func (m *AllocationPolicy_Disk) GetDataSource() isAllocationPolicy_Disk_DataSource
func (*AllocationPolicy_Disk) GetDiskInterface ¶
func (x *AllocationPolicy_Disk) GetDiskInterface() string
func (*AllocationPolicy_Disk) GetImage ¶
func (x *AllocationPolicy_Disk) GetImage() string
func (*AllocationPolicy_Disk) GetSizeGb ¶
func (x *AllocationPolicy_Disk) GetSizeGb() int64
func (*AllocationPolicy_Disk) GetSnapshot ¶
func (x *AllocationPolicy_Disk) GetSnapshot() string
func (*AllocationPolicy_Disk) GetType ¶
func (x *AllocationPolicy_Disk) GetType() string
func (*AllocationPolicy_Disk) ProtoMessage ¶
func (*AllocationPolicy_Disk) ProtoMessage()
func (*AllocationPolicy_Disk) ProtoReflect ¶
func (x *AllocationPolicy_Disk) ProtoReflect() protoreflect.Message
func (*AllocationPolicy_Disk) Reset ¶
func (x *AllocationPolicy_Disk) Reset()
func (*AllocationPolicy_Disk) String ¶
func (x *AllocationPolicy_Disk) String() string
type AllocationPolicy_Disk_Image ¶
type AllocationPolicy_Disk_Image struct { // URL for a VM image to use as the data source for this disk. // For example, the following are all valid URLs: // // * Specify the image by its family name: // projects/{project}/global/images/family/{image_family} // * Specify the image version: // projects/{project}/global/images/{image_version} // // You can also use Batch customized image in short names. // The following image values are supported for a boot disk: // // * `batch-debian`: use Batch Debian images. // * `batch-centos`: use Batch CentOS images. // * `batch-cos`: use Batch Container-Optimized images. // * `batch-hpc-centos`: use Batch HPC CentOS images. // * `batch-hpc-rocky`: use Batch HPC Rocky Linux images. Image string `protobuf:"bytes,4,opt,name=image,proto3,oneof"` }
type AllocationPolicy_Disk_Snapshot ¶
type AllocationPolicy_Disk_Snapshot struct { // Name of a snapshot used as the data source. // Snapshot is not supported as boot disk now. Snapshot string `protobuf:"bytes,5,opt,name=snapshot,proto3,oneof"` }
type AllocationPolicy_InstancePolicy ¶
type AllocationPolicy_InstancePolicy struct { // The Compute Engine machine type. MachineType string `protobuf:"bytes,2,opt,name=machine_type,json=machineType,proto3" json:"machine_type,omitempty"` // The minimum CPU platform. // See // https://cloud.google.com/compute/docs/instances/specify-min-cpu-platform. MinCpuPlatform string `protobuf:"bytes,3,opt,name=min_cpu_platform,json=minCpuPlatform,proto3" json:"min_cpu_platform,omitempty"` // The provisioning model. ProvisioningModel AllocationPolicy_ProvisioningModel `` /* 175-byte string literal not displayed */ // The accelerators attached to each VM instance. Accelerators []*AllocationPolicy_Accelerator `protobuf:"bytes,5,rep,name=accelerators,proto3" json:"accelerators,omitempty"` // Boot disk to be created and attached to each VM by this InstancePolicy. // Boot disk will be deleted when the VM is deleted. // Batch API now only supports booting from image. BootDisk *AllocationPolicy_Disk `protobuf:"bytes,8,opt,name=boot_disk,json=bootDisk,proto3" json:"boot_disk,omitempty"` // Non-boot disks to be attached for each VM created by this InstancePolicy. // New disks will be deleted when the VM is deleted. // A non-boot disk is a disk that can be of a device with a // file system or a raw storage drive that is not ready for data // storage and accessing. Disks []*AllocationPolicy_AttachedDisk `protobuf:"bytes,6,rep,name=disks,proto3" json:"disks,omitempty"` // Optional. If specified, VMs will consume only the specified reservation. // If not specified (default), VMs will consume any applicable reservation. Reservation string `protobuf:"bytes,7,opt,name=reservation,proto3" json:"reservation,omitempty"` // contains filtered or unexported fields }
InstancePolicy describes an instance type and resources attached to each VM created by this InstancePolicy.
func (*AllocationPolicy_InstancePolicy) Descriptor
deprecated
func (*AllocationPolicy_InstancePolicy) Descriptor() ([]byte, []int)
Deprecated: Use AllocationPolicy_InstancePolicy.ProtoReflect.Descriptor instead.
func (*AllocationPolicy_InstancePolicy) GetAccelerators ¶
func (x *AllocationPolicy_InstancePolicy) GetAccelerators() []*AllocationPolicy_Accelerator
func (*AllocationPolicy_InstancePolicy) GetBootDisk ¶ added in v0.7.0
func (x *AllocationPolicy_InstancePolicy) GetBootDisk() *AllocationPolicy_Disk
func (*AllocationPolicy_InstancePolicy) GetDisks ¶
func (x *AllocationPolicy_InstancePolicy) GetDisks() []*AllocationPolicy_AttachedDisk
func (*AllocationPolicy_InstancePolicy) GetMachineType ¶
func (x *AllocationPolicy_InstancePolicy) GetMachineType() string
func (*AllocationPolicy_InstancePolicy) GetMinCpuPlatform ¶
func (x *AllocationPolicy_InstancePolicy) GetMinCpuPlatform() string
func (*AllocationPolicy_InstancePolicy) GetProvisioningModel ¶
func (x *AllocationPolicy_InstancePolicy) GetProvisioningModel() AllocationPolicy_ProvisioningModel
func (*AllocationPolicy_InstancePolicy) GetReservation ¶ added in v1.5.0
func (x *AllocationPolicy_InstancePolicy) GetReservation() string
func (*AllocationPolicy_InstancePolicy) ProtoMessage ¶
func (*AllocationPolicy_InstancePolicy) ProtoMessage()
func (*AllocationPolicy_InstancePolicy) ProtoReflect ¶
func (x *AllocationPolicy_InstancePolicy) ProtoReflect() protoreflect.Message
func (*AllocationPolicy_InstancePolicy) Reset ¶
func (x *AllocationPolicy_InstancePolicy) Reset()
func (*AllocationPolicy_InstancePolicy) String ¶
func (x *AllocationPolicy_InstancePolicy) String() string
type AllocationPolicy_InstancePolicyOrTemplate ¶
type AllocationPolicy_InstancePolicyOrTemplate struct { // Types that are assignable to PolicyTemplate: // // *AllocationPolicy_InstancePolicyOrTemplate_Policy // *AllocationPolicy_InstancePolicyOrTemplate_InstanceTemplate PolicyTemplate isAllocationPolicy_InstancePolicyOrTemplate_PolicyTemplate `protobuf_oneof:"policy_template"` // Set this field true if users want Batch to help fetch drivers from a // third party location and install them for GPUs specified in // policy.accelerators or instance_template on their behalf. Default is // false. // // For Container-Optimized Image cases, Batch will install the // accelerator driver following milestones of // https://cloud.google.com/container-optimized-os/docs/release-notes. For // non Container-Optimized Image cases, following // https://github.com/GoogleCloudPlatform/compute-gpu-installation/blob/main/linux/install_gpu_driver.py. InstallGpuDrivers bool `protobuf:"varint,3,opt,name=install_gpu_drivers,json=installGpuDrivers,proto3" json:"install_gpu_drivers,omitempty"` // contains filtered or unexported fields }
InstancePolicyOrTemplate lets you define the type of resources to use for this job either with an InstancePolicy or an instance template. If undefined, Batch picks the type of VM to use and doesn't include optional VM resources such as GPUs and extra disks.
func (*AllocationPolicy_InstancePolicyOrTemplate) Descriptor
deprecated
func (*AllocationPolicy_InstancePolicyOrTemplate) Descriptor() ([]byte, []int)
Deprecated: Use AllocationPolicy_InstancePolicyOrTemplate.ProtoReflect.Descriptor instead.
func (*AllocationPolicy_InstancePolicyOrTemplate) GetInstallGpuDrivers ¶
func (x *AllocationPolicy_InstancePolicyOrTemplate) GetInstallGpuDrivers() bool
func (*AllocationPolicy_InstancePolicyOrTemplate) GetInstanceTemplate ¶
func (x *AllocationPolicy_InstancePolicyOrTemplate) GetInstanceTemplate() string
func (*AllocationPolicy_InstancePolicyOrTemplate) GetPolicy ¶
func (x *AllocationPolicy_InstancePolicyOrTemplate) GetPolicy() *AllocationPolicy_InstancePolicy
func (*AllocationPolicy_InstancePolicyOrTemplate) GetPolicyTemplate ¶
func (m *AllocationPolicy_InstancePolicyOrTemplate) GetPolicyTemplate() isAllocationPolicy_InstancePolicyOrTemplate_PolicyTemplate
func (*AllocationPolicy_InstancePolicyOrTemplate) ProtoMessage ¶
func (*AllocationPolicy_InstancePolicyOrTemplate) ProtoMessage()
func (*AllocationPolicy_InstancePolicyOrTemplate) ProtoReflect ¶
func (x *AllocationPolicy_InstancePolicyOrTemplate) ProtoReflect() protoreflect.Message
func (*AllocationPolicy_InstancePolicyOrTemplate) Reset ¶
func (x *AllocationPolicy_InstancePolicyOrTemplate) Reset()
func (*AllocationPolicy_InstancePolicyOrTemplate) String ¶
func (x *AllocationPolicy_InstancePolicyOrTemplate) String() string
type AllocationPolicy_InstancePolicyOrTemplate_InstanceTemplate ¶
type AllocationPolicy_InstancePolicyOrTemplate_InstanceTemplate struct { // Name of an instance template used to create VMs. // Named the field as 'instance_template' instead of 'template' to avoid // c++ keyword conflict. InstanceTemplate string `protobuf:"bytes,2,opt,name=instance_template,json=instanceTemplate,proto3,oneof"` }
type AllocationPolicy_InstancePolicyOrTemplate_Policy ¶
type AllocationPolicy_InstancePolicyOrTemplate_Policy struct { // InstancePolicy. Policy *AllocationPolicy_InstancePolicy `protobuf:"bytes,1,opt,name=policy,proto3,oneof"` }
type AllocationPolicy_LocationPolicy ¶
type AllocationPolicy_LocationPolicy struct { // A list of allowed location names represented by internal URLs. // // Each location can be a region or a zone. // Only one region or multiple zones in one region is supported now. // For example, // ["regions/us-central1"] allow VMs in any zones in region us-central1. // ["zones/us-central1-a", "zones/us-central1-c"] only allow VMs // in zones us-central1-a and us-central1-c. // // All locations end up in different regions would cause errors. // For example, // ["regions/us-central1", "zones/us-central1-a", "zones/us-central1-b", // "zones/us-west1-a"] contains 2 regions "us-central1" and // "us-west1". An error is expected in this case. AllowedLocations []string `protobuf:"bytes,1,rep,name=allowed_locations,json=allowedLocations,proto3" json:"allowed_locations,omitempty"` // contains filtered or unexported fields }
func (*AllocationPolicy_LocationPolicy) Descriptor
deprecated
func (*AllocationPolicy_LocationPolicy) Descriptor() ([]byte, []int)
Deprecated: Use AllocationPolicy_LocationPolicy.ProtoReflect.Descriptor instead.
func (*AllocationPolicy_LocationPolicy) GetAllowedLocations ¶
func (x *AllocationPolicy_LocationPolicy) GetAllowedLocations() []string
func (*AllocationPolicy_LocationPolicy) ProtoMessage ¶
func (*AllocationPolicy_LocationPolicy) ProtoMessage()
func (*AllocationPolicy_LocationPolicy) ProtoReflect ¶
func (x *AllocationPolicy_LocationPolicy) ProtoReflect() protoreflect.Message
func (*AllocationPolicy_LocationPolicy) Reset ¶
func (x *AllocationPolicy_LocationPolicy) Reset()
func (*AllocationPolicy_LocationPolicy) String ¶
func (x *AllocationPolicy_LocationPolicy) String() string
type AllocationPolicy_NetworkInterface ¶
type AllocationPolicy_NetworkInterface struct { // The URL of an existing network resource. // You can specify the network as a full or partial URL. // // For example, the following are all valid URLs: // // * https://www.googleapis.com/compute/v1/projects/{project}/global/networks/{network} // * projects/{project}/global/networks/{network} // * global/networks/{network} Network string `protobuf:"bytes,1,opt,name=network,proto3" json:"network,omitempty"` // The URL of an existing subnetwork resource in the network. // You can specify the subnetwork as a full or partial URL. // // For example, the following are all valid URLs: // // * https://www.googleapis.com/compute/v1/projects/{project}/regions/{region}/subnetworks/{subnetwork} // * projects/{project}/regions/{region}/subnetworks/{subnetwork} // * regions/{region}/subnetworks/{subnetwork} Subnetwork string `protobuf:"bytes,2,opt,name=subnetwork,proto3" json:"subnetwork,omitempty"` // Default is false (with an external IP address). Required if // no external public IP address is attached to the VM. If no external // public IP address, additional configuration is required to allow the VM // to access Google Services. See // https://cloud.google.com/vpc/docs/configure-private-google-access and // https://cloud.google.com/nat/docs/gce-example#create-nat for more // information. NoExternalIpAddress bool `protobuf:"varint,3,opt,name=no_external_ip_address,json=noExternalIpAddress,proto3" json:"no_external_ip_address,omitempty"` // contains filtered or unexported fields }
A network interface.
func (*AllocationPolicy_NetworkInterface) Descriptor
deprecated
func (*AllocationPolicy_NetworkInterface) Descriptor() ([]byte, []int)
Deprecated: Use AllocationPolicy_NetworkInterface.ProtoReflect.Descriptor instead.
func (*AllocationPolicy_NetworkInterface) GetNetwork ¶
func (x *AllocationPolicy_NetworkInterface) GetNetwork() string
func (*AllocationPolicy_NetworkInterface) GetNoExternalIpAddress ¶
func (x *AllocationPolicy_NetworkInterface) GetNoExternalIpAddress() bool
func (*AllocationPolicy_NetworkInterface) GetSubnetwork ¶
func (x *AllocationPolicy_NetworkInterface) GetSubnetwork() string
func (*AllocationPolicy_NetworkInterface) ProtoMessage ¶
func (*AllocationPolicy_NetworkInterface) ProtoMessage()
func (*AllocationPolicy_NetworkInterface) ProtoReflect ¶
func (x *AllocationPolicy_NetworkInterface) ProtoReflect() protoreflect.Message
func (*AllocationPolicy_NetworkInterface) Reset ¶
func (x *AllocationPolicy_NetworkInterface) Reset()
func (*AllocationPolicy_NetworkInterface) String ¶
func (x *AllocationPolicy_NetworkInterface) String() string
type AllocationPolicy_NetworkPolicy ¶
type AllocationPolicy_NetworkPolicy struct { // Network configurations. NetworkInterfaces []*AllocationPolicy_NetworkInterface `protobuf:"bytes,1,rep,name=network_interfaces,json=networkInterfaces,proto3" json:"network_interfaces,omitempty"` // contains filtered or unexported fields }
NetworkPolicy describes VM instance network configurations.
func (*AllocationPolicy_NetworkPolicy) Descriptor
deprecated
func (*AllocationPolicy_NetworkPolicy) Descriptor() ([]byte, []int)
Deprecated: Use AllocationPolicy_NetworkPolicy.ProtoReflect.Descriptor instead.
func (*AllocationPolicy_NetworkPolicy) GetNetworkInterfaces ¶
func (x *AllocationPolicy_NetworkPolicy) GetNetworkInterfaces() []*AllocationPolicy_NetworkInterface
func (*AllocationPolicy_NetworkPolicy) ProtoMessage ¶
func (*AllocationPolicy_NetworkPolicy) ProtoMessage()
func (*AllocationPolicy_NetworkPolicy) ProtoReflect ¶
func (x *AllocationPolicy_NetworkPolicy) ProtoReflect() protoreflect.Message
func (*AllocationPolicy_NetworkPolicy) Reset ¶
func (x *AllocationPolicy_NetworkPolicy) Reset()
func (*AllocationPolicy_NetworkPolicy) String ¶
func (x *AllocationPolicy_NetworkPolicy) String() string
type AllocationPolicy_PlacementPolicy ¶ added in v1.1.0
type AllocationPolicy_PlacementPolicy struct { // UNSPECIFIED vs. COLLOCATED (default UNSPECIFIED). Use COLLOCATED when you // want VMs to be located close to each other for low network latency // between the VMs. No placement policy will be generated when collocation // is UNSPECIFIED. Collocation string `protobuf:"bytes,1,opt,name=collocation,proto3" json:"collocation,omitempty"` // When specified, causes the job to fail if more than max_distance logical // switches are required between VMs. Batch uses the most compact possible // placement of VMs even when max_distance is not specified. An explicit // max_distance makes that level of compactness a strict requirement. // Not yet implemented MaxDistance int64 `protobuf:"varint,2,opt,name=max_distance,json=maxDistance,proto3" json:"max_distance,omitempty"` // contains filtered or unexported fields }
PlacementPolicy describes a group placement policy for the VMs controlled by this AllocationPolicy.
func (*AllocationPolicy_PlacementPolicy) Descriptor
deprecated
added in
v1.1.0
func (*AllocationPolicy_PlacementPolicy) Descriptor() ([]byte, []int)
Deprecated: Use AllocationPolicy_PlacementPolicy.ProtoReflect.Descriptor instead.
func (*AllocationPolicy_PlacementPolicy) GetCollocation ¶ added in v1.1.0
func (x *AllocationPolicy_PlacementPolicy) GetCollocation() string
func (*AllocationPolicy_PlacementPolicy) GetMaxDistance ¶ added in v1.1.0
func (x *AllocationPolicy_PlacementPolicy) GetMaxDistance() int64
func (*AllocationPolicy_PlacementPolicy) ProtoMessage ¶ added in v1.1.0
func (*AllocationPolicy_PlacementPolicy) ProtoMessage()
func (*AllocationPolicy_PlacementPolicy) ProtoReflect ¶ added in v1.1.0
func (x *AllocationPolicy_PlacementPolicy) ProtoReflect() protoreflect.Message
func (*AllocationPolicy_PlacementPolicy) Reset ¶ added in v1.1.0
func (x *AllocationPolicy_PlacementPolicy) Reset()
func (*AllocationPolicy_PlacementPolicy) String ¶ added in v1.1.0
func (x *AllocationPolicy_PlacementPolicy) String() string
type AllocationPolicy_ProvisioningModel ¶
type AllocationPolicy_ProvisioningModel int32
Compute Engine VM instance provisioning model.
const ( // Unspecified. AllocationPolicy_PROVISIONING_MODEL_UNSPECIFIED AllocationPolicy_ProvisioningModel = 0 // Standard VM. AllocationPolicy_STANDARD AllocationPolicy_ProvisioningModel = 1 // SPOT VM. AllocationPolicy_SPOT AllocationPolicy_ProvisioningModel = 2 // Preemptible VM (PVM). // // Above SPOT VM is the preferable model for preemptible VM instances: the // old preemptible VM model (indicated by this field) is the older model, // and has been migrated to use the SPOT model as the underlying technology. // This old model will still be supported. AllocationPolicy_PREEMPTIBLE AllocationPolicy_ProvisioningModel = 3 )
func (AllocationPolicy_ProvisioningModel) Descriptor ¶
func (AllocationPolicy_ProvisioningModel) Descriptor() protoreflect.EnumDescriptor
func (AllocationPolicy_ProvisioningModel) Enum ¶
func (x AllocationPolicy_ProvisioningModel) Enum() *AllocationPolicy_ProvisioningModel
func (AllocationPolicy_ProvisioningModel) EnumDescriptor
deprecated
func (AllocationPolicy_ProvisioningModel) EnumDescriptor() ([]byte, []int)
Deprecated: Use AllocationPolicy_ProvisioningModel.Descriptor instead.
func (AllocationPolicy_ProvisioningModel) Number ¶
func (x AllocationPolicy_ProvisioningModel) Number() protoreflect.EnumNumber
func (AllocationPolicy_ProvisioningModel) String ¶
func (x AllocationPolicy_ProvisioningModel) String() string
func (AllocationPolicy_ProvisioningModel) Type ¶
func (AllocationPolicy_ProvisioningModel) Type() protoreflect.EnumType
type BatchServiceClient ¶
type BatchServiceClient interface { // Create a Job. CreateJob(ctx context.Context, in *CreateJobRequest, opts ...grpc.CallOption) (*Job, error) // Get a Job specified by its resource name. GetJob(ctx context.Context, in *GetJobRequest, opts ...grpc.CallOption) (*Job, error) // Delete a Job. DeleteJob(ctx context.Context, in *DeleteJobRequest, opts ...grpc.CallOption) (*longrunningpb.Operation, error) // List all Jobs for a project within a region. ListJobs(ctx context.Context, in *ListJobsRequest, opts ...grpc.CallOption) (*ListJobsResponse, error) // Return a single Task. GetTask(ctx context.Context, in *GetTaskRequest, opts ...grpc.CallOption) (*Task, error) // List Tasks associated with a job. ListTasks(ctx context.Context, in *ListTasksRequest, opts ...grpc.CallOption) (*ListTasksResponse, error) }
BatchServiceClient is the client API for BatchService service.
For semantics around ctx use and closing/ending streaming RPCs, please refer to https://godoc.org/google.golang.org/grpc#ClientConn.NewStream.
func NewBatchServiceClient ¶
func NewBatchServiceClient(cc grpc.ClientConnInterface) BatchServiceClient
type BatchServiceServer ¶
type BatchServiceServer interface { // Create a Job. CreateJob(context.Context, *CreateJobRequest) (*Job, error) // Get a Job specified by its resource name. GetJob(context.Context, *GetJobRequest) (*Job, error) // Delete a Job. DeleteJob(context.Context, *DeleteJobRequest) (*longrunningpb.Operation, error) // List all Jobs for a project within a region. ListJobs(context.Context, *ListJobsRequest) (*ListJobsResponse, error) // Return a single Task. GetTask(context.Context, *GetTaskRequest) (*Task, error) // List Tasks associated with a job. ListTasks(context.Context, *ListTasksRequest) (*ListTasksResponse, error) }
BatchServiceServer is the server API for BatchService service.
type ComputeResource ¶
type ComputeResource struct { // The milliCPU count. // // `cpuMilli` defines the amount of CPU resources per task in milliCPU units. // For example, `1000` corresponds to 1 vCPU per task. If undefined, the // default value is `2000`. // // If you also define the VM's machine type using the `machineType` in // [InstancePolicy](https://cloud.google.com/batch/docs/reference/rest/v1/projects.locations.jobs#instancepolicy) // field or inside the `instanceTemplate` in the // [InstancePolicyOrTemplate](https://cloud.google.com/batch/docs/reference/rest/v1/projects.locations.jobs#instancepolicyortemplate) // field, make sure the CPU resources for both fields are compatible with each // other and with how many tasks you want to allow to run on the same VM at // the same time. // // For example, if you specify the `n2-standard-2` machine type, which has 2 // vCPUs each, you are recommended to set `cpuMilli` no more than `2000`, or // you are recommended to run two tasks on the same VM if you set `cpuMilli` // to `1000` or less. CpuMilli int64 `protobuf:"varint,1,opt,name=cpu_milli,json=cpuMilli,proto3" json:"cpu_milli,omitempty"` // Memory in MiB. // // `memoryMib` defines the amount of memory per task in MiB units. // If undefined, the default value is `2000`. // If you also define the VM's machine type using the `machineType` in // [InstancePolicy](https://cloud.google.com/batch/docs/reference/rest/v1/projects.locations.jobs#instancepolicy) // field or inside the `instanceTemplate` in the // [InstancePolicyOrTemplate](https://cloud.google.com/batch/docs/reference/rest/v1/projects.locations.jobs#instancepolicyortemplate) // field, make sure the memory resources for both fields are compatible with // each other and with how many tasks you want to allow to run on the same VM // at the same time. // // For example, if you specify the `n2-standard-2` machine type, which has 8 // GiB each, you are recommended to set `memoryMib` to no more than `8192`, // or you are recommended to run two tasks on the same VM if you set // `memoryMib` to `4096` or less. MemoryMib int64 `protobuf:"varint,2,opt,name=memory_mib,json=memoryMib,proto3" json:"memory_mib,omitempty"` // Extra boot disk size in MiB for each task. BootDiskMib int64 `protobuf:"varint,4,opt,name=boot_disk_mib,json=bootDiskMib,proto3" json:"boot_disk_mib,omitempty"` // contains filtered or unexported fields }
Compute resource requirements.
ComputeResource defines the amount of resources required for each task. Make sure your tasks have enough resources to successfully run. If you also define the types of resources for a job to use with the [InstancePolicyOrTemplate](https://cloud.google.com/batch/docs/reference/rest/v1/projects.locations.jobs#instancepolicyortemplate) field, make sure both fields are compatible with each other.
func (*ComputeResource) Descriptor
deprecated
func (*ComputeResource) Descriptor() ([]byte, []int)
Deprecated: Use ComputeResource.ProtoReflect.Descriptor instead.
func (*ComputeResource) GetBootDiskMib ¶
func (x *ComputeResource) GetBootDiskMib() int64
func (*ComputeResource) GetCpuMilli ¶
func (x *ComputeResource) GetCpuMilli() int64
func (*ComputeResource) GetMemoryMib ¶
func (x *ComputeResource) GetMemoryMib() int64
func (*ComputeResource) ProtoMessage ¶
func (*ComputeResource) ProtoMessage()
func (*ComputeResource) ProtoReflect ¶
func (x *ComputeResource) ProtoReflect() protoreflect.Message
func (*ComputeResource) Reset ¶
func (x *ComputeResource) Reset()
func (*ComputeResource) String ¶
func (x *ComputeResource) String() string
type CreateJobRequest ¶
type CreateJobRequest struct { // Required. The parent resource name where the Job will be created. // Pattern: "projects/{project}/locations/{location}" Parent string `protobuf:"bytes,1,opt,name=parent,proto3" json:"parent,omitempty"` // ID used to uniquely identify the Job within its parent scope. // This field should contain at most 63 characters and must start with // lowercase characters. // Only lowercase characters, numbers and '-' are accepted. // The '-' character cannot be the first or the last one. // A system generated ID will be used if the field is not set. // // The job.name field in the request will be ignored and the created resource // name of the Job will be "{parent}/jobs/{job_id}". JobId string `protobuf:"bytes,2,opt,name=job_id,json=jobId,proto3" json:"job_id,omitempty"` // Required. The Job to create. Job *Job `protobuf:"bytes,3,opt,name=job,proto3" json:"job,omitempty"` // Optional. An optional request ID to identify requests. Specify a unique // request ID so that if you must retry your request, the server will know to // ignore the request if it has already been completed. The server will // guarantee that for at least 60 minutes since the first request. // // For example, consider a situation where you make an initial request and // the request times out. If you make the request again with the same request // ID, the server can check if original operation with the same request ID // was received, and if so, will ignore the second request. This prevents // clients from accidentally creating duplicate commitments. // // The request ID must be a valid UUID with the exception that zero UUID is // not supported (00000000-0000-0000-0000-000000000000). RequestId string `protobuf:"bytes,4,opt,name=request_id,json=requestId,proto3" json:"request_id,omitempty"` // contains filtered or unexported fields }
CreateJob Request.
func (*CreateJobRequest) Descriptor
deprecated
func (*CreateJobRequest) Descriptor() ([]byte, []int)
Deprecated: Use CreateJobRequest.ProtoReflect.Descriptor instead.
func (*CreateJobRequest) GetJob ¶
func (x *CreateJobRequest) GetJob() *Job
func (*CreateJobRequest) GetJobId ¶
func (x *CreateJobRequest) GetJobId() string
func (*CreateJobRequest) GetParent ¶
func (x *CreateJobRequest) GetParent() string
func (*CreateJobRequest) GetRequestId ¶
func (x *CreateJobRequest) GetRequestId() string
func (*CreateJobRequest) ProtoMessage ¶
func (*CreateJobRequest) ProtoMessage()
func (*CreateJobRequest) ProtoReflect ¶
func (x *CreateJobRequest) ProtoReflect() protoreflect.Message
func (*CreateJobRequest) Reset ¶
func (x *CreateJobRequest) Reset()
func (*CreateJobRequest) String ¶
func (x *CreateJobRequest) String() string
type DeleteJobRequest ¶
type DeleteJobRequest struct { // Job name. Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"` // Optional. Reason for this deletion. Reason string `protobuf:"bytes,2,opt,name=reason,proto3" json:"reason,omitempty"` // Optional. An optional request ID to identify requests. Specify a unique // request ID so that if you must retry your request, the server will know to // ignore the request if it has already been completed. The server will // guarantee that for at least 60 minutes after the first request. // // For example, consider a situation where you make an initial request and // the request times out. If you make the request again with the same request // ID, the server can check if original operation with the same request ID // was received, and if so, will ignore the second request. This prevents // clients from accidentally creating duplicate commitments. // // The request ID must be a valid UUID with the exception that zero UUID is // not supported (00000000-0000-0000-0000-000000000000). RequestId string `protobuf:"bytes,4,opt,name=request_id,json=requestId,proto3" json:"request_id,omitempty"` // contains filtered or unexported fields }
DeleteJob Request.
func (*DeleteJobRequest) Descriptor
deprecated
func (*DeleteJobRequest) Descriptor() ([]byte, []int)
Deprecated: Use DeleteJobRequest.ProtoReflect.Descriptor instead.
func (*DeleteJobRequest) GetName ¶
func (x *DeleteJobRequest) GetName() string
func (*DeleteJobRequest) GetReason ¶
func (x *DeleteJobRequest) GetReason() string
func (*DeleteJobRequest) GetRequestId ¶
func (x *DeleteJobRequest) GetRequestId() string
func (*DeleteJobRequest) ProtoMessage ¶
func (*DeleteJobRequest) ProtoMessage()
func (*DeleteJobRequest) ProtoReflect ¶
func (x *DeleteJobRequest) ProtoReflect() protoreflect.Message
func (*DeleteJobRequest) Reset ¶
func (x *DeleteJobRequest) Reset()
func (*DeleteJobRequest) String ¶
func (x *DeleteJobRequest) String() string
type Environment ¶
type Environment struct { // A map of environment variable names to values. Variables map[string]string `` /* 159-byte string literal not displayed */ // A map of environment variable names to Secret Manager secret names. // The VM will access the named secrets to set the value of each environment // variable. SecretVariables map[string]string `` /* 194-byte string literal not displayed */ // An encrypted JSON dictionary where the key/value pairs correspond to // environment variable names and their values. EncryptedVariables *Environment_KMSEnvMap `protobuf:"bytes,3,opt,name=encrypted_variables,json=encryptedVariables,proto3" json:"encrypted_variables,omitempty"` // contains filtered or unexported fields }
An Environment describes a collection of environment variables to set when executing Tasks.
func (*Environment) Descriptor
deprecated
func (*Environment) Descriptor() ([]byte, []int)
Deprecated: Use Environment.ProtoReflect.Descriptor instead.
func (*Environment) GetEncryptedVariables ¶ added in v0.6.0
func (x *Environment) GetEncryptedVariables() *Environment_KMSEnvMap
func (*Environment) GetSecretVariables ¶ added in v0.6.0
func (x *Environment) GetSecretVariables() map[string]string
func (*Environment) GetVariables ¶
func (x *Environment) GetVariables() map[string]string
func (*Environment) ProtoMessage ¶
func (*Environment) ProtoMessage()
func (*Environment) ProtoReflect ¶
func (x *Environment) ProtoReflect() protoreflect.Message
func (*Environment) Reset ¶
func (x *Environment) Reset()
func (*Environment) String ¶
func (x *Environment) String() string
type Environment_KMSEnvMap ¶ added in v0.6.0
type Environment_KMSEnvMap struct { // The name of the KMS key that will be used to decrypt the cipher text. KeyName string `protobuf:"bytes,1,opt,name=key_name,json=keyName,proto3" json:"key_name,omitempty"` // The value of the cipherText response from the `encrypt` method. CipherText string `protobuf:"bytes,2,opt,name=cipher_text,json=cipherText,proto3" json:"cipher_text,omitempty"` // contains filtered or unexported fields }
func (*Environment_KMSEnvMap) Descriptor
deprecated
added in
v0.6.0
func (*Environment_KMSEnvMap) Descriptor() ([]byte, []int)
Deprecated: Use Environment_KMSEnvMap.ProtoReflect.Descriptor instead.
func (*Environment_KMSEnvMap) GetCipherText ¶ added in v0.6.0
func (x *Environment_KMSEnvMap) GetCipherText() string
func (*Environment_KMSEnvMap) GetKeyName ¶ added in v0.6.0
func (x *Environment_KMSEnvMap) GetKeyName() string
func (*Environment_KMSEnvMap) ProtoMessage ¶ added in v0.6.0
func (*Environment_KMSEnvMap) ProtoMessage()
func (*Environment_KMSEnvMap) ProtoReflect ¶ added in v0.6.0
func (x *Environment_KMSEnvMap) ProtoReflect() protoreflect.Message
func (*Environment_KMSEnvMap) Reset ¶ added in v0.6.0
func (x *Environment_KMSEnvMap) Reset()
func (*Environment_KMSEnvMap) String ¶ added in v0.6.0
func (x *Environment_KMSEnvMap) String() string
type GCS ¶
type GCS struct { // Remote path, either a bucket name or a subdirectory of a bucket, e.g.: // bucket_name, bucket_name/subdirectory/ RemotePath string `protobuf:"bytes,1,opt,name=remote_path,json=remotePath,proto3" json:"remote_path,omitempty"` // contains filtered or unexported fields }
Represents a Google Cloud Storage volume.
func (*GCS) Descriptor
deprecated
func (*GCS) GetRemotePath ¶
func (*GCS) ProtoMessage ¶
func (*GCS) ProtoMessage()
func (*GCS) ProtoReflect ¶
func (x *GCS) ProtoReflect() protoreflect.Message
type GetJobRequest ¶
type GetJobRequest struct { // Required. Job name. Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"` // contains filtered or unexported fields }
GetJob Request.
func (*GetJobRequest) Descriptor
deprecated
func (*GetJobRequest) Descriptor() ([]byte, []int)
Deprecated: Use GetJobRequest.ProtoReflect.Descriptor instead.
func (*GetJobRequest) GetName ¶
func (x *GetJobRequest) GetName() string
func (*GetJobRequest) ProtoMessage ¶
func (*GetJobRequest) ProtoMessage()
func (*GetJobRequest) ProtoReflect ¶
func (x *GetJobRequest) ProtoReflect() protoreflect.Message
func (*GetJobRequest) Reset ¶
func (x *GetJobRequest) Reset()
func (*GetJobRequest) String ¶
func (x *GetJobRequest) String() string
type GetTaskRequest ¶
type GetTaskRequest struct { // Required. Task name. Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"` // contains filtered or unexported fields }
Request for a single Task by name.
func (*GetTaskRequest) Descriptor
deprecated
func (*GetTaskRequest) Descriptor() ([]byte, []int)
Deprecated: Use GetTaskRequest.ProtoReflect.Descriptor instead.
func (*GetTaskRequest) GetName ¶
func (x *GetTaskRequest) GetName() string
func (*GetTaskRequest) ProtoMessage ¶
func (*GetTaskRequest) ProtoMessage()
func (*GetTaskRequest) ProtoReflect ¶
func (x *GetTaskRequest) ProtoReflect() protoreflect.Message
func (*GetTaskRequest) Reset ¶
func (x *GetTaskRequest) Reset()
func (*GetTaskRequest) String ¶
func (x *GetTaskRequest) String() string
type Job ¶
type Job struct { // Output only. Job name. // For example: "projects/123456/locations/us-central1/jobs/job01". Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"` // Output only. A system generated unique ID (in UUID4 format) for the Job. Uid string `protobuf:"bytes,2,opt,name=uid,proto3" json:"uid,omitempty"` // Priority of the Job. // The valid value range is [0, 100). Default value is 0. // Higher value indicates higher priority. // A job with higher priority value is more likely to run earlier if all other // requirements are satisfied. Priority int64 `protobuf:"varint,3,opt,name=priority,proto3" json:"priority,omitempty"` // Required. TaskGroups in the Job. Only one TaskGroup is supported now. TaskGroups []*TaskGroup `protobuf:"bytes,4,rep,name=task_groups,json=taskGroups,proto3" json:"task_groups,omitempty"` // Compute resource allocation for all TaskGroups in the Job. AllocationPolicy *AllocationPolicy `protobuf:"bytes,7,opt,name=allocation_policy,json=allocationPolicy,proto3" json:"allocation_policy,omitempty"` // Labels for the Job. Labels could be user provided or system generated. // For example, // // "labels": { // "department": "finance", // "environment": "test" // } // // You can assign up to 64 labels. [Google Compute Engine label // restrictions](https://cloud.google.com/compute/docs/labeling-resources#restrictions) // apply. // Label names that start with "goog-" or "google-" are reserved. Labels map[string]string `` /* 153-byte string literal not displayed */ // Output only. Job status. It is read only for users. Status *JobStatus `protobuf:"bytes,9,opt,name=status,proto3" json:"status,omitempty"` // Output only. When the Job was created. CreateTime *timestamppb.Timestamp `protobuf:"bytes,11,opt,name=create_time,json=createTime,proto3" json:"create_time,omitempty"` // Output only. The last time the Job was updated. UpdateTime *timestamppb.Timestamp `protobuf:"bytes,12,opt,name=update_time,json=updateTime,proto3" json:"update_time,omitempty"` // Log preservation policy for the Job. LogsPolicy *LogsPolicy `protobuf:"bytes,13,opt,name=logs_policy,json=logsPolicy,proto3" json:"logs_policy,omitempty"` // Notification configurations. Notifications []*JobNotification `protobuf:"bytes,14,rep,name=notifications,proto3" json:"notifications,omitempty"` // contains filtered or unexported fields }
The Cloud Batch Job description.
func (*Job) Descriptor
deprecated
func (*Job) GetAllocationPolicy ¶
func (x *Job) GetAllocationPolicy() *AllocationPolicy
func (*Job) GetCreateTime ¶
func (x *Job) GetCreateTime() *timestamppb.Timestamp
func (*Job) GetLogsPolicy ¶
func (x *Job) GetLogsPolicy() *LogsPolicy
func (*Job) GetNotifications ¶
func (x *Job) GetNotifications() []*JobNotification
func (*Job) GetPriority ¶
func (*Job) GetTaskGroups ¶
func (*Job) GetUpdateTime ¶
func (x *Job) GetUpdateTime() *timestamppb.Timestamp
func (*Job) ProtoMessage ¶
func (*Job) ProtoMessage()
func (*Job) ProtoReflect ¶
func (x *Job) ProtoReflect() protoreflect.Message
type JobNotification ¶
type JobNotification struct { // The Pub/Sub topic where notifications like the job state changes // will be published. The topic must exist in the same project as // the job and billings will be charged to this project. // If not specified, no Pub/Sub messages will be sent. // Topic format: `projects/{project}/topics/{topic}`. PubsubTopic string `protobuf:"bytes,1,opt,name=pubsub_topic,json=pubsubTopic,proto3" json:"pubsub_topic,omitempty"` // The attribute requirements of messages to be sent to this Pub/Sub topic. // Without this field, no message will be sent. Message *JobNotification_Message `protobuf:"bytes,2,opt,name=message,proto3" json:"message,omitempty"` // contains filtered or unexported fields }
Notification configurations.
func (*JobNotification) Descriptor
deprecated
func (*JobNotification) Descriptor() ([]byte, []int)
Deprecated: Use JobNotification.ProtoReflect.Descriptor instead.
func (*JobNotification) GetMessage ¶
func (x *JobNotification) GetMessage() *JobNotification_Message
func (*JobNotification) GetPubsubTopic ¶
func (x *JobNotification) GetPubsubTopic() string
func (*JobNotification) ProtoMessage ¶
func (*JobNotification) ProtoMessage()
func (*JobNotification) ProtoReflect ¶
func (x *JobNotification) ProtoReflect() protoreflect.Message
func (*JobNotification) Reset ¶
func (x *JobNotification) Reset()
func (*JobNotification) String ¶
func (x *JobNotification) String() string
type JobNotification_Message ¶
type JobNotification_Message struct { // The message type. Type JobNotification_Type `protobuf:"varint,1,opt,name=type,proto3,enum=google.cloud.batch.v1.JobNotification_Type" json:"type,omitempty"` // The new job state. NewJobState JobStatus_State `` /* 140-byte string literal not displayed */ // The new task state. NewTaskState TaskStatus_State `` /* 144-byte string literal not displayed */ // contains filtered or unexported fields }
Message details. Describe the conditions under which messages will be sent. If no attribute is defined, no message will be sent by default. One message should specify either the job or the task level attributes, but not both. For example, job level: JOB_STATE_CHANGED and/or a specified new_job_state; task level: TASK_STATE_CHANGED and/or a specified new_task_state.
func (*JobNotification_Message) Descriptor
deprecated
func (*JobNotification_Message) Descriptor() ([]byte, []int)
Deprecated: Use JobNotification_Message.ProtoReflect.Descriptor instead.
func (*JobNotification_Message) GetNewJobState ¶
func (x *JobNotification_Message) GetNewJobState() JobStatus_State
func (*JobNotification_Message) GetNewTaskState ¶
func (x *JobNotification_Message) GetNewTaskState() TaskStatus_State
func (*JobNotification_Message) GetType ¶
func (x *JobNotification_Message) GetType() JobNotification_Type
func (*JobNotification_Message) ProtoMessage ¶
func (*JobNotification_Message) ProtoMessage()
func (*JobNotification_Message) ProtoReflect ¶
func (x *JobNotification_Message) ProtoReflect() protoreflect.Message
func (*JobNotification_Message) Reset ¶
func (x *JobNotification_Message) Reset()
func (*JobNotification_Message) String ¶
func (x *JobNotification_Message) String() string
type JobNotification_Type ¶
type JobNotification_Type int32
The message type.
const ( // Unspecified. JobNotification_TYPE_UNSPECIFIED JobNotification_Type = 0 // Notify users that the job state has changed. JobNotification_JOB_STATE_CHANGED JobNotification_Type = 1 // Notify users that the task state has changed. JobNotification_TASK_STATE_CHANGED JobNotification_Type = 2 )
func (JobNotification_Type) Descriptor ¶
func (JobNotification_Type) Descriptor() protoreflect.EnumDescriptor
func (JobNotification_Type) Enum ¶
func (x JobNotification_Type) Enum() *JobNotification_Type
func (JobNotification_Type) EnumDescriptor
deprecated
func (JobNotification_Type) EnumDescriptor() ([]byte, []int)
Deprecated: Use JobNotification_Type.Descriptor instead.
func (JobNotification_Type) Number ¶
func (x JobNotification_Type) Number() protoreflect.EnumNumber
func (JobNotification_Type) String ¶
func (x JobNotification_Type) String() string
func (JobNotification_Type) Type ¶
func (JobNotification_Type) Type() protoreflect.EnumType
type JobStatus ¶
type JobStatus struct { // Job state State JobStatus_State `protobuf:"varint,1,opt,name=state,proto3,enum=google.cloud.batch.v1.JobStatus_State" json:"state,omitempty"` // Job status events StatusEvents []*StatusEvent `protobuf:"bytes,2,rep,name=status_events,json=statusEvents,proto3" json:"status_events,omitempty"` // Aggregated task status for each TaskGroup in the Job. // The map key is TaskGroup ID. TaskGroups map[string]*JobStatus_TaskGroupStatus `` /* 179-byte string literal not displayed */ // The duration of time that the Job spent in status RUNNING. RunDuration *durationpb.Duration `protobuf:"bytes,5,opt,name=run_duration,json=runDuration,proto3" json:"run_duration,omitempty"` // contains filtered or unexported fields }
Job status.
func (*JobStatus) Descriptor
deprecated
func (*JobStatus) GetRunDuration ¶
func (x *JobStatus) GetRunDuration() *durationpb.Duration
func (*JobStatus) GetState ¶
func (x *JobStatus) GetState() JobStatus_State
func (*JobStatus) GetStatusEvents ¶
func (x *JobStatus) GetStatusEvents() []*StatusEvent
func (*JobStatus) GetTaskGroups ¶
func (x *JobStatus) GetTaskGroups() map[string]*JobStatus_TaskGroupStatus
func (*JobStatus) ProtoMessage ¶
func (*JobStatus) ProtoMessage()
func (*JobStatus) ProtoReflect ¶
func (x *JobStatus) ProtoReflect() protoreflect.Message
type JobStatus_InstanceStatus ¶
type JobStatus_InstanceStatus struct { // The Compute Engine machine type. MachineType string `protobuf:"bytes,1,opt,name=machine_type,json=machineType,proto3" json:"machine_type,omitempty"` // The VM instance provisioning model. ProvisioningModel AllocationPolicy_ProvisioningModel `` /* 175-byte string literal not displayed */ // The max number of tasks can be assigned to this instance type. TaskPack int64 `protobuf:"varint,3,opt,name=task_pack,json=taskPack,proto3" json:"task_pack,omitempty"` // The VM boot disk. BootDisk *AllocationPolicy_Disk `protobuf:"bytes,4,opt,name=boot_disk,json=bootDisk,proto3" json:"boot_disk,omitempty"` // contains filtered or unexported fields }
VM instance status.
func (*JobStatus_InstanceStatus) Descriptor
deprecated
func (*JobStatus_InstanceStatus) Descriptor() ([]byte, []int)
Deprecated: Use JobStatus_InstanceStatus.ProtoReflect.Descriptor instead.
func (*JobStatus_InstanceStatus) GetBootDisk ¶ added in v0.7.0
func (x *JobStatus_InstanceStatus) GetBootDisk() *AllocationPolicy_Disk
func (*JobStatus_InstanceStatus) GetMachineType ¶
func (x *JobStatus_InstanceStatus) GetMachineType() string
func (*JobStatus_InstanceStatus) GetProvisioningModel ¶
func (x *JobStatus_InstanceStatus) GetProvisioningModel() AllocationPolicy_ProvisioningModel
func (*JobStatus_InstanceStatus) GetTaskPack ¶
func (x *JobStatus_InstanceStatus) GetTaskPack() int64
func (*JobStatus_InstanceStatus) ProtoMessage ¶
func (*JobStatus_InstanceStatus) ProtoMessage()
func (*JobStatus_InstanceStatus) ProtoReflect ¶
func (x *JobStatus_InstanceStatus) ProtoReflect() protoreflect.Message
func (*JobStatus_InstanceStatus) Reset ¶
func (x *JobStatus_InstanceStatus) Reset()
func (*JobStatus_InstanceStatus) String ¶
func (x *JobStatus_InstanceStatus) String() string
type JobStatus_State ¶
type JobStatus_State int32
Valid Job states.
const ( // Job state unspecified. JobStatus_STATE_UNSPECIFIED JobStatus_State = 0 // Job is admitted (validated and persisted) and waiting for resources. JobStatus_QUEUED JobStatus_State = 1 // Job is scheduled to run as soon as resource allocation is ready. // The resource allocation may happen at a later time but with a high // chance to succeed. JobStatus_SCHEDULED JobStatus_State = 2 // Resource allocation has been successful. At least one Task in the Job is // RUNNING. JobStatus_RUNNING JobStatus_State = 3 // All Tasks in the Job have finished successfully. JobStatus_SUCCEEDED JobStatus_State = 4 // At least one Task in the Job has failed. JobStatus_FAILED JobStatus_State = 5 // The Job will be deleted, but has not been deleted yet. Typically this is // because resources used by the Job are still being cleaned up. JobStatus_DELETION_IN_PROGRESS JobStatus_State = 6 )
func (JobStatus_State) Descriptor ¶
func (JobStatus_State) Descriptor() protoreflect.EnumDescriptor
func (JobStatus_State) Enum ¶
func (x JobStatus_State) Enum() *JobStatus_State
func (JobStatus_State) EnumDescriptor
deprecated
func (JobStatus_State) EnumDescriptor() ([]byte, []int)
Deprecated: Use JobStatus_State.Descriptor instead.
func (JobStatus_State) Number ¶
func (x JobStatus_State) Number() protoreflect.EnumNumber
func (JobStatus_State) String ¶
func (x JobStatus_State) String() string
func (JobStatus_State) Type ¶
func (JobStatus_State) Type() protoreflect.EnumType
type JobStatus_TaskGroupStatus ¶
type JobStatus_TaskGroupStatus struct { // Count of task in each state in the TaskGroup. // The map key is task state name. Counts map[string]int64 `` /* 154-byte string literal not displayed */ // Status of instances allocated for the TaskGroup. Instances []*JobStatus_InstanceStatus `protobuf:"bytes,2,rep,name=instances,proto3" json:"instances,omitempty"` // contains filtered or unexported fields }
Aggregated task status for a TaskGroup.
func (*JobStatus_TaskGroupStatus) Descriptor
deprecated
func (*JobStatus_TaskGroupStatus) Descriptor() ([]byte, []int)
Deprecated: Use JobStatus_TaskGroupStatus.ProtoReflect.Descriptor instead.
func (*JobStatus_TaskGroupStatus) GetCounts ¶
func (x *JobStatus_TaskGroupStatus) GetCounts() map[string]int64
func (*JobStatus_TaskGroupStatus) GetInstances ¶
func (x *JobStatus_TaskGroupStatus) GetInstances() []*JobStatus_InstanceStatus
func (*JobStatus_TaskGroupStatus) ProtoMessage ¶
func (*JobStatus_TaskGroupStatus) ProtoMessage()
func (*JobStatus_TaskGroupStatus) ProtoReflect ¶
func (x *JobStatus_TaskGroupStatus) ProtoReflect() protoreflect.Message
func (*JobStatus_TaskGroupStatus) Reset ¶
func (x *JobStatus_TaskGroupStatus) Reset()
func (*JobStatus_TaskGroupStatus) String ¶
func (x *JobStatus_TaskGroupStatus) String() string
type LifecyclePolicy ¶
type LifecyclePolicy struct { // Action to execute when ActionCondition is true. // When RETRY_TASK is specified, we will retry failed tasks // if we notice any exit code match and fail tasks if no match is found. // Likewise, when FAIL_TASK is specified, we will fail tasks // if we notice any exit code match and retry tasks if no match is found. Action LifecyclePolicy_Action `protobuf:"varint,1,opt,name=action,proto3,enum=google.cloud.batch.v1.LifecyclePolicy_Action" json:"action,omitempty"` // Conditions that decide why a task failure is dealt with a specific action. ActionCondition *LifecyclePolicy_ActionCondition `protobuf:"bytes,2,opt,name=action_condition,json=actionCondition,proto3" json:"action_condition,omitempty"` // contains filtered or unexported fields }
LifecyclePolicy describes how to deal with task failures based on different conditions.
func (*LifecyclePolicy) Descriptor
deprecated
func (*LifecyclePolicy) Descriptor() ([]byte, []int)
Deprecated: Use LifecyclePolicy.ProtoReflect.Descriptor instead.
func (*LifecyclePolicy) GetAction ¶
func (x *LifecyclePolicy) GetAction() LifecyclePolicy_Action
func (*LifecyclePolicy) GetActionCondition ¶
func (x *LifecyclePolicy) GetActionCondition() *LifecyclePolicy_ActionCondition
func (*LifecyclePolicy) ProtoMessage ¶
func (*LifecyclePolicy) ProtoMessage()
func (*LifecyclePolicy) ProtoReflect ¶
func (x *LifecyclePolicy) ProtoReflect() protoreflect.Message
func (*LifecyclePolicy) Reset ¶
func (x *LifecyclePolicy) Reset()
func (*LifecyclePolicy) String ¶
func (x *LifecyclePolicy) String() string
type LifecyclePolicy_Action ¶
type LifecyclePolicy_Action int32
Action on task failures based on different conditions.
const ( // Action unspecified. LifecyclePolicy_ACTION_UNSPECIFIED LifecyclePolicy_Action = 0 // Action that tasks in the group will be scheduled to re-execute. LifecyclePolicy_RETRY_TASK LifecyclePolicy_Action = 1 // Action that tasks in the group will be stopped immediately. LifecyclePolicy_FAIL_TASK LifecyclePolicy_Action = 2 )
func (LifecyclePolicy_Action) Descriptor ¶
func (LifecyclePolicy_Action) Descriptor() protoreflect.EnumDescriptor
func (LifecyclePolicy_Action) Enum ¶
func (x LifecyclePolicy_Action) Enum() *LifecyclePolicy_Action
func (LifecyclePolicy_Action) EnumDescriptor
deprecated
func (LifecyclePolicy_Action) EnumDescriptor() ([]byte, []int)
Deprecated: Use LifecyclePolicy_Action.Descriptor instead.
func (LifecyclePolicy_Action) Number ¶
func (x LifecyclePolicy_Action) Number() protoreflect.EnumNumber
func (LifecyclePolicy_Action) String ¶
func (x LifecyclePolicy_Action) String() string
func (LifecyclePolicy_Action) Type ¶
func (LifecyclePolicy_Action) Type() protoreflect.EnumType
type LifecyclePolicy_ActionCondition ¶
type LifecyclePolicy_ActionCondition struct { // Exit codes of a task execution. // If there are more than 1 exit codes, // when task executes with any of the exit code in the list, // the condition is met and the action will be executed. ExitCodes []int32 `protobuf:"varint,1,rep,packed,name=exit_codes,json=exitCodes,proto3" json:"exit_codes,omitempty"` // contains filtered or unexported fields }
Conditions for actions to deal with task failures.
func (*LifecyclePolicy_ActionCondition) Descriptor
deprecated
func (*LifecyclePolicy_ActionCondition) Descriptor() ([]byte, []int)
Deprecated: Use LifecyclePolicy_ActionCondition.ProtoReflect.Descriptor instead.
func (*LifecyclePolicy_ActionCondition) GetExitCodes ¶
func (x *LifecyclePolicy_ActionCondition) GetExitCodes() []int32
func (*LifecyclePolicy_ActionCondition) ProtoMessage ¶
func (*LifecyclePolicy_ActionCondition) ProtoMessage()
func (*LifecyclePolicy_ActionCondition) ProtoReflect ¶
func (x *LifecyclePolicy_ActionCondition) ProtoReflect() protoreflect.Message
func (*LifecyclePolicy_ActionCondition) Reset ¶
func (x *LifecyclePolicy_ActionCondition) Reset()
func (*LifecyclePolicy_ActionCondition) String ¶
func (x *LifecyclePolicy_ActionCondition) String() string
type ListJobsRequest ¶
type ListJobsRequest struct { // Parent path. Parent string `protobuf:"bytes,1,opt,name=parent,proto3" json:"parent,omitempty"` // List filter. Filter string `protobuf:"bytes,4,opt,name=filter,proto3" json:"filter,omitempty"` // Optional. Sort results. Supported are "name", "name desc", "create_time", // and "create_time desc". OrderBy string `protobuf:"bytes,5,opt,name=order_by,json=orderBy,proto3" json:"order_by,omitempty"` // Page size. PageSize int32 `protobuf:"varint,2,opt,name=page_size,json=pageSize,proto3" json:"page_size,omitempty"` // Page token. PageToken string `protobuf:"bytes,3,opt,name=page_token,json=pageToken,proto3" json:"page_token,omitempty"` // contains filtered or unexported fields }
ListJob Request.
func (*ListJobsRequest) Descriptor
deprecated
func (*ListJobsRequest) Descriptor() ([]byte, []int)
Deprecated: Use ListJobsRequest.ProtoReflect.Descriptor instead.
func (*ListJobsRequest) GetFilter ¶
func (x *ListJobsRequest) GetFilter() string
func (*ListJobsRequest) GetOrderBy ¶ added in v1.4.0
func (x *ListJobsRequest) GetOrderBy() string
func (*ListJobsRequest) GetPageSize ¶
func (x *ListJobsRequest) GetPageSize() int32
func (*ListJobsRequest) GetPageToken ¶
func (x *ListJobsRequest) GetPageToken() string
func (*ListJobsRequest) GetParent ¶
func (x *ListJobsRequest) GetParent() string
func (*ListJobsRequest) ProtoMessage ¶
func (*ListJobsRequest) ProtoMessage()
func (*ListJobsRequest) ProtoReflect ¶
func (x *ListJobsRequest) ProtoReflect() protoreflect.Message
func (*ListJobsRequest) Reset ¶
func (x *ListJobsRequest) Reset()
func (*ListJobsRequest) String ¶
func (x *ListJobsRequest) String() string
type ListJobsResponse ¶
type ListJobsResponse struct { // Jobs. Jobs []*Job `protobuf:"bytes,1,rep,name=jobs,proto3" json:"jobs,omitempty"` // Next page token. NextPageToken string `protobuf:"bytes,2,opt,name=next_page_token,json=nextPageToken,proto3" json:"next_page_token,omitempty"` // Locations that could not be reached. Unreachable []string `protobuf:"bytes,3,rep,name=unreachable,proto3" json:"unreachable,omitempty"` // contains filtered or unexported fields }
ListJob Response.
func (*ListJobsResponse) Descriptor
deprecated
func (*ListJobsResponse) Descriptor() ([]byte, []int)
Deprecated: Use ListJobsResponse.ProtoReflect.Descriptor instead.
func (*ListJobsResponse) GetJobs ¶
func (x *ListJobsResponse) GetJobs() []*Job
func (*ListJobsResponse) GetNextPageToken ¶
func (x *ListJobsResponse) GetNextPageToken() string
func (*ListJobsResponse) GetUnreachable ¶
func (x *ListJobsResponse) GetUnreachable() []string
func (*ListJobsResponse) ProtoMessage ¶
func (*ListJobsResponse) ProtoMessage()
func (*ListJobsResponse) ProtoReflect ¶
func (x *ListJobsResponse) ProtoReflect() protoreflect.Message
func (*ListJobsResponse) Reset ¶
func (x *ListJobsResponse) Reset()
func (*ListJobsResponse) String ¶
func (x *ListJobsResponse) String() string
type ListTasksRequest ¶
type ListTasksRequest struct { // Required. Name of a TaskGroup from which Tasks are being requested. // Pattern: // "projects/{project}/locations/{location}/jobs/{job}/taskGroups/{task_group}" Parent string `protobuf:"bytes,1,opt,name=parent,proto3" json:"parent,omitempty"` // Task filter, null filter matches all Tasks. // Filter string should be of the format State=TaskStatus.State e.g. // State=RUNNING Filter string `protobuf:"bytes,2,opt,name=filter,proto3" json:"filter,omitempty"` // Page size. PageSize int32 `protobuf:"varint,3,opt,name=page_size,json=pageSize,proto3" json:"page_size,omitempty"` // Page token. PageToken string `protobuf:"bytes,4,opt,name=page_token,json=pageToken,proto3" json:"page_token,omitempty"` // contains filtered or unexported fields }
ListTasks Request.
func (*ListTasksRequest) Descriptor
deprecated
func (*ListTasksRequest) Descriptor() ([]byte, []int)
Deprecated: Use ListTasksRequest.ProtoReflect.Descriptor instead.
func (*ListTasksRequest) GetFilter ¶
func (x *ListTasksRequest) GetFilter() string
func (*ListTasksRequest) GetPageSize ¶
func (x *ListTasksRequest) GetPageSize() int32
func (*ListTasksRequest) GetPageToken ¶
func (x *ListTasksRequest) GetPageToken() string
func (*ListTasksRequest) GetParent ¶
func (x *ListTasksRequest) GetParent() string
func (*ListTasksRequest) ProtoMessage ¶
func (*ListTasksRequest) ProtoMessage()
func (*ListTasksRequest) ProtoReflect ¶
func (x *ListTasksRequest) ProtoReflect() protoreflect.Message
func (*ListTasksRequest) Reset ¶
func (x *ListTasksRequest) Reset()
func (*ListTasksRequest) String ¶
func (x *ListTasksRequest) String() string
type ListTasksResponse ¶
type ListTasksResponse struct { // Tasks. Tasks []*Task `protobuf:"bytes,1,rep,name=tasks,proto3" json:"tasks,omitempty"` // Next page token. NextPageToken string `protobuf:"bytes,2,opt,name=next_page_token,json=nextPageToken,proto3" json:"next_page_token,omitempty"` // Locations that could not be reached. Unreachable []string `protobuf:"bytes,3,rep,name=unreachable,proto3" json:"unreachable,omitempty"` // contains filtered or unexported fields }
ListTasks Response.
func (*ListTasksResponse) Descriptor
deprecated
func (*ListTasksResponse) Descriptor() ([]byte, []int)
Deprecated: Use ListTasksResponse.ProtoReflect.Descriptor instead.
func (*ListTasksResponse) GetNextPageToken ¶
func (x *ListTasksResponse) GetNextPageToken() string
func (*ListTasksResponse) GetTasks ¶
func (x *ListTasksResponse) GetTasks() []*Task
func (*ListTasksResponse) GetUnreachable ¶
func (x *ListTasksResponse) GetUnreachable() []string
func (*ListTasksResponse) ProtoMessage ¶
func (*ListTasksResponse) ProtoMessage()
func (*ListTasksResponse) ProtoReflect ¶
func (x *ListTasksResponse) ProtoReflect() protoreflect.Message
func (*ListTasksResponse) Reset ¶
func (x *ListTasksResponse) Reset()
func (*ListTasksResponse) String ¶
func (x *ListTasksResponse) String() string
type LogsPolicy ¶
type LogsPolicy struct { // Where logs should be saved. Destination LogsPolicy_Destination `` /* 126-byte string literal not displayed */ // The path to which logs are saved when the destination = PATH. This can be a // local file path on the VM, or under the mount point of a Persistent Disk or // Filestore, or a Cloud Storage path. LogsPath string `protobuf:"bytes,2,opt,name=logs_path,json=logsPath,proto3" json:"logs_path,omitempty"` // Optional. Additional settings for Cloud Logging. It will only take effect // when the destination of `LogsPolicy` is set to `CLOUD_LOGGING`. CloudLoggingOption *LogsPolicy_CloudLoggingOption `protobuf:"bytes,3,opt,name=cloud_logging_option,json=cloudLoggingOption,proto3" json:"cloud_logging_option,omitempty"` // contains filtered or unexported fields }
LogsPolicy describes how outputs from a Job's Tasks (stdout/stderr) will be preserved.
func (*LogsPolicy) Descriptor
deprecated
func (*LogsPolicy) Descriptor() ([]byte, []int)
Deprecated: Use LogsPolicy.ProtoReflect.Descriptor instead.
func (*LogsPolicy) GetCloudLoggingOption ¶ added in v1.7.0
func (x *LogsPolicy) GetCloudLoggingOption() *LogsPolicy_CloudLoggingOption
func (*LogsPolicy) GetDestination ¶
func (x *LogsPolicy) GetDestination() LogsPolicy_Destination
func (*LogsPolicy) GetLogsPath ¶
func (x *LogsPolicy) GetLogsPath() string
func (*LogsPolicy) ProtoMessage ¶
func (*LogsPolicy) ProtoMessage()
func (*LogsPolicy) ProtoReflect ¶
func (x *LogsPolicy) ProtoReflect() protoreflect.Message
func (*LogsPolicy) Reset ¶
func (x *LogsPolicy) Reset()
func (*LogsPolicy) String ¶
func (x *LogsPolicy) String() string
type LogsPolicy_CloudLoggingOption ¶ added in v1.7.0
type LogsPolicy_CloudLoggingOption struct { // Optional. Set this flag to true to change the [monitored resource // type](https://cloud.google.com/monitoring/api/resources) for // Cloud Logging logs generated by this Batch job from // the // [`batch.googleapis.com/Job`](https://cloud.google.com/monitoring/api/resources#tag_batch.googleapis.com/Job) // type to the formerly used // [`generic_task`](https://cloud.google.com/monitoring/api/resources#tag_generic_task) // type. UseGenericTaskMonitoredResource bool `` /* 161-byte string literal not displayed */ // contains filtered or unexported fields }
`CloudLoggingOption` contains additional settings for Cloud Logging logs generated by Batch job.
func (*LogsPolicy_CloudLoggingOption) Descriptor
deprecated
added in
v1.7.0
func (*LogsPolicy_CloudLoggingOption) Descriptor() ([]byte, []int)
Deprecated: Use LogsPolicy_CloudLoggingOption.ProtoReflect.Descriptor instead.
func (*LogsPolicy_CloudLoggingOption) GetUseGenericTaskMonitoredResource ¶ added in v1.8.0
func (x *LogsPolicy_CloudLoggingOption) GetUseGenericTaskMonitoredResource() bool
func (*LogsPolicy_CloudLoggingOption) ProtoMessage ¶ added in v1.7.0
func (*LogsPolicy_CloudLoggingOption) ProtoMessage()
func (*LogsPolicy_CloudLoggingOption) ProtoReflect ¶ added in v1.7.0
func (x *LogsPolicy_CloudLoggingOption) ProtoReflect() protoreflect.Message
func (*LogsPolicy_CloudLoggingOption) Reset ¶ added in v1.7.0
func (x *LogsPolicy_CloudLoggingOption) Reset()
func (*LogsPolicy_CloudLoggingOption) String ¶ added in v1.7.0
func (x *LogsPolicy_CloudLoggingOption) String() string
type LogsPolicy_Destination ¶
type LogsPolicy_Destination int32
The destination (if any) for logs.
const ( // Logs are not preserved. LogsPolicy_DESTINATION_UNSPECIFIED LogsPolicy_Destination = 0 // Logs are streamed to Cloud Logging. LogsPolicy_CLOUD_LOGGING LogsPolicy_Destination = 1 // Logs are saved to a file path. LogsPolicy_PATH LogsPolicy_Destination = 2 )
func (LogsPolicy_Destination) Descriptor ¶
func (LogsPolicy_Destination) Descriptor() protoreflect.EnumDescriptor
func (LogsPolicy_Destination) Enum ¶
func (x LogsPolicy_Destination) Enum() *LogsPolicy_Destination
func (LogsPolicy_Destination) EnumDescriptor
deprecated
func (LogsPolicy_Destination) EnumDescriptor() ([]byte, []int)
Deprecated: Use LogsPolicy_Destination.Descriptor instead.
func (LogsPolicy_Destination) Number ¶
func (x LogsPolicy_Destination) Number() protoreflect.EnumNumber
func (LogsPolicy_Destination) String ¶
func (x LogsPolicy_Destination) String() string
func (LogsPolicy_Destination) Type ¶
func (LogsPolicy_Destination) Type() protoreflect.EnumType
type NFS ¶
type NFS struct { // The IP address of the NFS. Server string `protobuf:"bytes,1,opt,name=server,proto3" json:"server,omitempty"` // Remote source path exported from the NFS, e.g., "/share". RemotePath string `protobuf:"bytes,2,opt,name=remote_path,json=remotePath,proto3" json:"remote_path,omitempty"` // contains filtered or unexported fields }
Represents an NFS volume.
func (*NFS) Descriptor
deprecated
func (*NFS) GetRemotePath ¶
func (*NFS) ProtoMessage ¶
func (*NFS) ProtoMessage()
func (*NFS) ProtoReflect ¶
func (x *NFS) ProtoReflect() protoreflect.Message
type OperationMetadata ¶
type OperationMetadata struct { // Output only. The time the operation was created. CreateTime *timestamppb.Timestamp `protobuf:"bytes,1,opt,name=create_time,json=createTime,proto3" json:"create_time,omitempty"` // Output only. The time the operation finished running. EndTime *timestamppb.Timestamp `protobuf:"bytes,2,opt,name=end_time,json=endTime,proto3" json:"end_time,omitempty"` // Output only. Server-defined resource path for the target of the operation. Target string `protobuf:"bytes,3,opt,name=target,proto3" json:"target,omitempty"` // Output only. Name of the verb executed by the operation. Verb string `protobuf:"bytes,4,opt,name=verb,proto3" json:"verb,omitempty"` // Output only. Human-readable status of the operation, if any. StatusMessage string `protobuf:"bytes,5,opt,name=status_message,json=statusMessage,proto3" json:"status_message,omitempty"` // Output only. Identifies whether the user has requested cancellation // of the operation. Operations that have successfully been cancelled // have [Operation.error][] value with a // [google.rpc.Status.code][google.rpc.Status.code] of 1, corresponding to // `Code.CANCELLED`. RequestedCancellation bool `protobuf:"varint,6,opt,name=requested_cancellation,json=requestedCancellation,proto3" json:"requested_cancellation,omitempty"` // Output only. API version used to start the operation. ApiVersion string `protobuf:"bytes,7,opt,name=api_version,json=apiVersion,proto3" json:"api_version,omitempty"` // contains filtered or unexported fields }
Represents the metadata of the long-running operation.
func (*OperationMetadata) Descriptor
deprecated
func (*OperationMetadata) Descriptor() ([]byte, []int)
Deprecated: Use OperationMetadata.ProtoReflect.Descriptor instead.
func (*OperationMetadata) GetApiVersion ¶
func (x *OperationMetadata) GetApiVersion() string
func (*OperationMetadata) GetCreateTime ¶
func (x *OperationMetadata) GetCreateTime() *timestamppb.Timestamp
func (*OperationMetadata) GetEndTime ¶
func (x *OperationMetadata) GetEndTime() *timestamppb.Timestamp
func (*OperationMetadata) GetRequestedCancellation ¶
func (x *OperationMetadata) GetRequestedCancellation() bool
func (*OperationMetadata) GetStatusMessage ¶
func (x *OperationMetadata) GetStatusMessage() string
func (*OperationMetadata) GetTarget ¶
func (x *OperationMetadata) GetTarget() string
func (*OperationMetadata) GetVerb ¶
func (x *OperationMetadata) GetVerb() string
func (*OperationMetadata) ProtoMessage ¶
func (*OperationMetadata) ProtoMessage()
func (*OperationMetadata) ProtoReflect ¶
func (x *OperationMetadata) ProtoReflect() protoreflect.Message
func (*OperationMetadata) Reset ¶
func (x *OperationMetadata) Reset()
func (*OperationMetadata) String ¶
func (x *OperationMetadata) String() string
type Runnable ¶
type Runnable struct { // The script or container to run. // // Types that are assignable to Executable: // // *Runnable_Container_ // *Runnable_Script_ // *Runnable_Barrier_ Executable isRunnable_Executable `protobuf_oneof:"executable"` // Optional. DisplayName is an optional field that can be provided by the // caller. If provided, it will be used in logs and other outputs to identify // the script, making it easier for users to understand the logs. If not // provided the index of the runnable will be used for outputs. DisplayName string `protobuf:"bytes,10,opt,name=display_name,json=displayName,proto3" json:"display_name,omitempty"` // Normally, a non-zero exit status causes the Task to fail. This flag allows // execution of other Runnables to continue instead. IgnoreExitStatus bool `protobuf:"varint,3,opt,name=ignore_exit_status,json=ignoreExitStatus,proto3" json:"ignore_exit_status,omitempty"` // This flag allows a Runnable to continue running in the background while the // Task executes subsequent Runnables. This is useful to provide services to // other Runnables (or to provide debugging support tools like SSH servers). Background bool `protobuf:"varint,4,opt,name=background,proto3" json:"background,omitempty"` // By default, after a Runnable fails, no further Runnable are executed. This // flag indicates that this Runnable must be run even if the Task has already // failed. This is useful for Runnables that copy output files off of the VM // or for debugging. // // The always_run flag does not override the Task's overall max_run_duration. // If the max_run_duration has expired then no further Runnables will execute, // not even always_run Runnables. AlwaysRun bool `protobuf:"varint,5,opt,name=always_run,json=alwaysRun,proto3" json:"always_run,omitempty"` // Environment variables for this Runnable (overrides variables set for the // whole Task or TaskGroup). Environment *Environment `protobuf:"bytes,7,opt,name=environment,proto3" json:"environment,omitempty"` // Timeout for this Runnable. Timeout *durationpb.Duration `protobuf:"bytes,8,opt,name=timeout,proto3" json:"timeout,omitempty"` // Labels for this Runnable. Labels map[string]string `` /* 153-byte string literal not displayed */ // contains filtered or unexported fields }
Runnable describes instructions for executing a specific script or container as part of a Task.
func (*Runnable) Descriptor
deprecated
func (*Runnable) GetAlwaysRun ¶
func (*Runnable) GetBackground ¶
func (*Runnable) GetBarrier ¶
func (x *Runnable) GetBarrier() *Runnable_Barrier
func (*Runnable) GetContainer ¶
func (x *Runnable) GetContainer() *Runnable_Container
func (*Runnable) GetDisplayName ¶ added in v1.6.0
func (*Runnable) GetEnvironment ¶
func (x *Runnable) GetEnvironment() *Environment
func (*Runnable) GetExecutable ¶
func (m *Runnable) GetExecutable() isRunnable_Executable
func (*Runnable) GetIgnoreExitStatus ¶
func (*Runnable) GetScript ¶
func (x *Runnable) GetScript() *Runnable_Script
func (*Runnable) GetTimeout ¶
func (x *Runnable) GetTimeout() *durationpb.Duration
func (*Runnable) ProtoMessage ¶
func (*Runnable) ProtoMessage()
func (*Runnable) ProtoReflect ¶
func (x *Runnable) ProtoReflect() protoreflect.Message
type Runnable_Barrier ¶
type Runnable_Barrier struct { // Barriers are identified by their index in runnable list. // Names are not required, but if present should be an identifier. Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"` // contains filtered or unexported fields }
Barrier runnable blocks until all tasks in a taskgroup reach it.
func (*Runnable_Barrier) Descriptor
deprecated
func (*Runnable_Barrier) Descriptor() ([]byte, []int)
Deprecated: Use Runnable_Barrier.ProtoReflect.Descriptor instead.
func (*Runnable_Barrier) GetName ¶
func (x *Runnable_Barrier) GetName() string
func (*Runnable_Barrier) ProtoMessage ¶
func (*Runnable_Barrier) ProtoMessage()
func (*Runnable_Barrier) ProtoReflect ¶
func (x *Runnable_Barrier) ProtoReflect() protoreflect.Message
func (*Runnable_Barrier) Reset ¶
func (x *Runnable_Barrier) Reset()
func (*Runnable_Barrier) String ¶
func (x *Runnable_Barrier) String() string
type Runnable_Barrier_ ¶
type Runnable_Barrier_ struct { // Barrier runnable. Barrier *Runnable_Barrier `protobuf:"bytes,6,opt,name=barrier,proto3,oneof"` }
type Runnable_Container ¶
type Runnable_Container struct { // The URI to pull the container image from. ImageUri string `protobuf:"bytes,1,opt,name=image_uri,json=imageUri,proto3" json:"image_uri,omitempty"` // Overrides the `CMD` specified in the container. If there is an ENTRYPOINT // (either in the container image or with the entrypoint field below) then // commands are appended as arguments to the ENTRYPOINT. Commands []string `protobuf:"bytes,2,rep,name=commands,proto3" json:"commands,omitempty"` // Overrides the `ENTRYPOINT` specified in the container. Entrypoint string `protobuf:"bytes,3,opt,name=entrypoint,proto3" json:"entrypoint,omitempty"` // Volumes to mount (bind mount) from the host machine files or directories // into the container, formatted to match docker run's --volume option, // e.g. /foo:/bar, or /foo:/bar:ro // // If the `TaskSpec.Volumes` field is specified but this field is not, Batch // will mount each volume from the host machine to the container with the // same mount path by default. In this case, the default mount option for // containers will be read-only (ro) for existing persistent disks and // read-write (rw) for other volume types, regardless of the original mount // options specified in `TaskSpec.Volumes`. If you need different mount // settings, you can explicitly configure them in this field. Volumes []string `protobuf:"bytes,7,rep,name=volumes,proto3" json:"volumes,omitempty"` // Arbitrary additional options to include in the "docker run" command when // running this container, e.g. "--network host". Options string `protobuf:"bytes,8,opt,name=options,proto3" json:"options,omitempty"` // If set to true, external network access to and from container will be // blocked, containers that are with block_external_network as true can // still communicate with each other, network cannot be specified in the // `container.options` field. BlockExternalNetwork bool `protobuf:"varint,9,opt,name=block_external_network,json=blockExternalNetwork,proto3" json:"block_external_network,omitempty"` // Optional username for logging in to a docker registry. If username // matches `projects/*/secrets/*/versions/*` then Batch will read the // username from the Secret Manager. Username string `protobuf:"bytes,10,opt,name=username,proto3" json:"username,omitempty"` // Optional password for logging in to a docker registry. If password // matches `projects/*/secrets/*/versions/*` then Batch will read the // password from the Secret Manager; Password string `protobuf:"bytes,11,opt,name=password,proto3" json:"password,omitempty"` // Optional. If set to true, this container runnable uses Image streaming. // // Use Image streaming to allow the runnable to initialize without // waiting for the entire container image to download, which can // significantly reduce startup time for large container images. // // When `enableImageStreaming` is set to true, the container // runtime is [containerd](https://containerd.io/) instead of Docker. // Additionally, this container runnable only supports the following // `container` subfields: `imageUri`, // `commands[]`, `entrypoint`, and // `volumes[]`; any other `container` subfields are ignored. // // For more information about the requirements and limitations for using // Image streaming with Batch, see the [`image-streaming` // sample on // GitHub](https://github.com/GoogleCloudPlatform/batch-samples/tree/main/api-samples/image-streaming). EnableImageStreaming bool `protobuf:"varint,12,opt,name=enable_image_streaming,json=enableImageStreaming,proto3" json:"enable_image_streaming,omitempty"` // contains filtered or unexported fields }
Container runnable.
func (*Runnable_Container) Descriptor
deprecated
func (*Runnable_Container) Descriptor() ([]byte, []int)
Deprecated: Use Runnable_Container.ProtoReflect.Descriptor instead.
func (*Runnable_Container) GetBlockExternalNetwork ¶
func (x *Runnable_Container) GetBlockExternalNetwork() bool
func (*Runnable_Container) GetCommands ¶
func (x *Runnable_Container) GetCommands() []string
func (*Runnable_Container) GetEnableImageStreaming ¶ added in v1.8.0
func (x *Runnable_Container) GetEnableImageStreaming() bool
func (*Runnable_Container) GetEntrypoint ¶
func (x *Runnable_Container) GetEntrypoint() string
func (*Runnable_Container) GetImageUri ¶
func (x *Runnable_Container) GetImageUri() string
func (*Runnable_Container) GetOptions ¶
func (x *Runnable_Container) GetOptions() string
func (*Runnable_Container) GetPassword ¶
func (x *Runnable_Container) GetPassword() string
func (*Runnable_Container) GetUsername ¶
func (x *Runnable_Container) GetUsername() string
func (*Runnable_Container) GetVolumes ¶
func (x *Runnable_Container) GetVolumes() []string
func (*Runnable_Container) ProtoMessage ¶
func (*Runnable_Container) ProtoMessage()
func (*Runnable_Container) ProtoReflect ¶
func (x *Runnable_Container) ProtoReflect() protoreflect.Message
func (*Runnable_Container) Reset ¶
func (x *Runnable_Container) Reset()
func (*Runnable_Container) String ¶
func (x *Runnable_Container) String() string
type Runnable_Container_ ¶
type Runnable_Container_ struct { // Container runnable. Container *Runnable_Container `protobuf:"bytes,1,opt,name=container,proto3,oneof"` }
type Runnable_Script ¶
type Runnable_Script struct { // Types that are assignable to Command: // // *Runnable_Script_Path // *Runnable_Script_Text Command isRunnable_Script_Command `protobuf_oneof:"command"` // contains filtered or unexported fields }
Script runnable.
func (*Runnable_Script) Descriptor
deprecated
func (*Runnable_Script) Descriptor() ([]byte, []int)
Deprecated: Use Runnable_Script.ProtoReflect.Descriptor instead.
func (*Runnable_Script) GetCommand ¶
func (m *Runnable_Script) GetCommand() isRunnable_Script_Command
func (*Runnable_Script) GetPath ¶
func (x *Runnable_Script) GetPath() string
func (*Runnable_Script) GetText ¶
func (x *Runnable_Script) GetText() string
func (*Runnable_Script) ProtoMessage ¶
func (*Runnable_Script) ProtoMessage()
func (*Runnable_Script) ProtoReflect ¶
func (x *Runnable_Script) ProtoReflect() protoreflect.Message
func (*Runnable_Script) Reset ¶
func (x *Runnable_Script) Reset()
func (*Runnable_Script) String ¶
func (x *Runnable_Script) String() string
type Runnable_Script_ ¶
type Runnable_Script_ struct { // Script runnable. Script *Runnable_Script `protobuf:"bytes,2,opt,name=script,proto3,oneof"` }
type Runnable_Script_Path ¶
type Runnable_Script_Path struct { // Script file path on the host VM. // // To specify an interpreter, please add a `#!<interpreter>`(also known as // [shebang line](https://en.wikipedia.org/wiki/Shebang_(Unix))) as the // first line of the file.(For example, to execute the script using bash, // `#!/bin/bash` should be the first line of the file. To execute the // script using`Python3`, `#!/usr/bin/env python3` should be the first // line of the file.) Otherwise, the file will by default be excuted by // `/bin/sh`. Path string `protobuf:"bytes,1,opt,name=path,proto3,oneof"` }
type Runnable_Script_Text ¶
type Runnable_Script_Text struct { // Shell script text. // // To specify an interpreter, please add a `#!<interpreter>\n` at the // beginning of the text.(For example, to execute the script using bash, // `#!/bin/bash\n` should be added. To execute the script using`Python3`, // `#!/usr/bin/env python3\n` should be added.) Otherwise, the script will // by default be excuted by `/bin/sh`. Text string `protobuf:"bytes,2,opt,name=text,proto3,oneof"` }
type ServiceAccount ¶
type ServiceAccount struct { // Email address of the service account. If not specified, the default // Compute Engine service account for the project will be used. If instance // template is being used, the service account has to be specified in the // instance template and it has to match the email field here. Email string `protobuf:"bytes,1,opt,name=email,proto3" json:"email,omitempty"` // List of scopes to be enabled for this service account on the VM, in // addition to the cloud-platform API scope that will be added by default. Scopes []string `protobuf:"bytes,2,rep,name=scopes,proto3" json:"scopes,omitempty"` // contains filtered or unexported fields }
Carries information about a Google Cloud service account.
func (*ServiceAccount) Descriptor
deprecated
func (*ServiceAccount) Descriptor() ([]byte, []int)
Deprecated: Use ServiceAccount.ProtoReflect.Descriptor instead.
func (*ServiceAccount) GetEmail ¶
func (x *ServiceAccount) GetEmail() string
func (*ServiceAccount) GetScopes ¶ added in v0.7.0
func (x *ServiceAccount) GetScopes() []string
func (*ServiceAccount) ProtoMessage ¶
func (*ServiceAccount) ProtoMessage()
func (*ServiceAccount) ProtoReflect ¶
func (x *ServiceAccount) ProtoReflect() protoreflect.Message
func (*ServiceAccount) Reset ¶
func (x *ServiceAccount) Reset()
func (*ServiceAccount) String ¶
func (x *ServiceAccount) String() string
type StatusEvent ¶
type StatusEvent struct { // Type of the event. Type string `protobuf:"bytes,3,opt,name=type,proto3" json:"type,omitempty"` // Description of the event. Description string `protobuf:"bytes,1,opt,name=description,proto3" json:"description,omitempty"` // The time this event occurred. EventTime *timestamppb.Timestamp `protobuf:"bytes,2,opt,name=event_time,json=eventTime,proto3" json:"event_time,omitempty"` // Task Execution TaskExecution *TaskExecution `protobuf:"bytes,4,opt,name=task_execution,json=taskExecution,proto3" json:"task_execution,omitempty"` // Task State TaskState TaskStatus_State `` /* 133-byte string literal not displayed */ // contains filtered or unexported fields }
Status event
func (*StatusEvent) Descriptor
deprecated
func (*StatusEvent) Descriptor() ([]byte, []int)
Deprecated: Use StatusEvent.ProtoReflect.Descriptor instead.
func (*StatusEvent) GetDescription ¶
func (x *StatusEvent) GetDescription() string
func (*StatusEvent) GetEventTime ¶
func (x *StatusEvent) GetEventTime() *timestamppb.Timestamp
func (*StatusEvent) GetTaskExecution ¶
func (x *StatusEvent) GetTaskExecution() *TaskExecution
func (*StatusEvent) GetTaskState ¶ added in v1.0.0
func (x *StatusEvent) GetTaskState() TaskStatus_State
func (*StatusEvent) GetType ¶
func (x *StatusEvent) GetType() string
func (*StatusEvent) ProtoMessage ¶
func (*StatusEvent) ProtoMessage()
func (*StatusEvent) ProtoReflect ¶
func (x *StatusEvent) ProtoReflect() protoreflect.Message
func (*StatusEvent) Reset ¶
func (x *StatusEvent) Reset()
func (*StatusEvent) String ¶
func (x *StatusEvent) String() string
type Task ¶
type Task struct { // Task name. // The name is generated from the parent TaskGroup name and 'id' field. // For example: // "projects/123456/locations/us-west1/jobs/job01/taskGroups/group01/tasks/task01". Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"` // Task Status. Status *TaskStatus `protobuf:"bytes,2,opt,name=status,proto3" json:"status,omitempty"` // contains filtered or unexported fields }
A Cloud Batch task.
func (*Task) Descriptor
deprecated
func (*Task) GetStatus ¶
func (x *Task) GetStatus() *TaskStatus
func (*Task) ProtoMessage ¶
func (*Task) ProtoMessage()
func (*Task) ProtoReflect ¶
func (x *Task) ProtoReflect() protoreflect.Message
type TaskExecution ¶
type TaskExecution struct { // When task is completed as the status of FAILED or SUCCEEDED, // exit code is for one task execution result, default is 0 as success. ExitCode int32 `protobuf:"varint,1,opt,name=exit_code,json=exitCode,proto3" json:"exit_code,omitempty"` // contains filtered or unexported fields }
This Task Execution field includes detail information for task execution procedures, based on StatusEvent types.
func (*TaskExecution) Descriptor
deprecated
func (*TaskExecution) Descriptor() ([]byte, []int)
Deprecated: Use TaskExecution.ProtoReflect.Descriptor instead.
func (*TaskExecution) GetExitCode ¶
func (x *TaskExecution) GetExitCode() int32
func (*TaskExecution) ProtoMessage ¶
func (*TaskExecution) ProtoMessage()
func (*TaskExecution) ProtoReflect ¶
func (x *TaskExecution) ProtoReflect() protoreflect.Message
func (*TaskExecution) Reset ¶
func (x *TaskExecution) Reset()
func (*TaskExecution) String ¶
func (x *TaskExecution) String() string
type TaskGroup ¶
type TaskGroup struct { // Output only. TaskGroup name. // The system generates this field based on parent Job name. // For example: // "projects/123456/locations/us-west1/jobs/job01/taskGroups/group01". Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"` // Required. Tasks in the group share the same task spec. TaskSpec *TaskSpec `protobuf:"bytes,3,opt,name=task_spec,json=taskSpec,proto3" json:"task_spec,omitempty"` // Number of Tasks in the TaskGroup. // Default is 1. TaskCount int64 `protobuf:"varint,4,opt,name=task_count,json=taskCount,proto3" json:"task_count,omitempty"` // Max number of tasks that can run in parallel. // Default to min(task_count, parallel tasks per job limit). // See: [Job Limits](https://cloud.google.com/batch/quotas#job_limits). // Field parallelism must be 1 if the scheduling_policy is IN_ORDER. Parallelism int64 `protobuf:"varint,5,opt,name=parallelism,proto3" json:"parallelism,omitempty"` // Scheduling policy for Tasks in the TaskGroup. // The default value is AS_SOON_AS_POSSIBLE. SchedulingPolicy TaskGroup_SchedulingPolicy `` /* 164-byte string literal not displayed */ // An array of environment variable mappings, which are passed to Tasks with // matching indices. If task_environments is used then task_count should // not be specified in the request (and will be ignored). Task count will be // the length of task_environments. // // Tasks get a BATCH_TASK_INDEX and BATCH_TASK_COUNT environment variable, in // addition to any environment variables set in task_environments, specifying // the number of Tasks in the Task's parent TaskGroup, and the specific Task's // index in the TaskGroup (0 through BATCH_TASK_COUNT - 1). TaskEnvironments []*Environment `protobuf:"bytes,9,rep,name=task_environments,json=taskEnvironments,proto3" json:"task_environments,omitempty"` // Max number of tasks that can be run on a VM at the same time. // If not specified, the system will decide a value based on available // compute resources on a VM and task requirements. TaskCountPerNode int64 `protobuf:"varint,10,opt,name=task_count_per_node,json=taskCountPerNode,proto3" json:"task_count_per_node,omitempty"` // When true, Batch will populate a file with a list of all VMs assigned to // the TaskGroup and set the BATCH_HOSTS_FILE environment variable to the path // of that file. Defaults to false. RequireHostsFile bool `protobuf:"varint,11,opt,name=require_hosts_file,json=requireHostsFile,proto3" json:"require_hosts_file,omitempty"` // When true, Batch will configure SSH to allow passwordless login between // VMs running the Batch tasks in the same TaskGroup. PermissiveSsh bool `protobuf:"varint,12,opt,name=permissive_ssh,json=permissiveSsh,proto3" json:"permissive_ssh,omitempty"` // Optional. If not set or set to false, Batch will use root user to execute // runnables. If set to true, Batch will make sure to run the runnables using // non-root user. Currently, the non-root user Batch used is generated by OS // login. Reference: https://cloud.google.com/compute/docs/oslogin RunAsNonRoot bool `protobuf:"varint,14,opt,name=run_as_non_root,json=runAsNonRoot,proto3" json:"run_as_non_root,omitempty"` // contains filtered or unexported fields }
A TaskGroup defines one or more Tasks that all share the same TaskSpec.
func (*TaskGroup) Descriptor
deprecated
func (*TaskGroup) GetParallelism ¶
func (*TaskGroup) GetPermissiveSsh ¶
func (*TaskGroup) GetRequireHostsFile ¶
func (*TaskGroup) GetRunAsNonRoot ¶ added in v1.8.0
func (*TaskGroup) GetSchedulingPolicy ¶ added in v1.3.0
func (x *TaskGroup) GetSchedulingPolicy() TaskGroup_SchedulingPolicy
func (*TaskGroup) GetTaskCount ¶
func (*TaskGroup) GetTaskCountPerNode ¶
func (*TaskGroup) GetTaskEnvironments ¶
func (x *TaskGroup) GetTaskEnvironments() []*Environment
func (*TaskGroup) GetTaskSpec ¶
func (*TaskGroup) ProtoMessage ¶
func (*TaskGroup) ProtoMessage()
func (*TaskGroup) ProtoReflect ¶
func (x *TaskGroup) ProtoReflect() protoreflect.Message
type TaskGroup_SchedulingPolicy ¶ added in v1.3.0
type TaskGroup_SchedulingPolicy int32
How Tasks in the TaskGroup should be scheduled relative to each other.
const ( // Unspecified. TaskGroup_SCHEDULING_POLICY_UNSPECIFIED TaskGroup_SchedulingPolicy = 0 // Run Tasks as soon as resources are available. // // Tasks might be executed in parallel depending on parallelism and // task_count values. TaskGroup_AS_SOON_AS_POSSIBLE TaskGroup_SchedulingPolicy = 1 // Run Tasks sequentially with increased task index. TaskGroup_IN_ORDER TaskGroup_SchedulingPolicy = 2 )
func (TaskGroup_SchedulingPolicy) Descriptor ¶ added in v1.3.0
func (TaskGroup_SchedulingPolicy) Descriptor() protoreflect.EnumDescriptor
func (TaskGroup_SchedulingPolicy) Enum ¶ added in v1.3.0
func (x TaskGroup_SchedulingPolicy) Enum() *TaskGroup_SchedulingPolicy
func (TaskGroup_SchedulingPolicy) EnumDescriptor
deprecated
added in
v1.3.0
func (TaskGroup_SchedulingPolicy) EnumDescriptor() ([]byte, []int)
Deprecated: Use TaskGroup_SchedulingPolicy.Descriptor instead.
func (TaskGroup_SchedulingPolicy) Number ¶ added in v1.3.0
func (x TaskGroup_SchedulingPolicy) Number() protoreflect.EnumNumber
func (TaskGroup_SchedulingPolicy) String ¶ added in v1.3.0
func (x TaskGroup_SchedulingPolicy) String() string
func (TaskGroup_SchedulingPolicy) Type ¶ added in v1.3.0
func (TaskGroup_SchedulingPolicy) Type() protoreflect.EnumType
type TaskSpec ¶
type TaskSpec struct { // The sequence of scripts or containers to run for this Task. Each Task using // this TaskSpec executes its list of runnables in order. The Task succeeds if // all of its runnables either exit with a zero status or any that exit with a // non-zero status have the ignore_exit_status flag. // // Background runnables are killed automatically (if they have not already // exited) a short time after all foreground runnables have completed. Even // though this is likely to result in a non-zero exit status for the // background runnable, these automatic kills are not treated as Task // failures. Runnables []*Runnable `protobuf:"bytes,8,rep,name=runnables,proto3" json:"runnables,omitempty"` // ComputeResource requirements. ComputeResource *ComputeResource `protobuf:"bytes,3,opt,name=compute_resource,json=computeResource,proto3" json:"compute_resource,omitempty"` // Maximum duration the task should run. // The task will be killed and marked as FAILED if over this limit. MaxRunDuration *durationpb.Duration `protobuf:"bytes,4,opt,name=max_run_duration,json=maxRunDuration,proto3" json:"max_run_duration,omitempty"` // Maximum number of retries on failures. // The default, 0, which means never retry. // The valid value range is [0, 10]. MaxRetryCount int32 `protobuf:"varint,5,opt,name=max_retry_count,json=maxRetryCount,proto3" json:"max_retry_count,omitempty"` // Lifecycle management schema when any task in a task group is failed. // Currently we only support one lifecycle policy. // When the lifecycle policy condition is met, // the action in the policy will execute. // If task execution result does not meet with the defined lifecycle // policy, we consider it as the default policy. // Default policy means if the exit code is 0, exit task. // If task ends with non-zero exit code, retry the task with max_retry_count. LifecyclePolicies []*LifecyclePolicy `protobuf:"bytes,9,rep,name=lifecycle_policies,json=lifecyclePolicies,proto3" json:"lifecycle_policies,omitempty"` // Deprecated: please use environment(non-plural) instead. // // Deprecated: Marked as deprecated in google/cloud/batch/v1/task.proto. Environments map[string]string `` /* 165-byte string literal not displayed */ // Volumes to mount before running Tasks using this TaskSpec. Volumes []*Volume `protobuf:"bytes,7,rep,name=volumes,proto3" json:"volumes,omitempty"` // Environment variables to set before running the Task. Environment *Environment `protobuf:"bytes,10,opt,name=environment,proto3" json:"environment,omitempty"` // contains filtered or unexported fields }
Spec of a task
func (*TaskSpec) Descriptor
deprecated
func (*TaskSpec) GetComputeResource ¶
func (x *TaskSpec) GetComputeResource() *ComputeResource
func (*TaskSpec) GetEnvironment ¶
func (x *TaskSpec) GetEnvironment() *Environment
func (*TaskSpec) GetEnvironments
deprecated
func (*TaskSpec) GetLifecyclePolicies ¶
func (x *TaskSpec) GetLifecyclePolicies() []*LifecyclePolicy
func (*TaskSpec) GetMaxRetryCount ¶
func (*TaskSpec) GetMaxRunDuration ¶
func (x *TaskSpec) GetMaxRunDuration() *durationpb.Duration
func (*TaskSpec) GetRunnables ¶
func (*TaskSpec) GetVolumes ¶
func (*TaskSpec) ProtoMessage ¶
func (*TaskSpec) ProtoMessage()
func (*TaskSpec) ProtoReflect ¶
func (x *TaskSpec) ProtoReflect() protoreflect.Message
type TaskStatus ¶
type TaskStatus struct { // Task state State TaskStatus_State `protobuf:"varint,1,opt,name=state,proto3,enum=google.cloud.batch.v1.TaskStatus_State" json:"state,omitempty"` // Detailed info about why the state is reached. StatusEvents []*StatusEvent `protobuf:"bytes,2,rep,name=status_events,json=statusEvents,proto3" json:"status_events,omitempty"` // contains filtered or unexported fields }
Status of a task
func (*TaskStatus) Descriptor
deprecated
func (*TaskStatus) Descriptor() ([]byte, []int)
Deprecated: Use TaskStatus.ProtoReflect.Descriptor instead.
func (*TaskStatus) GetState ¶
func (x *TaskStatus) GetState() TaskStatus_State
func (*TaskStatus) GetStatusEvents ¶
func (x *TaskStatus) GetStatusEvents() []*StatusEvent
func (*TaskStatus) ProtoMessage ¶
func (*TaskStatus) ProtoMessage()
func (*TaskStatus) ProtoReflect ¶
func (x *TaskStatus) ProtoReflect() protoreflect.Message
func (*TaskStatus) Reset ¶
func (x *TaskStatus) Reset()
func (*TaskStatus) String ¶
func (x *TaskStatus) String() string
type TaskStatus_State ¶
type TaskStatus_State int32
Task states.
const ( // Unknown state. TaskStatus_STATE_UNSPECIFIED TaskStatus_State = 0 // The Task is created and waiting for resources. TaskStatus_PENDING TaskStatus_State = 1 // The Task is assigned to at least one VM. TaskStatus_ASSIGNED TaskStatus_State = 2 // The Task is running. TaskStatus_RUNNING TaskStatus_State = 3 // The Task has failed. TaskStatus_FAILED TaskStatus_State = 4 // The Task has succeeded. TaskStatus_SUCCEEDED TaskStatus_State = 5 // The Task has not been executed when the Job finishes. TaskStatus_UNEXECUTED TaskStatus_State = 6 )
func (TaskStatus_State) Descriptor ¶
func (TaskStatus_State) Descriptor() protoreflect.EnumDescriptor
func (TaskStatus_State) Enum ¶
func (x TaskStatus_State) Enum() *TaskStatus_State
func (TaskStatus_State) EnumDescriptor
deprecated
func (TaskStatus_State) EnumDescriptor() ([]byte, []int)
Deprecated: Use TaskStatus_State.Descriptor instead.
func (TaskStatus_State) Number ¶
func (x TaskStatus_State) Number() protoreflect.EnumNumber
func (TaskStatus_State) String ¶
func (x TaskStatus_State) String() string
func (TaskStatus_State) Type ¶
func (TaskStatus_State) Type() protoreflect.EnumType
type UnimplementedBatchServiceServer ¶
type UnimplementedBatchServiceServer struct { }
UnimplementedBatchServiceServer can be embedded to have forward compatible implementations.
func (*UnimplementedBatchServiceServer) CreateJob ¶
func (*UnimplementedBatchServiceServer) CreateJob(context.Context, *CreateJobRequest) (*Job, error)
func (*UnimplementedBatchServiceServer) DeleteJob ¶
func (*UnimplementedBatchServiceServer) DeleteJob(context.Context, *DeleteJobRequest) (*longrunningpb.Operation, error)
func (*UnimplementedBatchServiceServer) GetJob ¶
func (*UnimplementedBatchServiceServer) GetJob(context.Context, *GetJobRequest) (*Job, error)
func (*UnimplementedBatchServiceServer) GetTask ¶
func (*UnimplementedBatchServiceServer) GetTask(context.Context, *GetTaskRequest) (*Task, error)
func (*UnimplementedBatchServiceServer) ListJobs ¶
func (*UnimplementedBatchServiceServer) ListJobs(context.Context, *ListJobsRequest) (*ListJobsResponse, error)
func (*UnimplementedBatchServiceServer) ListTasks ¶
func (*UnimplementedBatchServiceServer) ListTasks(context.Context, *ListTasksRequest) (*ListTasksResponse, error)
type Volume ¶
type Volume struct { // The source for the volume. // // Types that are assignable to Source: // // *Volume_Nfs // *Volume_Gcs // *Volume_DeviceName Source isVolume_Source `protobuf_oneof:"source"` // The mount path for the volume, e.g. /mnt/disks/share. MountPath string `protobuf:"bytes,4,opt,name=mount_path,json=mountPath,proto3" json:"mount_path,omitempty"` // For Google Cloud Storage (GCS), mount options are the options supported by // the gcsfuse tool (https://github.com/GoogleCloudPlatform/gcsfuse). // For existing persistent disks, mount options provided by the // mount command (https://man7.org/linux/man-pages/man8/mount.8.html) except // writing are supported. This is due to restrictions of multi-writer mode // (https://cloud.google.com/compute/docs/disks/sharing-disks-between-vms). // For other attached disks and Network File System (NFS), mount options are // these supported by the mount command // (https://man7.org/linux/man-pages/man8/mount.8.html). MountOptions []string `protobuf:"bytes,5,rep,name=mount_options,json=mountOptions,proto3" json:"mount_options,omitempty"` // contains filtered or unexported fields }
Volume describes a volume and parameters for it to be mounted to a VM.
func (*Volume) Descriptor
deprecated
func (*Volume) GetDeviceName ¶
func (*Volume) GetMountOptions ¶
func (*Volume) GetMountPath ¶
func (*Volume) ProtoMessage ¶
func (*Volume) ProtoMessage()
func (*Volume) ProtoReflect ¶
func (x *Volume) ProtoReflect() protoreflect.Message
type Volume_DeviceName ¶
type Volume_DeviceName struct { // Device name of an attached disk volume, which should align with a // device_name specified by // job.allocation_policy.instances[0].policy.disks[i].device_name or // defined by the given instance template in // job.allocation_policy.instances[0].instance_template. DeviceName string `protobuf:"bytes,6,opt,name=device_name,json=deviceName,proto3,oneof"` }
type Volume_Gcs ¶
type Volume_Gcs struct { // A Google Cloud Storage (GCS) volume. Gcs *GCS `protobuf:"bytes,3,opt,name=gcs,proto3,oneof"` }
type Volume_Nfs ¶
type Volume_Nfs struct { // A Network File System (NFS) volume. For example, a // Filestore file share. Nfs *NFS `protobuf:"bytes,1,opt,name=nfs,proto3,oneof"` }