batch

package
v0.0.0-...-a8a6208 Latest Latest
Warning

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

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

Documentation

Index

Constants

This section is empty.

Variables

View Source 
var (
	Job_SchedulingPolicy_name = map[int32]string{
		0: "SCHEDULING_POLICY_UNSPECIFIED",
		1: "AS_SOON_AS_POSSIBLE",
	}
	Job_SchedulingPolicy_value = map[string]int32{
		"SCHEDULING_POLICY_UNSPECIFIED": 0,
		"AS_SOON_AS_POSSIBLE":           1,
	}
)

Enum value maps for Job_SchedulingPolicy.

View Source 
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.

View Source 
var (
	JobDependency_Type_name = map[int32]string{
		0: "TYPE_UNSPECIFIED",
		1: "SUCCEEDED",
		2: "FAILED",
		3: "FINISHED",
	}
	JobDependency_Type_value = map[string]int32{
		"TYPE_UNSPECIFIED": 0,
		"SUCCEEDED":        1,
		"FAILED":           2,
		"FINISHED":         3,
	}
)

Enum value maps for JobDependency_Type.

View Source 
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.

View Source 
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.

View Source 
var (
	TaskGroup_SchedulingPolicy_name = map[int32]string{
		0: "SCHEDULING_POLICY_UNSPECIFIED",
		1: "AS_SOON_AS_POSSIBLE",
	}
	TaskGroup_SchedulingPolicy_value = map[string]int32{
		"SCHEDULING_POLICY_UNSPECIFIED": 0,
		"AS_SOON_AS_POSSIBLE":           1,
	}
)

Enum value maps for TaskGroup_SchedulingPolicy.

View Source 
var (
	TaskStatus_State_name = map[int32]string{
		0: "STATE_UNSPECIFIED",
		1: "PENDING",
		2: "ASSIGNED",
		3: "RUNNING",
		4: "FAILED",
		5: "SUCCEEDED",
	}
	TaskStatus_State_value = map[string]int32{
		"STATE_UNSPECIFIED": 0,
		"PENDING":           1,
		"ASSIGNED":          2,
		"RUNNING":           3,
		"FAILED":            4,
		"SUCCEEDED":         5,
	}
)

Enum value maps for TaskStatus_State.

View Source 
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.

View Source 
var File_google_cloud_batch_v1alpha1_batch_proto protoreflect.FileDescriptor
View Source 
var File_google_cloud_batch_v1alpha1_job_proto protoreflect.FileDescriptor
View Source 
var File_google_cloud_batch_v1alpha1_task_proto protoreflect.FileDescriptor
View Source 
var File_google_cloud_batch_v1alpha1_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"`
	// Create only instances allowed by this policy.
	Instance *AllocationPolicy_InstancePolicy `protobuf:"bytes,2,opt,name=instance,proto3" json:"instance,omitempty"`
	// Create instances from the first instance template - MVP
	// Use 'gcloud compute instance-templates list` to see available templates
	// in the project If specified, it overrides the 'instance' field.
	InstanceTemplates []string `protobuf:"bytes,3,rep,name=instance_templates,json=instanceTemplates,proto3" json:"instance_templates,omitempty"`
	// Create only instances in the listed provisiong models.
	// Default to allow all.
	//
	// Currently only the first model of the provisioning_models list will be
	// considered; specifying additional models (e.g., 2nd, 3rd, etc.) is a no-op.
	ProvisioningModels []AllocationPolicy_ProvisioningModel `` /* 191-byte string literal not displayed */
	// Email of the service account that VMs will run as.
	ServiceAccount string `protobuf:"bytes,5,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.
	Network *AllocationPolicy_NetworkPolicy `protobuf:"bytes,7,opt,name=network,proto3" json:"network,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) GetInstance 

func (x *AllocationPolicy) GetInstance() *AllocationPolicy_InstancePolicy

func (*AllocationPolicy) GetInstanceTemplates 

func (x *AllocationPolicy) GetInstanceTemplates() []string

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) GetProvisioningModels 

func (x *AllocationPolicy) GetProvisioningModels() []AllocationPolicy_ProvisioningModel

func (*AllocationPolicy) GetServiceAccount 

func (x *AllocationPolicy) GetServiceAccount() 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_InstancePolicy 

type AllocationPolicy_InstancePolicy struct {

	// A list of allowed Compute Engine machine types, for example,
	// e2-standard-4. Default is empty which means allowing all.
	AllowedMachineTypes []string `protobuf:"bytes,1,rep,name=allowed_machine_types,json=allowedMachineTypes,proto3" json:"allowed_machine_types,omitempty"`
	// A list of denied Compute Engine machine types.
	// Default is empty which means denying none.
	// A machine type is allowed if it matches 'allowed_machine_types' AND
	// does not match 'denied_machine_types'.
	// For example,
	//   allowed_machine_types = "e2-standard"
	//   denied_machine_types = "e2-standard-2, e2-standard-4"
	// means using all E2 standard machine types except for 'e2-standard-2' and
	// 'e2-standard-4.
	//
	// [NotImplemented]
	DeniedMachineTypes []string `protobuf:"bytes,2,rep,name=denied_machine_types,json=deniedMachineTypes,proto3" json:"denied_machine_types,omitempty"`
	// A list of allowed CPU platforms, for example,
	// "Intel Cascade Lake", "AMD Rome".
	// Default is empty which means allowing all.
	//
	// [NotImplemented]
	AllowedCpuPlatforms []string `protobuf:"bytes,3,rep,name=allowed_cpu_platforms,json=allowedCpuPlatforms,proto3" json:"allowed_cpu_platforms,omitempty"`
	// A list of denied CPU platforms.
	// Default is empty which means denying none.
	// A CPU platform is allowed if it matches 'allowed_cpu_platforms' AND
	// does not match 'denied_cpu_platforms'.
	// If a CPU platform belongs to both lists, it will be denied.
	//
	// [NotImplemented]
	DeniedCpuPlatforms []string `protobuf:"bytes,4,rep,name=denied_cpu_platforms,json=deniedCpuPlatforms,proto3" json:"denied_cpu_platforms,omitempty"`
	// A list of allowed accelerator types (GPU models), for example,
	// "nvidia-tesla-t4". Default is empty which means allowing all.
	//
	// [NotImplemented]
	AllowedAcceleratorTypes []string `` /* 132-byte string literal not displayed */
	// A list of denied accelerator types (GPU models).
	// Default is empty which means denying none.
	// A accelerator type is allowed if it matches 'allowed_accelerator_types'
	// AND does not match 'denied__accelerator_types'.
	//
	// [NotImplemented]
	DeniedAcceleratorTypes []string `` /* 129-byte string literal not displayed */
	// The number of accelerators per VM instance.
	//
	// [NotImplemented]
	AcceleratorCount int64 `protobuf:"varint,7,opt,name=accelerator_count,json=acceleratorCount,proto3" json:"accelerator_count,omitempty"`
	// contains filtered or unexported fields
}

InstancePolicy describes what instances should be created for the Job.

func (*AllocationPolicy_InstancePolicy) Descriptor deprecated 

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

Deprecated: Use AllocationPolicy_InstancePolicy.ProtoReflect.Descriptor instead.

func (*AllocationPolicy_InstancePolicy) GetAcceleratorCount 

func (x *AllocationPolicy_InstancePolicy) GetAcceleratorCount() int64

func (*AllocationPolicy_InstancePolicy) GetAllowedAcceleratorTypes 

func (x *AllocationPolicy_InstancePolicy) GetAllowedAcceleratorTypes() []string

func (*AllocationPolicy_InstancePolicy) GetAllowedCpuPlatforms 

func (x *AllocationPolicy_InstancePolicy) GetAllowedCpuPlatforms() []string

func (*AllocationPolicy_InstancePolicy) GetAllowedMachineTypes 

func (x *AllocationPolicy_InstancePolicy) GetAllowedMachineTypes() []string

func (*AllocationPolicy_InstancePolicy) GetDeniedAcceleratorTypes 

func (x *AllocationPolicy_InstancePolicy) GetDeniedAcceleratorTypes() []string

func (*AllocationPolicy_InstancePolicy) GetDeniedCpuPlatforms 

func (x *AllocationPolicy_InstancePolicy) GetDeniedCpuPlatforms() []string

func (*AllocationPolicy_InstancePolicy) GetDeniedMachineTypes 

func (x *AllocationPolicy_InstancePolicy) GetDeniedMachineTypes() []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_LocationPolicy 

type AllocationPolicy_LocationPolicy struct {

	// A list of allowed location names represented by internal URLs,
	// for example, zones/us-central1-a, regions/us-west1.
	// First location in the list should be a region.
	AllowedLocations []string `protobuf:"bytes,1,rep,name=allowed_locations,json=allowedLocations,proto3" json:"allowed_locations,omitempty"`
	// A list of denied location names.
	DeniedLocations []string `protobuf:"bytes,2,rep,name=denied_locations,json=deniedLocations,proto3" json:"denied_locations,omitempty"`
	// contains filtered or unexported fields
}

Be consistent with LocationPolicy in //cloud/cluster/api/mixter_instances.proto.

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) GetDeniedLocations 

func (x *AllocationPolicy_LocationPolicy) GetDeniedLocations() []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 the network resource.
	Network string `protobuf:"bytes,1,opt,name=network,proto3" json:"network,omitempty"`
	// The URL of the Subnetwork resource.
	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 network configurations for instances created for the job.

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_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) (*longrunning.Operation, error)
	// List all Jobs for a project.
	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) (*longrunning.Operation, error)
	// List all Jobs for a project.
	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 int64 `protobuf:"varint,1,opt,name=cpu_milli,json=cpuMilli,proto3" json:"cpu_milli,omitempty"`
	// Memory in MiB.
	MemoryMib int64 `protobuf:"varint,2,opt,name=memory_mib,json=memoryMib,proto3" json:"memory_mib,omitempty"`
	// The GPU count.
	GpuCount int64 `protobuf:"varint,3,opt,name=gpu_count,json=gpuCount,proto3" json:"gpu_count,omitempty"`
	// Boot disk size in MiB
	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

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) GetGpuCount 

func (x *ComputeResource) GetGpuCount() 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.
	// Format: 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.
	// Only alphanumeric characters or '-' 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 t
	// he 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 t
	// he 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 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 source config.

func (*GCS) Descriptor deprecated 

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

Deprecated: Use GCS.ProtoReflect.Descriptor instead.

func (*GCS) GetRemotePath 

func (x *GCS) GetRemotePath() string

func (*GCS) ProtoMessage 

func (*GCS) ProtoMessage()

func (*GCS) ProtoReflect 

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

func (*GCS) Reset 

func (x *GCS) Reset()

func (*GCS) String 

func (x *GCS) String() string

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 {

	// Job name.
	// It must have the format of "projects/*/locations/*/jobs/*".
	// For example: "projects/123456/locations/us-west1/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).
	// A job with higher priority value will be scheduled to run earlier.
	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"`
	// Scheduling policy for TaskGroups in the job.
	SchedulingPolicy Job_SchedulingPolicy `` /* 164-byte string literal not displayed */
	// At least one of the dependencies must be satisfied before the Job is
	// scheduled to run.
	// Only one JobDependency is supported now.
	// [NotImplemented]
	Dependencies []*JobDependency `protobuf:"bytes,6,rep,name=dependencies,proto3" json:"dependencies,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"`
	// Job notification.
	Notification *JobNotification `protobuf:"bytes,10,opt,name=notification,proto3" json:"notification,omitempty"`
	// When the Job was created.
	CreateTime *timestamppb.Timestamp `protobuf:"bytes,11,opt,name=create_time,json=createTime,proto3" json:"create_time,omitempty"`
	// 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"`
	// contains filtered or unexported fields
}

The Cloud Batch Job description.

func (*Job) Descriptor deprecated 

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

Deprecated: Use Job.ProtoReflect.Descriptor instead.

func (*Job) GetAllocationPolicy 

func (x *Job) GetAllocationPolicy() *AllocationPolicy

func (*Job) GetCreateTime 

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

func (*Job) GetDependencies 

func (x *Job) GetDependencies() []*JobDependency

func (*Job) GetLabels 

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

func (*Job) GetLogsPolicy 

func (x *Job) GetLogsPolicy() *LogsPolicy

func (*Job) GetName 

func (x *Job) GetName() string

func (*Job) GetNotification 

func (x *Job) GetNotification() *JobNotification

func (*Job) GetPriority 

func (x *Job) GetPriority() int64

func (*Job) GetSchedulingPolicy 

func (x *Job) GetSchedulingPolicy() Job_SchedulingPolicy

func (*Job) GetStatus 

func (x *Job) GetStatus() *JobStatus

func (*Job) GetTaskGroups 

func (x *Job) GetTaskGroups() []*TaskGroup

func (*Job) GetUid 

func (x *Job) GetUid() string

func (*Job) GetUpdateTime 

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

func (*Job) ProtoMessage 

func (*Job) ProtoMessage()

func (*Job) ProtoReflect 

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

func (*Job) Reset 

func (x *Job) Reset()

func (*Job) String 

func (x *Job) String() string

type JobDependency 

type JobDependency struct {

	// Each item maps a Job name to a Type.
	// All items must be satisfied for the JobDependency to be satisfied (the AND
	// operation).
	// Once a condition for one item becomes true, it won't go back to false
	// even the dependent Job state changes again.
	Items map[string]JobDependency_Type `` /* 204-byte string literal not displayed */
	// contains filtered or unexported fields
}

JobDependency describes the state of other Jobs that the start of this Job depends on. All dependent Jobs must have been submitted in the same region.

func (*JobDependency) Descriptor deprecated 

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

Deprecated: Use JobDependency.ProtoReflect.Descriptor instead.

func (*JobDependency) GetItems 

func (x *JobDependency) GetItems() map[string]JobDependency_Type

func (*JobDependency) ProtoMessage 

func (*JobDependency) ProtoMessage()

func (*JobDependency) ProtoReflect 

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

func (*JobDependency) Reset 

func (x *JobDependency) Reset()

func (*JobDependency) String 

func (x *JobDependency) String() string

type JobDependency_Type 

type JobDependency_Type int32

Dependency type. 

const (
	// Unspecified.
	JobDependency_TYPE_UNSPECIFIED JobDependency_Type = 0
	// The dependent Job has succeeded.
	JobDependency_SUCCEEDED JobDependency_Type = 1
	// The dependent Job has failed.
	JobDependency_FAILED JobDependency_Type = 2
	// SUCCEEDED or FAILED.
	JobDependency_FINISHED JobDependency_Type = 3
)

func (JobDependency_Type) Descriptor 

func (JobDependency_Type) Descriptor() protoreflect.EnumDescriptor

func (JobDependency_Type) Enum 

func (x JobDependency_Type) Enum() *JobDependency_Type

func (JobDependency_Type) EnumDescriptor deprecated 

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

Deprecated: Use JobDependency_Type.Descriptor instead.

func (JobDependency_Type) Number 

func (x JobDependency_Type) Number() protoreflect.EnumNumber

func (JobDependency_Type) String 

func (x JobDependency_Type) String() string

func (JobDependency_Type) Type 

func (JobDependency_Type) Type() protoreflect.EnumType

type JobNotification 

type JobNotification struct {

	// The Cloud Pub/Sub topic where notifications like the job state changes will
	// be published. This topic should be an existing topic in the same project
	// with the job and billings will be charged to this project.
	PubsubTopic string `protobuf:"bytes,1,opt,name=pubsub_topic,json=pubsubTopic,proto3" json:"pubsub_topic,omitempty"`
	// contains filtered or unexported fields
}

Job notification.

func (*JobNotification) Descriptor deprecated 

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

Deprecated: Use JobNotification.ProtoReflect.Descriptor instead.

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 JobStatus 

type JobStatus struct {

	// Job state
	State JobStatus_State `protobuf:"varint,1,opt,name=state,proto3,enum=google.cloud.batch.v1alpha1.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 the Job is in status
	// RUNNING. Once the Job completes (i.e. the Job status is either
	// SUCCEEDED/FAILED) the run duration represents the time it took the Job
	// to complete.
	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) Descriptor() ([]byte, []int)

Deprecated: Use JobStatus.ProtoReflect.Descriptor instead.

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

func (*JobStatus) Reset 

func (x *JobStatus) Reset()

func (*JobStatus) String 

func (x *JobStatus) String() string

type JobStatus_State 

type JobStatus_State int32

Valid Job states. 

const (
	JobStatus_STATE_UNSPECIFIED JobStatus_State = 0
	// Job is submitted into a ResourcePool and waiting
	// for resource allocation.
	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 */
	// 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) 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 Job_SchedulingPolicy 

type Job_SchedulingPolicy int32

The order that TaskGroups are scheduled relative to each other.

[NotImplemented] 

const (
	// Unspecified.
	Job_SCHEDULING_POLICY_UNSPECIFIED Job_SchedulingPolicy = 0
	// Run all TaskGroups as soon as possible.
	Job_AS_SOON_AS_POSSIBLE Job_SchedulingPolicy = 1
)

func (Job_SchedulingPolicy) Descriptor 

func (Job_SchedulingPolicy) Descriptor() protoreflect.EnumDescriptor

func (Job_SchedulingPolicy) Enum 

func (x Job_SchedulingPolicy) Enum() *Job_SchedulingPolicy

func (Job_SchedulingPolicy) EnumDescriptor deprecated 

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

Deprecated: Use Job_SchedulingPolicy.Descriptor instead.

func (Job_SchedulingPolicy) Number 

func (x Job_SchedulingPolicy) Number() protoreflect.EnumNumber

func (Job_SchedulingPolicy) String 

func (x Job_SchedulingPolicy) String() string

func (Job_SchedulingPolicy) Type 

func (Job_SchedulingPolicy) Type() protoreflect.EnumType

type LifecyclePolicy 

type LifecyclePolicy struct {

	// Action to execute when ActionCondition is true.
	Action LifecyclePolicy_Action `protobuf:"varint,1,opt,name=action,proto3,enum=google.cloud.batch.v1alpha1.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"`
	// 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) 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. Path of the TaskGroup from which Tasks are being requested.
	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
}

ListAssignedTasks 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 `` /* 132-byte string literal not displayed */
	// The path to which logs are saved when the destination = PATH. This can be a
	// local filepath 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"`
	// 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) 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_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 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 {

	// URI of the NFS server, e.g. an IP address.
	Server string `protobuf:"bytes,1,opt,name=server,proto3" json:"server,omitempty"`
	// Remote source path exported from 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 server and remote path: <server>:<remote_path>

func (*NFS) Descriptor deprecated 

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

Deprecated: Use NFS.ProtoReflect.Descriptor instead.

func (*NFS) GetRemotePath 

func (x *NFS) GetRemotePath() string

func (*NFS) GetServer 

func (x *NFS) GetServer() string

func (*NFS) ProtoMessage 

func (*NFS) ProtoMessage()

func (*NFS) ProtoReflect 

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

func (*NFS) Reset 

func (x *NFS) Reset()

func (*NFS) String 

func (x *NFS) String() string

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 PD 

type PD struct {

	// PD disk name, e.g. pd-1.
	Disk string `protobuf:"bytes,1,opt,name=disk,proto3" json:"disk,omitempty"`
	// PD device name, e.g. persistent-disk-1.
	Device   string `protobuf:"bytes,2,opt,name=device,proto3" json:"device,omitempty"`
	Existing bool   `protobuf:"varint,3,opt,name=existing,proto3" json:"existing,omitempty"`
	// contains filtered or unexported fields
}

Represents a GCP persistent disk

func (*PD) Descriptor deprecated 

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

Deprecated: Use PD.ProtoReflect.Descriptor instead.

func (*PD) GetDevice 

func (x *PD) GetDevice() string

func (*PD) GetDisk 

func (x *PD) GetDisk() string

func (*PD) GetExisting 

func (x *PD) GetExisting() bool

func (*PD) ProtoMessage 

func (*PD) ProtoMessage()

func (*PD) ProtoReflect 

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

func (*PD) Reset 

func (x *PD) Reset()

func (*PD) String 

func (x *PD) 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"`
	// 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"`
	// 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) Descriptor() ([]byte, []int)

Deprecated: Use Runnable.ProtoReflect.Descriptor instead.

func (*Runnable) GetAlwaysRun 

func (x *Runnable) GetAlwaysRun() bool

func (*Runnable) GetBackground 

func (x *Runnable) GetBackground() bool

func (*Runnable) GetBarrier 

func (x *Runnable) GetBarrier() *Runnable_Barrier

func (*Runnable) GetContainer 

func (x *Runnable) GetContainer() *Runnable_Container

func (*Runnable) GetExecutable 

func (m *Runnable) GetExecutable() isRunnable_Executable

func (*Runnable) GetIgnoreExitStatus 

func (x *Runnable) GetIgnoreExitStatus() bool

func (*Runnable) GetScript 

func (x *Runnable) GetScript() *Runnable_Script

func (*Runnable) ProtoMessage 

func (*Runnable) ProtoMessage()

func (*Runnable) ProtoReflect 

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

func (*Runnable) Reset 

func (x *Runnable) Reset()

func (*Runnable) String 

func (x *Runnable) String() string

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
	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"`
	// 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) GetCommands 

func (x *Runnable_Container) GetCommands() []string

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) 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.
	Path string `protobuf:"bytes,1,opt,name=path,proto3,oneof"`
}

type Runnable_Script_Text 

type Runnable_Script_Text struct {
	// Shell script text.
	Text string `protobuf:"bytes,2,opt,name=text,proto3,oneof"`
}

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"`
	// 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) 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) Descriptor() ([]byte, []int)

Deprecated: Use Task.ProtoReflect.Descriptor instead.

func (*Task) GetName 

func (x *Task) GetName() string

func (*Task) GetStatus 

func (x *Task) GetStatus() *TaskStatus

func (*Task) ProtoMessage 

func (*Task) ProtoMessage()

func (*Task) ProtoReflect 

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

func (*Task) Reset 

func (x *Task) Reset()

func (*Task) String 

func (x *Task) String() string

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/default-group".
	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, 1000).
	Parallelism int64 `protobuf:"varint,5,opt,name=parallelism,proto3" json:"parallelism,omitempty"`
	// Scheduling policy for Tasks in the TaskGroup.
	SchedulingPolicy TaskGroup_SchedulingPolicy `` /* 170-byte string literal not displayed */
	// Compute resource allocation for the TaskGroup.
	// If specified, it overrides resources in Job.
	AllocationPolicy *AllocationPolicy `protobuf:"bytes,7,opt,name=allocation_policy,json=allocationPolicy,proto3" json:"allocation_policy,omitempty"`
	// Labels for the TaskGroup.
	// 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 */
	// 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).
	//
	// task_environments supports up to 200 entries.
	TaskEnvironments []*TaskGroup_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 node
	// at the same time. Default is 1.
	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"`
	// contains filtered or unexported fields
}

A TaskGroup contains one or multiple Tasks that share the same Runnable but with different runtime parameters.

func (*TaskGroup) Descriptor deprecated 

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

Deprecated: Use TaskGroup.ProtoReflect.Descriptor instead.

func (*TaskGroup) GetAllocationPolicy 

func (x *TaskGroup) GetAllocationPolicy() *AllocationPolicy

func (*TaskGroup) GetLabels 

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

func (*TaskGroup) GetName 

func (x *TaskGroup) GetName() string

func (*TaskGroup) GetParallelism 

func (x *TaskGroup) GetParallelism() int64

func (*TaskGroup) GetRequireHostsFile 

func (x *TaskGroup) GetRequireHostsFile() bool

func (*TaskGroup) GetSchedulingPolicy 

func (x *TaskGroup) GetSchedulingPolicy() TaskGroup_SchedulingPolicy

func (*TaskGroup) GetTaskCount 

func (x *TaskGroup) GetTaskCount() int64

func (*TaskGroup) GetTaskCountPerNode 

func (x *TaskGroup) GetTaskCountPerNode() int64

func (*TaskGroup) GetTaskEnvironments 

func (x *TaskGroup) GetTaskEnvironments() []*TaskGroup_Environment

func (*TaskGroup) GetTaskSpec 

func (x *TaskGroup) GetTaskSpec() *TaskSpec

func (*TaskGroup) ProtoMessage 

func (*TaskGroup) ProtoMessage()

func (*TaskGroup) ProtoReflect 

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

func (*TaskGroup) Reset 

func (x *TaskGroup) Reset()

func (*TaskGroup) String 

func (x *TaskGroup) String() string

type TaskGroup_Environment 

type TaskGroup_Environment struct {

	// An map of environment variable names to values.
	// The map may contain at most 10 key/value pairs with keys length up to
	// 64 characters and values up to 4 KB.
	Variables map[string]string `` /* 159-byte string literal not displayed */
	// contains filtered or unexported fields
}

TaskGroup.Environment is a workaround for proto3 not supporting repeated map<string, string>.

func (*TaskGroup_Environment) Descriptor deprecated 

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

Deprecated: Use TaskGroup_Environment.ProtoReflect.Descriptor instead.

func (*TaskGroup_Environment) GetVariables 

func (x *TaskGroup_Environment) GetVariables() map[string]string

func (*TaskGroup_Environment) ProtoMessage 

func (*TaskGroup_Environment) ProtoMessage()

func (*TaskGroup_Environment) ProtoReflect 

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

func (*TaskGroup_Environment) Reset 

func (x *TaskGroup_Environment) Reset()

func (*TaskGroup_Environment) String 

func (x *TaskGroup_Environment) String() string

type TaskGroup_SchedulingPolicy 

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.
	TaskGroup_AS_SOON_AS_POSSIBLE TaskGroup_SchedulingPolicy = 1
)

func (TaskGroup_SchedulingPolicy) Descriptor 

func (TaskGroup_SchedulingPolicy) Descriptor() protoreflect.EnumDescriptor

func (TaskGroup_SchedulingPolicy) Enum 

func (x TaskGroup_SchedulingPolicy) Enum() *TaskGroup_SchedulingPolicy

func (TaskGroup_SchedulingPolicy) EnumDescriptor deprecated 

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

Deprecated: Use TaskGroup_SchedulingPolicy.Descriptor instead.

func (TaskGroup_SchedulingPolicy) Number 

func (x TaskGroup_SchedulingPolicy) Number() protoreflect.EnumNumber

func (TaskGroup_SchedulingPolicy) String 

func (x TaskGroup_SchedulingPolicy) String() string

func (TaskGroup_SchedulingPolicy) Type 

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.
	// The valid size of lifecycle policies are [0, 10].
	// For each lifecycle policy, when the condition is met,
	// the action in that policy will be executed.
	// If there are multiple policies that the task execution result matches,
	// we use the action from the first matched policy. If task execution result
	// does not meet with any of 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"`
	// Environment variables to set before running the Task.
	// You can set up to 100 environments.
	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"`
	// contains filtered or unexported fields
}

Spec of a task

func (*TaskSpec) Descriptor deprecated 

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

Deprecated: Use TaskSpec.ProtoReflect.Descriptor instead.

func (*TaskSpec) GetComputeResource 

func (x *TaskSpec) GetComputeResource() *ComputeResource

func (*TaskSpec) GetEnvironments 

func (x *TaskSpec) GetEnvironments() map[string]string

func (*TaskSpec) GetLifecyclePolicies 

func (x *TaskSpec) GetLifecyclePolicies() []*LifecyclePolicy

func (*TaskSpec) GetMaxRetryCount 

func (x *TaskSpec) GetMaxRetryCount() int32

func (*TaskSpec) GetMaxRunDuration 

func (x *TaskSpec) GetMaxRunDuration() *durationpb.Duration

func (*TaskSpec) GetRunnables 

func (x *TaskSpec) GetRunnables() []*Runnable

func (*TaskSpec) GetVolumes 

func (x *TaskSpec) GetVolumes() []*Volume

func (*TaskSpec) ProtoMessage 

func (*TaskSpec) ProtoMessage()

func (*TaskSpec) ProtoReflect 

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

func (*TaskSpec) Reset 

func (x *TaskSpec) Reset()

func (*TaskSpec) String 

func (x *TaskSpec) String() string

type TaskStatus 

type TaskStatus struct {

	// Task state
	State TaskStatus_State `protobuf:"varint,1,opt,name=state,proto3,enum=google.cloud.batch.v1alpha1.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
)

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) (*longrunning.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_Pd
	//	*Volume_Gcs
	Source isVolume_Source `protobuf_oneof:"source"`
	// Mount path for the volume, e.g. /mnt/share
	MountPath string `protobuf:"bytes,4,opt,name=mount_path,json=mountPath,proto3" json:"mount_path,omitempty"`
	// Mount options
	// For Google Cloud Storage, mount options are the global options supported by
	// gcsfuse tool. Batch will use them to mount the volume with the following
	// command:
	// "gcsfuse [global options] bucket mountpoint".
	// For PD, NFS, mount options are these supported by /etc/fstab. Batch will
	// use Fstab to mount such volumes.
	// https://help.ubuntu.com/community/Fstab
	MountOptions []string `protobuf:"bytes,5,rep,name=mount_options,json=mountOptions,proto3" json:"mount_options,omitempty"`
	// contains filtered or unexported fields
}

Volume and mount parameters to be associated with a TaskSpec. A TaskSpec might describe zero, one, or multiple volumes to be mounted as part of the task.

func (*Volume) Descriptor deprecated 

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

Deprecated: Use Volume.ProtoReflect.Descriptor instead.

func (*Volume) GetGcs 

func (x *Volume) GetGcs() *GCS

func (*Volume) GetMountOptions 

func (x *Volume) GetMountOptions() []string

func (*Volume) GetMountPath 

func (x *Volume) GetMountPath() string

func (*Volume) GetNfs 

func (x *Volume) GetNfs() *NFS

func (*Volume) GetPd 

func (x *Volume) GetPd() *PD

func (*Volume) GetSource 

func (m *Volume) GetSource() isVolume_Source

func (*Volume) ProtoMessage 

func (*Volume) ProtoMessage()

func (*Volume) ProtoReflect 

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

func (*Volume) Reset 

func (x *Volume) Reset()

func (*Volume) String 

func (x *Volume) String() string

type Volume_Gcs 

type Volume_Gcs struct {
	// A Google Cloud Storage source for the volume.
	Gcs *GCS `protobuf:"bytes,3,opt,name=gcs,proto3,oneof"`
}

type Volume_Nfs 

type Volume_Nfs struct {
	// An NFS source for the volume (could be a Filestore, for example).
	Nfs *NFS `protobuf:"bytes,1,opt,name=nfs,proto3,oneof"`
}

type Volume_Pd 

type Volume_Pd struct {
	// A persistent disk source for the volume.
	Pd *PD `protobuf:"bytes,2,opt,name=pd,proto3,oneof"`
}

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.