Documentation
¶
Overview ¶
Package batch provides access to the Batch API.
For product documentation, see: https://cloud.google.com/batch/
Creating a client ¶
Usage example:
import "google.golang.org/api/batch/v1" ... ctx := context.Background() batchService, err := batch.NewService(ctx)
In this example, Google Application Default Credentials are used for authentication.
For information on how to create and obtain Application Default Credentials, see https://developers.google.com/identity/protocols/application-default-credentials.
Other authentication options ¶
To use an API key for authentication (note: some APIs do not support API keys), use option.WithAPIKey:
batchService, err := batch.NewService(ctx, option.WithAPIKey("AIza..."))
To use an OAuth token (e.g., a user token obtained via a three-legged OAuth flow), use option.WithTokenSource:
config := &oauth2.Config{...} // ... token, err := config.Exchange(ctx, ...) batchService, err := batch.NewService(ctx, option.WithTokenSource(config.TokenSource(ctx, token)))
See https://godoc.org/google.golang.org/api/option/ for details on options.
Index ¶
- Constants
- type Accelerator
- type ActionCondition
- type AgentInfo
- type AgentMetadata
- type AgentTask
- type AgentTaskInfo
- type AgentTimingInfo
- type AllocationPolicy
- type AttachedDisk
- type AuditConfig
- type AuditLogConfig
- type Barrier
- type Binding
- type CancelOperationRequest
- type ComputeResource
- type Container
- type Disk
- type Empty
- type Environment
- type Expr
- type GCS
- type InstancePolicy
- type InstancePolicyOrTemplate
- type InstanceStatus
- type Job
- type JobNotification
- type JobStatus
- type KMSEnvMap
- type LifecyclePolicy
- type ListJobsResponse
- type ListLocationsResponse
- type ListOperationsResponse
- type ListTasksResponse
- type Location
- type LocationPolicy
- type LogsPolicy
- type Message
- type NFS
- type NetworkInterface
- type NetworkPolicy
- type Operation
- type OperationMetadata
- type Policy
- type ProjectsLocationsGetCall
- func (c *ProjectsLocationsGetCall) Context(ctx context.Context) *ProjectsLocationsGetCall
- func (c *ProjectsLocationsGetCall) Do(opts ...googleapi.CallOption) (*Location, error)
- func (c *ProjectsLocationsGetCall) Fields(s ...googleapi.Field) *ProjectsLocationsGetCall
- func (c *ProjectsLocationsGetCall) Header() http.Header
- func (c *ProjectsLocationsGetCall) IfNoneMatch(entityTag string) *ProjectsLocationsGetCall
- type ProjectsLocationsJobsCreateCall
- func (c *ProjectsLocationsJobsCreateCall) Context(ctx context.Context) *ProjectsLocationsJobsCreateCall
- func (c *ProjectsLocationsJobsCreateCall) Do(opts ...googleapi.CallOption) (*Job, error)
- func (c *ProjectsLocationsJobsCreateCall) Fields(s ...googleapi.Field) *ProjectsLocationsJobsCreateCall
- func (c *ProjectsLocationsJobsCreateCall) Header() http.Header
- func (c *ProjectsLocationsJobsCreateCall) JobId(jobId string) *ProjectsLocationsJobsCreateCall
- func (c *ProjectsLocationsJobsCreateCall) RequestId(requestId string) *ProjectsLocationsJobsCreateCall
- type ProjectsLocationsJobsDeleteCall
- func (c *ProjectsLocationsJobsDeleteCall) Context(ctx context.Context) *ProjectsLocationsJobsDeleteCall
- func (c *ProjectsLocationsJobsDeleteCall) Do(opts ...googleapi.CallOption) (*Operation, error)
- func (c *ProjectsLocationsJobsDeleteCall) Fields(s ...googleapi.Field) *ProjectsLocationsJobsDeleteCall
- func (c *ProjectsLocationsJobsDeleteCall) Header() http.Header
- func (c *ProjectsLocationsJobsDeleteCall) Reason(reason string) *ProjectsLocationsJobsDeleteCall
- func (c *ProjectsLocationsJobsDeleteCall) RequestId(requestId string) *ProjectsLocationsJobsDeleteCall
- type ProjectsLocationsJobsGetCall
- func (c *ProjectsLocationsJobsGetCall) Context(ctx context.Context) *ProjectsLocationsJobsGetCall
- func (c *ProjectsLocationsJobsGetCall) Do(opts ...googleapi.CallOption) (*Job, error)
- func (c *ProjectsLocationsJobsGetCall) Fields(s ...googleapi.Field) *ProjectsLocationsJobsGetCall
- func (c *ProjectsLocationsJobsGetCall) Header() http.Header
- func (c *ProjectsLocationsJobsGetCall) IfNoneMatch(entityTag string) *ProjectsLocationsJobsGetCall
- type ProjectsLocationsJobsGetIamPolicyCall
- func (c *ProjectsLocationsJobsGetIamPolicyCall) Context(ctx context.Context) *ProjectsLocationsJobsGetIamPolicyCall
- func (c *ProjectsLocationsJobsGetIamPolicyCall) Do(opts ...googleapi.CallOption) (*Policy, error)
- func (c *ProjectsLocationsJobsGetIamPolicyCall) Fields(s ...googleapi.Field) *ProjectsLocationsJobsGetIamPolicyCall
- func (c *ProjectsLocationsJobsGetIamPolicyCall) Header() http.Header
- func (c *ProjectsLocationsJobsGetIamPolicyCall) IfNoneMatch(entityTag string) *ProjectsLocationsJobsGetIamPolicyCall
- func (c *ProjectsLocationsJobsGetIamPolicyCall) OptionsRequestedPolicyVersion(optionsRequestedPolicyVersion int64) *ProjectsLocationsJobsGetIamPolicyCall
- type ProjectsLocationsJobsListCall
- func (c *ProjectsLocationsJobsListCall) Context(ctx context.Context) *ProjectsLocationsJobsListCall
- func (c *ProjectsLocationsJobsListCall) Do(opts ...googleapi.CallOption) (*ListJobsResponse, error)
- func (c *ProjectsLocationsJobsListCall) Fields(s ...googleapi.Field) *ProjectsLocationsJobsListCall
- func (c *ProjectsLocationsJobsListCall) Filter(filter string) *ProjectsLocationsJobsListCall
- func (c *ProjectsLocationsJobsListCall) Header() http.Header
- func (c *ProjectsLocationsJobsListCall) IfNoneMatch(entityTag string) *ProjectsLocationsJobsListCall
- func (c *ProjectsLocationsJobsListCall) PageSize(pageSize int64) *ProjectsLocationsJobsListCall
- func (c *ProjectsLocationsJobsListCall) PageToken(pageToken string) *ProjectsLocationsJobsListCall
- func (c *ProjectsLocationsJobsListCall) Pages(ctx context.Context, f func(*ListJobsResponse) error) error
- type ProjectsLocationsJobsService
- func (r *ProjectsLocationsJobsService) Create(parent string, job *Job) *ProjectsLocationsJobsCreateCall
- func (r *ProjectsLocationsJobsService) Delete(name string) *ProjectsLocationsJobsDeleteCall
- func (r *ProjectsLocationsJobsService) Get(name string) *ProjectsLocationsJobsGetCall
- func (r *ProjectsLocationsJobsService) GetIamPolicy(resource string) *ProjectsLocationsJobsGetIamPolicyCall
- func (r *ProjectsLocationsJobsService) List(parent string) *ProjectsLocationsJobsListCall
- func (r *ProjectsLocationsJobsService) SetIamPolicy(resource string, setiampolicyrequest *SetIamPolicyRequest) *ProjectsLocationsJobsSetIamPolicyCall
- func (r *ProjectsLocationsJobsService) TestIamPermissions(resource string, testiampermissionsrequest *TestIamPermissionsRequest) *ProjectsLocationsJobsTestIamPermissionsCall
- type ProjectsLocationsJobsSetIamPolicyCall
- func (c *ProjectsLocationsJobsSetIamPolicyCall) Context(ctx context.Context) *ProjectsLocationsJobsSetIamPolicyCall
- func (c *ProjectsLocationsJobsSetIamPolicyCall) Do(opts ...googleapi.CallOption) (*Policy, error)
- func (c *ProjectsLocationsJobsSetIamPolicyCall) Fields(s ...googleapi.Field) *ProjectsLocationsJobsSetIamPolicyCall
- func (c *ProjectsLocationsJobsSetIamPolicyCall) Header() http.Header
- type ProjectsLocationsJobsTaskGroupsService
- type ProjectsLocationsJobsTaskGroupsTasksGetCall
- func (c *ProjectsLocationsJobsTaskGroupsTasksGetCall) Context(ctx context.Context) *ProjectsLocationsJobsTaskGroupsTasksGetCall
- func (c *ProjectsLocationsJobsTaskGroupsTasksGetCall) Do(opts ...googleapi.CallOption) (*Task, error)
- func (c *ProjectsLocationsJobsTaskGroupsTasksGetCall) Fields(s ...googleapi.Field) *ProjectsLocationsJobsTaskGroupsTasksGetCall
- func (c *ProjectsLocationsJobsTaskGroupsTasksGetCall) Header() http.Header
- func (c *ProjectsLocationsJobsTaskGroupsTasksGetCall) IfNoneMatch(entityTag string) *ProjectsLocationsJobsTaskGroupsTasksGetCall
- type ProjectsLocationsJobsTaskGroupsTasksListCall
- func (c *ProjectsLocationsJobsTaskGroupsTasksListCall) Context(ctx context.Context) *ProjectsLocationsJobsTaskGroupsTasksListCall
- func (c *ProjectsLocationsJobsTaskGroupsTasksListCall) Do(opts ...googleapi.CallOption) (*ListTasksResponse, error)
- func (c *ProjectsLocationsJobsTaskGroupsTasksListCall) Fields(s ...googleapi.Field) *ProjectsLocationsJobsTaskGroupsTasksListCall
- func (c *ProjectsLocationsJobsTaskGroupsTasksListCall) Filter(filter string) *ProjectsLocationsJobsTaskGroupsTasksListCall
- func (c *ProjectsLocationsJobsTaskGroupsTasksListCall) Header() http.Header
- func (c *ProjectsLocationsJobsTaskGroupsTasksListCall) IfNoneMatch(entityTag string) *ProjectsLocationsJobsTaskGroupsTasksListCall
- func (c *ProjectsLocationsJobsTaskGroupsTasksListCall) PageSize(pageSize int64) *ProjectsLocationsJobsTaskGroupsTasksListCall
- func (c *ProjectsLocationsJobsTaskGroupsTasksListCall) PageToken(pageToken string) *ProjectsLocationsJobsTaskGroupsTasksListCall
- func (c *ProjectsLocationsJobsTaskGroupsTasksListCall) Pages(ctx context.Context, f func(*ListTasksResponse) error) error
- type ProjectsLocationsJobsTaskGroupsTasksService
- type ProjectsLocationsJobsTestIamPermissionsCall
- func (c *ProjectsLocationsJobsTestIamPermissionsCall) Context(ctx context.Context) *ProjectsLocationsJobsTestIamPermissionsCall
- func (c *ProjectsLocationsJobsTestIamPermissionsCall) Do(opts ...googleapi.CallOption) (*TestIamPermissionsResponse, error)
- func (c *ProjectsLocationsJobsTestIamPermissionsCall) Fields(s ...googleapi.Field) *ProjectsLocationsJobsTestIamPermissionsCall
- func (c *ProjectsLocationsJobsTestIamPermissionsCall) Header() http.Header
- type ProjectsLocationsListCall
- func (c *ProjectsLocationsListCall) Context(ctx context.Context) *ProjectsLocationsListCall
- func (c *ProjectsLocationsListCall) Do(opts ...googleapi.CallOption) (*ListLocationsResponse, error)
- func (c *ProjectsLocationsListCall) Fields(s ...googleapi.Field) *ProjectsLocationsListCall
- func (c *ProjectsLocationsListCall) Filter(filter string) *ProjectsLocationsListCall
- func (c *ProjectsLocationsListCall) Header() http.Header
- func (c *ProjectsLocationsListCall) IfNoneMatch(entityTag string) *ProjectsLocationsListCall
- func (c *ProjectsLocationsListCall) PageSize(pageSize int64) *ProjectsLocationsListCall
- func (c *ProjectsLocationsListCall) PageToken(pageToken string) *ProjectsLocationsListCall
- func (c *ProjectsLocationsListCall) Pages(ctx context.Context, f func(*ListLocationsResponse) error) error
- type ProjectsLocationsOperationsCancelCall
- func (c *ProjectsLocationsOperationsCancelCall) Context(ctx context.Context) *ProjectsLocationsOperationsCancelCall
- func (c *ProjectsLocationsOperationsCancelCall) Do(opts ...googleapi.CallOption) (*Empty, error)
- func (c *ProjectsLocationsOperationsCancelCall) Fields(s ...googleapi.Field) *ProjectsLocationsOperationsCancelCall
- func (c *ProjectsLocationsOperationsCancelCall) Header() http.Header
- type ProjectsLocationsOperationsDeleteCall
- func (c *ProjectsLocationsOperationsDeleteCall) Context(ctx context.Context) *ProjectsLocationsOperationsDeleteCall
- func (c *ProjectsLocationsOperationsDeleteCall) Do(opts ...googleapi.CallOption) (*Empty, error)
- func (c *ProjectsLocationsOperationsDeleteCall) Fields(s ...googleapi.Field) *ProjectsLocationsOperationsDeleteCall
- func (c *ProjectsLocationsOperationsDeleteCall) Header() http.Header
- type ProjectsLocationsOperationsGetCall
- func (c *ProjectsLocationsOperationsGetCall) Context(ctx context.Context) *ProjectsLocationsOperationsGetCall
- func (c *ProjectsLocationsOperationsGetCall) Do(opts ...googleapi.CallOption) (*Operation, error)
- func (c *ProjectsLocationsOperationsGetCall) Fields(s ...googleapi.Field) *ProjectsLocationsOperationsGetCall
- func (c *ProjectsLocationsOperationsGetCall) Header() http.Header
- func (c *ProjectsLocationsOperationsGetCall) IfNoneMatch(entityTag string) *ProjectsLocationsOperationsGetCall
- type ProjectsLocationsOperationsListCall
- func (c *ProjectsLocationsOperationsListCall) Context(ctx context.Context) *ProjectsLocationsOperationsListCall
- func (c *ProjectsLocationsOperationsListCall) Do(opts ...googleapi.CallOption) (*ListOperationsResponse, error)
- func (c *ProjectsLocationsOperationsListCall) Fields(s ...googleapi.Field) *ProjectsLocationsOperationsListCall
- func (c *ProjectsLocationsOperationsListCall) Filter(filter string) *ProjectsLocationsOperationsListCall
- func (c *ProjectsLocationsOperationsListCall) Header() http.Header
- func (c *ProjectsLocationsOperationsListCall) IfNoneMatch(entityTag string) *ProjectsLocationsOperationsListCall
- func (c *ProjectsLocationsOperationsListCall) PageSize(pageSize int64) *ProjectsLocationsOperationsListCall
- func (c *ProjectsLocationsOperationsListCall) PageToken(pageToken string) *ProjectsLocationsOperationsListCall
- func (c *ProjectsLocationsOperationsListCall) Pages(ctx context.Context, f func(*ListOperationsResponse) error) error
- type ProjectsLocationsOperationsService
- func (r *ProjectsLocationsOperationsService) Cancel(name string, canceloperationrequest *CancelOperationRequest) *ProjectsLocationsOperationsCancelCall
- func (r *ProjectsLocationsOperationsService) Delete(name string) *ProjectsLocationsOperationsDeleteCall
- func (r *ProjectsLocationsOperationsService) Get(name string) *ProjectsLocationsOperationsGetCall
- func (r *ProjectsLocationsOperationsService) List(name string) *ProjectsLocationsOperationsListCall
- type ProjectsLocationsService
- type ProjectsLocationsStateReportCall
- func (c *ProjectsLocationsStateReportCall) Context(ctx context.Context) *ProjectsLocationsStateReportCall
- func (c *ProjectsLocationsStateReportCall) Do(opts ...googleapi.CallOption) (*ReportAgentStateResponse, error)
- func (c *ProjectsLocationsStateReportCall) Fields(s ...googleapi.Field) *ProjectsLocationsStateReportCall
- func (c *ProjectsLocationsStateReportCall) Header() http.Header
- type ProjectsLocationsStateService
- type ProjectsService
- type ReportAgentStateRequest
- type ReportAgentStateResponse
- type Runnable
- type Script
- type Service
- type ServiceAccount
- type SetIamPolicyRequest
- type Status
- type StatusEvent
- type Task
- type TaskExecution
- type TaskGroup
- type TaskGroupStatus
- type TaskSpec
- type TaskStatus
- type TestIamPermissionsRequest
- type TestIamPermissionsResponse
- type Volume
Constants ¶
const ( // See, edit, configure, and delete your Google Cloud data and see the // email address for your Google Account. CloudPlatformScope = "https://www.googleapis.com/auth/cloud-platform" )
OAuth2 scopes used by this API.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type Accelerator ¶
type Accelerator struct { // Count: The number of accelerators of this type. Count int64 `json:"count,omitempty,string"` // InstallGpuDrivers: Deprecated: please use // instances[0].install_gpu_drivers instead. InstallGpuDrivers bool `json:"installGpuDrivers,omitempty"` // Type: The accelerator type. For example, "nvidia-tesla-t4". See // `gcloud compute accelerator-types list`. Type string `json:"type,omitempty"` // ForceSendFields is a list of field names (e.g. "Count") to // unconditionally include in API requests. By default, fields with // empty or default values are omitted from API requests. However, any // non-pointer, non-interface field appearing in ForceSendFields will be // sent to the server regardless of whether the field is empty or not. // This may be used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` // NullFields is a list of field names (e.g. "Count") to include in API // requests with the JSON null value. By default, fields with empty // values are omitted from API requests. However, any field with an // empty value appearing in NullFields will be sent to the server as // null. It is an error if a field in this list has a non-empty value. // This may be used to include null fields in Patch requests. NullFields []string `json:"-"` }
Accelerator: Accelerator describes Compute Engine accelerators to be attached to the VM.
func (*Accelerator) MarshalJSON ¶
func (s *Accelerator) MarshalJSON() ([]byte, error)
type ActionCondition ¶
type ActionCondition struct { // ExitCodes: 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 []int64 `json:"exitCodes,omitempty"` // ForceSendFields is a list of field names (e.g. "ExitCodes") to // unconditionally include in API requests. By default, fields with // empty or default values are omitted from API requests. However, any // non-pointer, non-interface field appearing in ForceSendFields will be // sent to the server regardless of whether the field is empty or not. // This may be used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` // NullFields is a list of field names (e.g. "ExitCodes") to include in // API requests with the JSON null value. By default, fields with empty // values are omitted from API requests. However, any field with an // empty value appearing in NullFields will be sent to the server as // null. It is an error if a field in this list has a non-empty value. // This may be used to include null fields in Patch requests. NullFields []string `json:"-"` }
ActionCondition: Conditions for actions to deal with task failures.
func (*ActionCondition) MarshalJSON ¶
func (s *ActionCondition) MarshalJSON() ([]byte, error)
type AgentInfo ¶
type AgentInfo struct { // JobId: The assigned Job ID JobId string `json:"jobId,omitempty"` // ReportTime: When the AgentInfo is generated. ReportTime string `json:"reportTime,omitempty"` // State: Agent state. // // Possible values: // "AGENT_STATE_UNSPECIFIED" - Unspecified state. // "AGENT_STARTING" - The agent is starting on the VM instance. // "AGENT_RUNNING" - The agent is running. The agent in the RUNNING // state can never go back to the STARTING state. // "AGENT_STOPPED" - The agent has stopped, either on request or due // to a failure. State string `json:"state,omitempty"` // TaskGroupId: The assigned task group ID. TaskGroupId string `json:"taskGroupId,omitempty"` // Tasks: Task Info. Tasks []*AgentTaskInfo `json:"tasks,omitempty"` // ForceSendFields is a list of field names (e.g. "JobId") to // unconditionally include in API requests. By default, fields with // empty or default values are omitted from API requests. However, any // non-pointer, non-interface field appearing in ForceSendFields will be // sent to the server regardless of whether the field is empty or not. // This may be used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` // NullFields is a list of field names (e.g. "JobId") to include in API // requests with the JSON null value. By default, fields with empty // values are omitted from API requests. However, any field with an // empty value appearing in NullFields will be sent to the server as // null. It is an error if a field in this list has a non-empty value. // This may be used to include null fields in Patch requests. NullFields []string `json:"-"` }
AgentInfo: VM Agent Info.
func (*AgentInfo) MarshalJSON ¶
type AgentMetadata ¶
type AgentMetadata struct { // CreationTime: When the VM agent started. Use agent_startup_time // instead. CreationTime string `json:"creationTime,omitempty"` // Creator: Full name of the entity that created this vm. For MIG, this // path is: // projects/{project}/regions/{region}/InstanceGroupManagers/{igm} The // value is retrieved from the vm metadata key of "created-by". Creator string `json:"creator,omitempty"` // ImageVersion: image version for the VM that this agent is installed // on. ImageVersion string `json:"imageVersion,omitempty"` // Instance: GCP instance name (go/instance-name). Instance string `json:"instance,omitempty"` // InstanceId: GCP instance ID (go/instance-id). InstanceId uint64 `json:"instanceId,omitempty,string"` // InstancePreemptionNoticeReceived: If the GCP instance has received // preemption notice. InstancePreemptionNoticeReceived bool `json:"instancePreemptionNoticeReceived,omitempty"` // OsRelease: parsed contents of /etc/os-release OsRelease map[string]string `json:"osRelease,omitempty"` // Version: agent binary version running on VM Version string `json:"version,omitempty"` // Zone: Agent zone. Zone string `json:"zone,omitempty"` // ForceSendFields is a list of field names (e.g. "CreationTime") to // unconditionally include in API requests. By default, fields with // empty or default values are omitted from API requests. However, any // non-pointer, non-interface field appearing in ForceSendFields will be // sent to the server regardless of whether the field is empty or not. // This may be used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` // NullFields is a list of field names (e.g. "CreationTime") to include // in API requests with the JSON null value. By default, fields with // empty values are omitted from API requests. However, any field with // an empty value appearing in NullFields will be sent to the server as // null. It is an error if a field in this list has a non-empty value. // This may be used to include null fields in Patch requests. NullFields []string `json:"-"` }
AgentMetadata: VM Agent Metadata.
func (*AgentMetadata) MarshalJSON ¶
func (s *AgentMetadata) MarshalJSON() ([]byte, error)
type AgentTask ¶
type AgentTask struct { // IntendedState: The intended state of the task. // // Possible values: // "INTENDED_STATE_UNSPECIFIED" - Unspecified state. // "ASSIGNED" - Assigned state (includes running and finished). // "CANCELLED" - The agent should cancel the execution of this task. // "DELETED" - Delete task from agent storage, stop reporting its // state. IntendedState string `json:"intendedState,omitempty"` // ReachedBarrier: The highest barrier reached by all tasks in the // task's TaskGroup. ReachedBarrier int64 `json:"reachedBarrier,omitempty,string"` // Spec: Task Spec. Spec *TaskSpec `json:"spec,omitempty"` // Status: Task status. Status *TaskStatus `json:"status,omitempty"` // Task: Task name. Task string `json:"task,omitempty"` // ForceSendFields is a list of field names (e.g. "IntendedState") to // unconditionally include in API requests. By default, fields with // empty or default values are omitted from API requests. However, any // non-pointer, non-interface field appearing in ForceSendFields will be // sent to the server regardless of whether the field is empty or not. // This may be used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` // NullFields is a list of field names (e.g. "IntendedState") to include // in API requests with the JSON null value. By default, fields with // empty values are omitted from API requests. However, any field with // an empty value appearing in NullFields will be sent to the server as // null. It is an error if a field in this list has a non-empty value. // This may be used to include null fields in Patch requests. NullFields []string `json:"-"` }
AgentTask: TODO(b/182501497) The message needs to be redefined when the Agent API server updates data in storage per the backend design.
func (*AgentTask) MarshalJSON ¶
type AgentTaskInfo ¶
type AgentTaskInfo struct { // Runnable: The highest index of a runnable started by the agent for // this task. The runnables are indexed from 1. Value 0 is undefined. Runnable int64 `json:"runnable,omitempty,string"` // TaskId: ID of the Task TaskId string `json:"taskId,omitempty"` // TaskStatus: The status of the Task. If we need agent specific fields // we should fork the public TaskStatus into an agent specific one. Or // add them below. TaskStatus *TaskStatus `json:"taskStatus,omitempty"` // ForceSendFields is a list of field names (e.g. "Runnable") to // unconditionally include in API requests. By default, fields with // empty or default values are omitted from API requests. However, any // non-pointer, non-interface field appearing in ForceSendFields will be // sent to the server regardless of whether the field is empty or not. // This may be used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` // NullFields is a list of field names (e.g. "Runnable") to include in // API requests with the JSON null value. By default, fields with empty // values are omitted from API requests. However, any field with an // empty value appearing in NullFields will be sent to the server as // null. It is an error if a field in this list has a non-empty value. // This may be used to include null fields in Patch requests. NullFields []string `json:"-"` }
AgentTaskInfo: Task Info
func (*AgentTaskInfo) MarshalJSON ¶
func (s *AgentTaskInfo) MarshalJSON() ([]byte, error)
type AgentTimingInfo ¶ added in v0.106.0
type AgentTimingInfo struct { // AgentStartupTime: Agent startup time AgentStartupTime string `json:"agentStartupTime,omitempty"` // BootTime: Boot timestamp of the VM OS BootTime string `json:"bootTime,omitempty"` // ScriptStartupTime: Startup time of the Batch VM script. ScriptStartupTime string `json:"scriptStartupTime,omitempty"` // ForceSendFields is a list of field names (e.g. "AgentStartupTime") to // unconditionally include in API requests. By default, fields with // empty or default values are omitted from API requests. However, any // non-pointer, non-interface field appearing in ForceSendFields will be // sent to the server regardless of whether the field is empty or not. // This may be used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` // NullFields is a list of field names (e.g. "AgentStartupTime") to // include in API requests with the JSON null value. By default, fields // with empty values are omitted from API requests. However, any field // with an empty value appearing in NullFields will be sent to the // server as null. It is an error if a field in this list has a // non-empty value. This may be used to include null fields in Patch // requests. NullFields []string `json:"-"` }
AgentTimingInfo: VM timing information
func (*AgentTimingInfo) MarshalJSON ¶ added in v0.106.0
func (s *AgentTimingInfo) MarshalJSON() ([]byte, error)
type AllocationPolicy ¶
type AllocationPolicy struct { // Instances: Describe instances that can be created by this // AllocationPolicy. Only instances[0] is supported now. Instances []*InstancePolicyOrTemplate `json:"instances,omitempty"` // Labels: 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 `json:"labels,omitempty"` // Location: Location where compute resources should be allocated for // the Job. Location *LocationPolicy `json:"location,omitempty"` // Network: The network policy. Network *NetworkPolicy `json:"network,omitempty"` // ServiceAccount: Service account that VMs will run as. ServiceAccount *ServiceAccount `json:"serviceAccount,omitempty"` // ForceSendFields is a list of field names (e.g. "Instances") to // unconditionally include in API requests. By default, fields with // empty or default values are omitted from API requests. However, any // non-pointer, non-interface field appearing in ForceSendFields will be // sent to the server regardless of whether the field is empty or not. // This may be used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` // NullFields is a list of field names (e.g. "Instances") to include in // API requests with the JSON null value. By default, fields with empty // values are omitted from API requests. However, any field with an // empty value appearing in NullFields will be sent to the server as // null. It is an error if a field in this list has a non-empty value. // This may be used to include null fields in Patch requests. NullFields []string `json:"-"` }
AllocationPolicy: A Job's resource allocation policy describes when, where, and how compute resources should be allocated for the Job.
func (*AllocationPolicy) MarshalJSON ¶
func (s *AllocationPolicy) MarshalJSON() ([]byte, error)
type AttachedDisk ¶
type AttachedDisk struct { // DeviceName: 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 `json:"deviceName,omitempty"` // ExistingDisk: Name of an existing PD. ExistingDisk string `json:"existingDisk,omitempty"` NewDisk *Disk `json:"newDisk,omitempty"` // ForceSendFields is a list of field names (e.g. "DeviceName") to // unconditionally include in API requests. By default, fields with // empty or default values are omitted from API requests. However, any // non-pointer, non-interface field appearing in ForceSendFields will be // sent to the server regardless of whether the field is empty or not. // This may be used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` // NullFields is a list of field names (e.g. "DeviceName") to include in // API requests with the JSON null value. By default, fields with empty // values are omitted from API requests. However, any field with an // empty value appearing in NullFields will be sent to the server as // null. It is an error if a field in this list has a non-empty value. // This may be used to include null fields in Patch requests. NullFields []string `json:"-"` }
AttachedDisk: A new or an existing persistent disk (PD) or a local ssd attached to a VM instance.
func (*AttachedDisk) MarshalJSON ¶
func (s *AttachedDisk) MarshalJSON() ([]byte, error)
type AuditConfig ¶
type AuditConfig struct { // AuditLogConfigs: The configuration for logging of each type of // permission. AuditLogConfigs []*AuditLogConfig `json:"auditLogConfigs,omitempty"` // Service: Specifies a service that will be enabled for audit logging. // For example, `storage.googleapis.com`, `cloudsql.googleapis.com`. // `allServices` is a special value that covers all services. Service string `json:"service,omitempty"` // ForceSendFields is a list of field names (e.g. "AuditLogConfigs") to // unconditionally include in API requests. By default, fields with // empty or default values are omitted from API requests. However, any // non-pointer, non-interface field appearing in ForceSendFields will be // sent to the server regardless of whether the field is empty or not. // This may be used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` // NullFields is a list of field names (e.g. "AuditLogConfigs") to // include in API requests with the JSON null value. By default, fields // with empty values are omitted from API requests. However, any field // with an empty value appearing in NullFields will be sent to the // server as null. It is an error if a field in this list has a // non-empty value. This may be used to include null fields in Patch // requests. NullFields []string `json:"-"` }
AuditConfig: Specifies the audit configuration for a service. The configuration determines which permission types are logged, and what identities, if any, are exempted from logging. An AuditConfig must have one or more AuditLogConfigs. If there are AuditConfigs for both `allServices` and a specific service, the union of the two AuditConfigs is used for that service: the log_types specified in each AuditConfig are enabled, and the exempted_members in each AuditLogConfig are exempted. Example Policy with multiple AuditConfigs: { "audit_configs": [ { "service": "allServices", "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" }, { "log_type": "ADMIN_READ" } ] }, { "service": "sampleservice.googleapis.com", "audit_log_configs": [ { "log_type": "DATA_READ" }, { "log_type": "DATA_WRITE", "exempted_members": [ "user:aliya@example.com" ] } ] } ] } For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts `jose@example.com` from DATA_READ logging, and `aliya@example.com` from DATA_WRITE logging.
func (*AuditConfig) MarshalJSON ¶
func (s *AuditConfig) MarshalJSON() ([]byte, error)
type AuditLogConfig ¶
type AuditLogConfig struct { // ExemptedMembers: Specifies the identities that do not cause logging // for this type of permission. Follows the same format of // Binding.members. ExemptedMembers []string `json:"exemptedMembers,omitempty"` // LogType: The log type that this config enables. // // Possible values: // "LOG_TYPE_UNSPECIFIED" - Default case. Should never be this. // "ADMIN_READ" - Admin reads. Example: CloudIAM getIamPolicy // "DATA_WRITE" - Data writes. Example: CloudSQL Users create // "DATA_READ" - Data reads. Example: CloudSQL Users list LogType string `json:"logType,omitempty"` // ForceSendFields is a list of field names (e.g. "ExemptedMembers") to // unconditionally include in API requests. By default, fields with // empty or default values are omitted from API requests. However, any // non-pointer, non-interface field appearing in ForceSendFields will be // sent to the server regardless of whether the field is empty or not. // This may be used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` // NullFields is a list of field names (e.g. "ExemptedMembers") to // include in API requests with the JSON null value. By default, fields // with empty values are omitted from API requests. However, any field // with an empty value appearing in NullFields will be sent to the // server as null. It is an error if a field in this list has a // non-empty value. This may be used to include null fields in Patch // requests. NullFields []string `json:"-"` }
AuditLogConfig: Provides the configuration for logging a type of permissions. Example: { "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" } ] } This enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting jose@example.com from DATA_READ logging.
func (*AuditLogConfig) MarshalJSON ¶
func (s *AuditLogConfig) MarshalJSON() ([]byte, error)
type Barrier ¶
type Barrier struct { // Name: Barriers are identified by their index in runnable list. Names // are not required, but if present should be an identifier. Name string `json:"name,omitempty"` // ForceSendFields is a list of field names (e.g. "Name") to // unconditionally include in API requests. By default, fields with // empty or default values are omitted from API requests. However, any // non-pointer, non-interface field appearing in ForceSendFields will be // sent to the server regardless of whether the field is empty or not. // This may be used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` // NullFields is a list of field names (e.g. "Name") to include in API // requests with the JSON null value. By default, fields with empty // values are omitted from API requests. However, any field with an // empty value appearing in NullFields will be sent to the server as // null. It is an error if a field in this list has a non-empty value. // This may be used to include null fields in Patch requests. NullFields []string `json:"-"` }
Barrier: Barrier runnable blocks until all tasks in a taskgroup reach it.
func (*Barrier) MarshalJSON ¶
type Binding ¶
type Binding struct { // Condition: The condition that is associated with this binding. If the // condition evaluates to `true`, then this binding applies to the // current request. If the condition evaluates to `false`, then this // binding does not apply to the current request. However, a different // role binding might grant the same role to one or more of the // principals in this binding. To learn which resources support // conditions in their IAM policies, see the IAM documentation // (https://cloud.google.com/iam/help/conditions/resource-policies). Condition *Expr `json:"condition,omitempty"` // Members: Specifies the principals requesting access for a Google // Cloud resource. `members` can have the following values: * // `allUsers`: A special identifier that represents anyone who is on the // internet; with or without a Google account. * // `allAuthenticatedUsers`: A special identifier that represents anyone // who is authenticated with a Google account or a service account. Does // not include identities that come from external identity providers // (IdPs) through identity federation. * `user:{emailid}`: An email // address that represents a specific Google account. For example, // `alice@example.com` . * `serviceAccount:{emailid}`: An email address // that represents a Google service account. For example, // `my-other-app@appspot.gserviceaccount.com`. * // `serviceAccount:{projectid}.svc.id.goog[{namespace}/{kubernetes-sa}]`: // An identifier for a Kubernetes service account // (https://cloud.google.com/kubernetes-engine/docs/how-to/kubernetes-service-accounts). // For example, `my-project.svc.id.goog[my-namespace/my-kubernetes-sa]`. // * `group:{emailid}`: An email address that represents a Google group. // For example, `admins@example.com`. * // `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus // unique identifier) representing a user that has been recently // deleted. For example, `alice@example.com?uid=123456789012345678901`. // If the user is recovered, this value reverts to `user:{emailid}` and // the recovered user retains the role in the binding. * // `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address // (plus unique identifier) representing a service account that has been // recently deleted. For example, // `my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901`. // If the service account is undeleted, this value reverts to // `serviceAccount:{emailid}` and the undeleted service account retains // the role in the binding. * `deleted:group:{emailid}?uid={uniqueid}`: // An email address (plus unique identifier) representing a Google group // that has been recently deleted. For example, // `admins@example.com?uid=123456789012345678901`. If the group is // recovered, this value reverts to `group:{emailid}` and the recovered // group retains the role in the binding. * `domain:{domain}`: The G // Suite domain (primary) that represents all the users of that domain. // For example, `google.com` or `example.com`. Members []string `json:"members,omitempty"` // Role: Role that is assigned to the list of `members`, or principals. // For example, `roles/viewer`, `roles/editor`, or `roles/owner`. Role string `json:"role,omitempty"` // ForceSendFields is a list of field names (e.g. "Condition") to // unconditionally include in API requests. By default, fields with // empty or default values are omitted from API requests. However, any // non-pointer, non-interface field appearing in ForceSendFields will be // sent to the server regardless of whether the field is empty or not. // This may be used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` // NullFields is a list of field names (e.g. "Condition") to include in // API requests with the JSON null value. By default, fields with empty // values are omitted from API requests. However, any field with an // empty value appearing in NullFields will be sent to the server as // null. It is an error if a field in this list has a non-empty value. // This may be used to include null fields in Patch requests. NullFields []string `json:"-"` }
Binding: Associates `members`, or principals, with a `role`.
func (*Binding) MarshalJSON ¶
type CancelOperationRequest ¶
type CancelOperationRequest struct { }
CancelOperationRequest: The request message for Operations.CancelOperation.
type ComputeResource ¶
type ComputeResource struct { // BootDiskMib: Extra boot disk size in MiB for each task. BootDiskMib int64 `json:"bootDiskMib,omitempty,string"` // CpuMilli: The milliCPU count. CpuMilli int64 `json:"cpuMilli,omitempty,string"` // MemoryMib: Memory in MiB. MemoryMib int64 `json:"memoryMib,omitempty,string"` // ForceSendFields is a list of field names (e.g. "BootDiskMib") to // unconditionally include in API requests. By default, fields with // empty or default values are omitted from API requests. However, any // non-pointer, non-interface field appearing in ForceSendFields will be // sent to the server regardless of whether the field is empty or not. // This may be used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` // NullFields is a list of field names (e.g. "BootDiskMib") to include // in API requests with the JSON null value. By default, fields with // empty values are omitted from API requests. However, any field with // an empty value appearing in NullFields will be sent to the server as // null. It is an error if a field in this list has a non-empty value. // This may be used to include null fields in Patch requests. NullFields []string `json:"-"` }
ComputeResource: Compute resource requirements
func (*ComputeResource) MarshalJSON ¶
func (s *ComputeResource) MarshalJSON() ([]byte, error)
type Container ¶
type Container struct { // BlockExternalNetwork: If set to true, external network access to and // from container will be blocked. The container will use the default // internal network 'goog-internal'. BlockExternalNetwork bool `json:"blockExternalNetwork,omitempty"` // Commands: 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 `json:"commands,omitempty"` // Entrypoint: Overrides the `ENTRYPOINT` specified in the container. Entrypoint string `json:"entrypoint,omitempty"` // ImageUri: The URI to pull the container image from. ImageUri string `json:"imageUri,omitempty"` // Options: Arbitrary additional options to include in the "docker run" // command when running this container, e.g. "--network host". Options string `json:"options,omitempty"` // Password: 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 `json:"password,omitempty"` // Username: 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 `json:"username,omitempty"` // Volumes: 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 `json:"volumes,omitempty"` // ForceSendFields is a list of field names (e.g. // "BlockExternalNetwork") to unconditionally include in API requests. // By default, fields with empty or default values are omitted from API // requests. However, any non-pointer, non-interface field appearing in // ForceSendFields will be sent to the server regardless of whether the // field is empty or not. This may be used to include empty fields in // Patch requests. ForceSendFields []string `json:"-"` // NullFields is a list of field names (e.g. "BlockExternalNetwork") to // include in API requests with the JSON null value. By default, fields // with empty values are omitted from API requests. However, any field // with an empty value appearing in NullFields will be sent to the // server as null. It is an error if a field in this list has a // non-empty value. This may be used to include null fields in Patch // requests. NullFields []string `json:"-"` }
Container: Container runnable.
func (*Container) MarshalJSON ¶
type Disk ¶
type Disk struct { // DiskInterface: Local SSDs are available through both "SCSI" and // "NVMe" interfaces. If not indicated, "NVMe" will be the default one // for local ssds. We only support "SCSI" for persistent disks now. DiskInterface string `json:"diskInterface,omitempty"` // Image: Name of a public or custom image used as the data source. Image string `json:"image,omitempty"` // SizeGb: Disk size in GB. This field is ignored if `data_source` is // `disk` or `image`. If `type` is `local-ssd`, size_gb should be a // multiple of 375GB, otherwise, the final size will be the next greater // multiple of 375 GB. SizeGb int64 `json:"sizeGb,omitempty,string"` // Snapshot: Name of a snapshot used as the data source. Snapshot string `json:"snapshot,omitempty"` // Type: Disk type as shown in `gcloud compute disk-types list` For // example, "pd-ssd", "pd-standard", "pd-balanced", "local-ssd". Type string `json:"type,omitempty"` // ForceSendFields is a list of field names (e.g. "DiskInterface") to // unconditionally include in API requests. By default, fields with // empty or default values are omitted from API requests. However, any // non-pointer, non-interface field appearing in ForceSendFields will be // sent to the server regardless of whether the field is empty or not. // This may be used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` // NullFields is a list of field names (e.g. "DiskInterface") to include // in API requests with the JSON null value. By default, fields with // empty values are omitted from API requests. However, any field with // an empty value appearing in NullFields will be sent to the server as // null. It is an error if a field in this list has a non-empty value. // This may be used to include null fields in Patch requests. NullFields []string `json:"-"` }
Disk: A new persistent disk or a local ssd. A VM can only have one local SSD setting but multiple local SSD partitions. https://cloud.google.com/compute/docs/disks#pdspecs. https://cloud.google.com/compute/docs/disks#localssds.
func (*Disk) MarshalJSON ¶
type Empty ¶
type Empty struct { // ServerResponse contains the HTTP response code and headers from the // server. googleapi.ServerResponse `json:"-"` }
Empty: A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); }
type Environment ¶
type Environment struct { // EncryptedVariables: An encrypted JSON dictionary where the key/value // pairs correspond to environment variable names and their values. EncryptedVariables *KMSEnvMap `json:"encryptedVariables,omitempty"` // SecretVariables: 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 `json:"secretVariables,omitempty"` // Variables: A map of environment variable names to values. Variables map[string]string `json:"variables,omitempty"` // ForceSendFields is a list of field names (e.g. "EncryptedVariables") // to unconditionally include in API requests. By default, fields with // empty or default values are omitted from API requests. However, any // non-pointer, non-interface field appearing in ForceSendFields will be // sent to the server regardless of whether the field is empty or not. // This may be used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` // NullFields is a list of field names (e.g. "EncryptedVariables") to // include in API requests with the JSON null value. By default, fields // with empty values are omitted from API requests. However, any field // with an empty value appearing in NullFields will be sent to the // server as null. It is an error if a field in this list has a // non-empty value. This may be used to include null fields in Patch // requests. NullFields []string `json:"-"` }
Environment: An Environment describes a collection of environment variables to set when executing Tasks.
func (*Environment) MarshalJSON ¶
func (s *Environment) MarshalJSON() ([]byte, error)
type Expr ¶
type Expr struct { // Description: Optional. Description of the expression. This is a // longer text which describes the expression, e.g. when hovered over it // in a UI. Description string `json:"description,omitempty"` // Expression: Textual representation of an expression in Common // Expression Language syntax. Expression string `json:"expression,omitempty"` // Location: Optional. String indicating the location of the expression // for error reporting, e.g. a file name and a position in the file. Location string `json:"location,omitempty"` // Title: Optional. Title for the expression, i.e. a short string // describing its purpose. This can be used e.g. in UIs which allow to // enter the expression. Title string `json:"title,omitempty"` // ForceSendFields is a list of field names (e.g. "Description") to // unconditionally include in API requests. By default, fields with // empty or default values are omitted from API requests. However, any // non-pointer, non-interface field appearing in ForceSendFields will be // sent to the server regardless of whether the field is empty or not. // This may be used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` // NullFields is a list of field names (e.g. "Description") to include // in API requests with the JSON null value. By default, fields with // empty values are omitted from API requests. However, any field with // an empty value appearing in NullFields will be sent to the server as // null. It is an error if a field in this list has a non-empty value. // This may be used to include null fields in Patch requests. NullFields []string `json:"-"` }
Expr: Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec. Example (Comparison): title: "Summary size limit" description: "Determines if a summary is less than 100 chars" expression: "document.summary.size() < 100" Example (Equality): title: "Requestor is owner" description: "Determines if requestor is the document owner" expression: "document.owner == request.auth.claims.email" Example (Logic): title: "Public documents" description: "Determine whether the document should be publicly visible" expression: "document.type != 'private' && document.type != 'internal'" Example (Data Manipulation): title: "Notification string" description: "Create a notification string with a timestamp." expression: "'New message received at ' + string(document.create_time)" The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information.
func (*Expr) MarshalJSON ¶
type GCS ¶
type GCS struct { // RemotePath: Remote path, either a bucket name or a subdirectory of a // bucket, e.g.: bucket_name, bucket_name/subdirectory/ RemotePath string `json:"remotePath,omitempty"` // ForceSendFields is a list of field names (e.g. "RemotePath") to // unconditionally include in API requests. By default, fields with // empty or default values are omitted from API requests. However, any // non-pointer, non-interface field appearing in ForceSendFields will be // sent to the server regardless of whether the field is empty or not. // This may be used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` // NullFields is a list of field names (e.g. "RemotePath") to include in // API requests with the JSON null value. By default, fields with empty // values are omitted from API requests. However, any field with an // empty value appearing in NullFields will be sent to the server as // null. It is an error if a field in this list has a non-empty value. // This may be used to include null fields in Patch requests. NullFields []string `json:"-"` }
GCS: Represents a Google Cloud Storage volume.
func (*GCS) MarshalJSON ¶
type InstancePolicy ¶
type InstancePolicy struct { // Accelerators: The accelerators attached to each VM instance. Accelerators []*Accelerator `json:"accelerators,omitempty"` // Disks: Non-boot disks to be attached for each VM created by this // InstancePolicy. New disks will be deleted when the VM is deleted. Disks []*AttachedDisk `json:"disks,omitempty"` // MachineType: The Compute Engine machine type. MachineType string `json:"machineType,omitempty"` // MinCpuPlatform: The minimum CPU platform. See // `https://cloud.google.com/compute/docs/instances/specify-min-cpu-platf // orm`. Not yet implemented. MinCpuPlatform string `json:"minCpuPlatform,omitempty"` // ProvisioningModel: The provisioning model. // // Possible values: // "PROVISIONING_MODEL_UNSPECIFIED" - Unspecified. // "STANDARD" - Standard VM. // "SPOT" - SPOT VM. // "PREEMPTIBLE" - 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. ProvisioningModel string `json:"provisioningModel,omitempty"` // ForceSendFields is a list of field names (e.g. "Accelerators") to // unconditionally include in API requests. By default, fields with // empty or default values are omitted from API requests. However, any // non-pointer, non-interface field appearing in ForceSendFields will be // sent to the server regardless of whether the field is empty or not. // This may be used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` // NullFields is a list of field names (e.g. "Accelerators") to include // in API requests with the JSON null value. By default, fields with // empty values are omitted from API requests. However, any field with // an empty value appearing in NullFields will be sent to the server as // null. It is an error if a field in this list has a non-empty value. // This may be used to include null fields in Patch requests. NullFields []string `json:"-"` }
InstancePolicy: InstancePolicy describes an instance type and resources attached to each VM created by this InstancePolicy.
func (*InstancePolicy) MarshalJSON ¶
func (s *InstancePolicy) MarshalJSON() ([]byte, error)
type InstancePolicyOrTemplate ¶
type InstancePolicyOrTemplate struct { // InstallGpuDrivers: 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. InstallGpuDrivers bool `json:"installGpuDrivers,omitempty"` // InstanceTemplate: 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 `json:"instanceTemplate,omitempty"` // Policy: InstancePolicy. Policy *InstancePolicy `json:"policy,omitempty"` // ForceSendFields is a list of field names (e.g. "InstallGpuDrivers") // to unconditionally include in API requests. By default, fields with // empty or default values are omitted from API requests. However, any // non-pointer, non-interface field appearing in ForceSendFields will be // sent to the server regardless of whether the field is empty or not. // This may be used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` // NullFields is a list of field names (e.g. "InstallGpuDrivers") to // include in API requests with the JSON null value. By default, fields // with empty values are omitted from API requests. However, any field // with an empty value appearing in NullFields will be sent to the // server as null. It is an error if a field in this list has a // non-empty value. This may be used to include null fields in Patch // requests. NullFields []string `json:"-"` }
InstancePolicyOrTemplate: Either an InstancePolicy or an instance template.
func (*InstancePolicyOrTemplate) MarshalJSON ¶
func (s *InstancePolicyOrTemplate) MarshalJSON() ([]byte, error)
type InstanceStatus ¶
type InstanceStatus struct { // MachineType: The Compute Engine machine type. MachineType string `json:"machineType,omitempty"` // ProvisioningModel: The VM instance provisioning model. // // Possible values: // "PROVISIONING_MODEL_UNSPECIFIED" - Unspecified. // "STANDARD" - Standard VM. // "SPOT" - SPOT VM. // "PREEMPTIBLE" - 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. ProvisioningModel string `json:"provisioningModel,omitempty"` // TaskPack: The max number of tasks can be assigned to this instance // type. TaskPack int64 `json:"taskPack,omitempty,string"` // ForceSendFields is a list of field names (e.g. "MachineType") to // unconditionally include in API requests. By default, fields with // empty or default values are omitted from API requests. However, any // non-pointer, non-interface field appearing in ForceSendFields will be // sent to the server regardless of whether the field is empty or not. // This may be used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` // NullFields is a list of field names (e.g. "MachineType") to include // in API requests with the JSON null value. By default, fields with // empty values are omitted from API requests. However, any field with // an empty value appearing in NullFields will be sent to the server as // null. It is an error if a field in this list has a non-empty value. // This may be used to include null fields in Patch requests. NullFields []string `json:"-"` }
InstanceStatus: VM instance status.
func (*InstanceStatus) MarshalJSON ¶
func (s *InstanceStatus) MarshalJSON() ([]byte, error)
type Job ¶
type Job struct { // AllocationPolicy: Compute resource allocation for all TaskGroups in // the Job. AllocationPolicy *AllocationPolicy `json:"allocationPolicy,omitempty"` // CreateTime: Output only. When the Job was created. CreateTime string `json:"createTime,omitempty"` // Labels: 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 `json:"labels,omitempty"` // LogsPolicy: Log preservation policy for the Job. LogsPolicy *LogsPolicy `json:"logsPolicy,omitempty"` // Name: Output only. Job name. For example: // "projects/123456/locations/us-central1/jobs/job01". Name string `json:"name,omitempty"` // Notifications: Notification configurations. Notifications []*JobNotification `json:"notifications,omitempty"` // Priority: Priority of the Job. The valid value range is [0, 100). A // job with higher priority value is more likely to run earlier if all // other requirements are satisfied. Priority int64 `json:"priority,omitempty,string"` // Status: Output only. Job status. It is read only for users. Status *JobStatus `json:"status,omitempty"` // TaskGroups: Required. TaskGroups in the Job. Only one TaskGroup is // supported now. TaskGroups []*TaskGroup `json:"taskGroups,omitempty"` // Uid: Output only. A system generated unique ID (in UUID4 format) for // the Job. Uid string `json:"uid,omitempty"` // UpdateTime: Output only. The last time the Job was updated. UpdateTime string `json:"updateTime,omitempty"` // ServerResponse contains the HTTP response code and headers from the // server. googleapi.ServerResponse `json:"-"` // ForceSendFields is a list of field names (e.g. "AllocationPolicy") to // unconditionally include in API requests. By default, fields with // empty or default values are omitted from API requests. However, any // non-pointer, non-interface field appearing in ForceSendFields will be // sent to the server regardless of whether the field is empty or not. // This may be used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` // NullFields is a list of field names (e.g. "AllocationPolicy") to // include in API requests with the JSON null value. By default, fields // with empty values are omitted from API requests. However, any field // with an empty value appearing in NullFields will be sent to the // server as null. It is an error if a field in this list has a // non-empty value. This may be used to include null fields in Patch // requests. NullFields []string `json:"-"` }
Job: The Cloud Batch Job description.
func (*Job) MarshalJSON ¶
type JobNotification ¶
type JobNotification struct { // Message: The attribute requirements of messages to be sent to this // Pub/Sub topic. Without this field, no message will be sent. Message *Message `json:"message,omitempty"` // PubsubTopic: The Pub/Sub topic where notifications like the job state // changes will be published. This topic 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 `json:"pubsubTopic,omitempty"` // ForceSendFields is a list of field names (e.g. "Message") to // unconditionally include in API requests. By default, fields with // empty or default values are omitted from API requests. However, any // non-pointer, non-interface field appearing in ForceSendFields will be // sent to the server regardless of whether the field is empty or not. // This may be used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` // NullFields is a list of field names (e.g. "Message") to include in // API requests with the JSON null value. By default, fields with empty // values are omitted from API requests. However, any field with an // empty value appearing in NullFields will be sent to the server as // null. It is an error if a field in this list has a non-empty value. // This may be used to include null fields in Patch requests. NullFields []string `json:"-"` }
JobNotification: Notification configurations.
func (*JobNotification) MarshalJSON ¶
func (s *JobNotification) MarshalJSON() ([]byte, error)
type JobStatus ¶
type JobStatus struct { // RunDuration: The duration of time that the Job spent in status // RUNNING. RunDuration string `json:"runDuration,omitempty"` // State: Job state // // Possible values: // "STATE_UNSPECIFIED" // "QUEUED" - Job is admitted (validated and persisted) and waiting // for resources. // "SCHEDULED" - 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. // "RUNNING" - Resource allocation has been successful. At least one // Task in the Job is RUNNING. // "SUCCEEDED" - All Tasks in the Job have finished successfully. // "FAILED" - At least one Task in the Job has failed. // "DELETION_IN_PROGRESS" - 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. State string `json:"state,omitempty"` // StatusEvents: Job status events StatusEvents []*StatusEvent `json:"statusEvents,omitempty"` // TaskGroups: Aggregated task status for each TaskGroup in the Job. The // map key is TaskGroup ID. TaskGroups map[string]TaskGroupStatus `json:"taskGroups,omitempty"` // ForceSendFields is a list of field names (e.g. "RunDuration") to // unconditionally include in API requests. By default, fields with // empty or default values are omitted from API requests. However, any // non-pointer, non-interface field appearing in ForceSendFields will be // sent to the server regardless of whether the field is empty or not. // This may be used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` // NullFields is a list of field names (e.g. "RunDuration") to include // in API requests with the JSON null value. By default, fields with // empty values are omitted from API requests. However, any field with // an empty value appearing in NullFields will be sent to the server as // null. It is an error if a field in this list has a non-empty value. // This may be used to include null fields in Patch requests. NullFields []string `json:"-"` }
JobStatus: Job status.
func (*JobStatus) MarshalJSON ¶
type KMSEnvMap ¶ added in v0.106.0
type KMSEnvMap struct { // CipherText: The value of the cipherText response from the `encrypt` // method. CipherText string `json:"cipherText,omitempty"` // KeyName: The name of the KMS key that will be used to decrypt the // cipher text. KeyName string `json:"keyName,omitempty"` // ForceSendFields is a list of field names (e.g. "CipherText") to // unconditionally include in API requests. By default, fields with // empty or default values are omitted from API requests. However, any // non-pointer, non-interface field appearing in ForceSendFields will be // sent to the server regardless of whether the field is empty or not. // This may be used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` // NullFields is a list of field names (e.g. "CipherText") to include in // API requests with the JSON null value. By default, fields with empty // values are omitted from API requests. However, any field with an // empty value appearing in NullFields will be sent to the server as // null. It is an error if a field in this list has a non-empty value. // This may be used to include null fields in Patch requests. NullFields []string `json:"-"` }
func (*KMSEnvMap) MarshalJSON ¶ added in v0.106.0
type LifecyclePolicy ¶
type LifecyclePolicy struct { // Action: Action to execute when ActionCondition is true. // // Possible values: // "ACTION_UNSPECIFIED" - Action unspecified. // "RETRY_TASK" - Action that tasks in the group will be scheduled to // re-execute. // "FAIL_TASK" - Action that tasks in the group will be stopped // immediately. Action string `json:"action,omitempty"` // ActionCondition: Conditions that decide why a task failure is dealt // with a specific action. ActionCondition *ActionCondition `json:"actionCondition,omitempty"` // ForceSendFields is a list of field names (e.g. "Action") to // unconditionally include in API requests. By default, fields with // empty or default values are omitted from API requests. However, any // non-pointer, non-interface field appearing in ForceSendFields will be // sent to the server regardless of whether the field is empty or not. // This may be used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` // NullFields is a list of field names (e.g. "Action") to include in API // requests with the JSON null value. By default, fields with empty // values are omitted from API requests. However, any field with an // empty value appearing in NullFields will be sent to the server as // null. It is an error if a field in this list has a non-empty value. // This may be used to include null fields in Patch requests. NullFields []string `json:"-"` }
LifecyclePolicy: LifecyclePolicy describes how to deal with task failures based on different conditions.
func (*LifecyclePolicy) MarshalJSON ¶
func (s *LifecyclePolicy) MarshalJSON() ([]byte, error)
type ListJobsResponse ¶
type ListJobsResponse struct { // Jobs: Jobs. Jobs []*Job `json:"jobs,omitempty"` // NextPageToken: Next page token. NextPageToken string `json:"nextPageToken,omitempty"` // Unreachable: Locations that could not be reached. Unreachable []string `json:"unreachable,omitempty"` // ServerResponse contains the HTTP response code and headers from the // server. googleapi.ServerResponse `json:"-"` // ForceSendFields is a list of field names (e.g. "Jobs") to // unconditionally include in API requests. By default, fields with // empty or default values are omitted from API requests. However, any // non-pointer, non-interface field appearing in ForceSendFields will be // sent to the server regardless of whether the field is empty or not. // This may be used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` // NullFields is a list of field names (e.g. "Jobs") to include in API // requests with the JSON null value. By default, fields with empty // values are omitted from API requests. However, any field with an // empty value appearing in NullFields will be sent to the server as // null. It is an error if a field in this list has a non-empty value. // This may be used to include null fields in Patch requests. NullFields []string `json:"-"` }
ListJobsResponse: ListJob Response.
func (*ListJobsResponse) MarshalJSON ¶
func (s *ListJobsResponse) MarshalJSON() ([]byte, error)
type ListLocationsResponse ¶
type ListLocationsResponse struct { // Locations: A list of locations that matches the specified filter in // the request. Locations []*Location `json:"locations,omitempty"` // NextPageToken: The standard List next-page token. NextPageToken string `json:"nextPageToken,omitempty"` // ServerResponse contains the HTTP response code and headers from the // server. googleapi.ServerResponse `json:"-"` // ForceSendFields is a list of field names (e.g. "Locations") to // unconditionally include in API requests. By default, fields with // empty or default values are omitted from API requests. However, any // non-pointer, non-interface field appearing in ForceSendFields will be // sent to the server regardless of whether the field is empty or not. // This may be used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` // NullFields is a list of field names (e.g. "Locations") to include in // API requests with the JSON null value. By default, fields with empty // values are omitted from API requests. However, any field with an // empty value appearing in NullFields will be sent to the server as // null. It is an error if a field in this list has a non-empty value. // This may be used to include null fields in Patch requests. NullFields []string `json:"-"` }
ListLocationsResponse: The response message for Locations.ListLocations.
func (*ListLocationsResponse) MarshalJSON ¶
func (s *ListLocationsResponse) MarshalJSON() ([]byte, error)
type ListOperationsResponse ¶
type ListOperationsResponse struct { // NextPageToken: The standard List next-page token. NextPageToken string `json:"nextPageToken,omitempty"` // Operations: A list of operations that matches the specified filter in // the request. Operations []*Operation `json:"operations,omitempty"` // ServerResponse contains the HTTP response code and headers from the // server. googleapi.ServerResponse `json:"-"` // ForceSendFields is a list of field names (e.g. "NextPageToken") to // unconditionally include in API requests. By default, fields with // empty or default values are omitted from API requests. However, any // non-pointer, non-interface field appearing in ForceSendFields will be // sent to the server regardless of whether the field is empty or not. // This may be used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` // NullFields is a list of field names (e.g. "NextPageToken") to include // in API requests with the JSON null value. By default, fields with // empty values are omitted from API requests. However, any field with // an empty value appearing in NullFields will be sent to the server as // null. It is an error if a field in this list has a non-empty value. // This may be used to include null fields in Patch requests. NullFields []string `json:"-"` }
ListOperationsResponse: The response message for Operations.ListOperations.
func (*ListOperationsResponse) MarshalJSON ¶
func (s *ListOperationsResponse) MarshalJSON() ([]byte, error)
type ListTasksResponse ¶
type ListTasksResponse struct { // NextPageToken: Next page token. NextPageToken string `json:"nextPageToken,omitempty"` // Tasks: Tasks. Tasks []*Task `json:"tasks,omitempty"` // Unreachable: Locations that could not be reached. Unreachable []string `json:"unreachable,omitempty"` // ServerResponse contains the HTTP response code and headers from the // server. googleapi.ServerResponse `json:"-"` // ForceSendFields is a list of field names (e.g. "NextPageToken") to // unconditionally include in API requests. By default, fields with // empty or default values are omitted from API requests. However, any // non-pointer, non-interface field appearing in ForceSendFields will be // sent to the server regardless of whether the field is empty or not. // This may be used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` // NullFields is a list of field names (e.g. "NextPageToken") to include // in API requests with the JSON null value. By default, fields with // empty values are omitted from API requests. However, any field with // an empty value appearing in NullFields will be sent to the server as // null. It is an error if a field in this list has a non-empty value. // This may be used to include null fields in Patch requests. NullFields []string `json:"-"` }
ListTasksResponse: ListTasks Response.
func (*ListTasksResponse) MarshalJSON ¶
func (s *ListTasksResponse) MarshalJSON() ([]byte, error)
type Location ¶
type Location struct { // DisplayName: The friendly name for this location, typically a nearby // city name. For example, "Tokyo". DisplayName string `json:"displayName,omitempty"` // Labels: Cross-service attributes for the location. For example // {"cloud.googleapis.com/region": "us-east1"} Labels map[string]string `json:"labels,omitempty"` // LocationId: The canonical id for this location. For example: // "us-east1". LocationId string `json:"locationId,omitempty"` // Metadata: Service-specific metadata. For example the available // capacity at the given location. Metadata googleapi.RawMessage `json:"metadata,omitempty"` // Name: Resource name for the location, which may vary between // implementations. For example: // "projects/example-project/locations/us-east1" Name string `json:"name,omitempty"` // ServerResponse contains the HTTP response code and headers from the // server. googleapi.ServerResponse `json:"-"` // ForceSendFields is a list of field names (e.g. "DisplayName") to // unconditionally include in API requests. By default, fields with // empty or default values are omitted from API requests. However, any // non-pointer, non-interface field appearing in ForceSendFields will be // sent to the server regardless of whether the field is empty or not. // This may be used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` // NullFields is a list of field names (e.g. "DisplayName") to include // in API requests with the JSON null value. By default, fields with // empty values are omitted from API requests. However, any field with // an empty value appearing in NullFields will be sent to the server as // null. It is an error if a field in this list has a non-empty value. // This may be used to include null fields in Patch requests. NullFields []string `json:"-"` }
Location: A resource that represents Google Cloud Platform location.
func (*Location) MarshalJSON ¶
type LocationPolicy ¶
type LocationPolicy struct { // AllowedLocations: 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 `json:"allowedLocations,omitempty"` // ForceSendFields is a list of field names (e.g. "AllowedLocations") to // unconditionally include in API requests. By default, fields with // empty or default values are omitted from API requests. However, any // non-pointer, non-interface field appearing in ForceSendFields will be // sent to the server regardless of whether the field is empty or not. // This may be used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` // NullFields is a list of field names (e.g. "AllowedLocations") to // include in API requests with the JSON null value. By default, fields // with empty values are omitted from API requests. However, any field // with an empty value appearing in NullFields will be sent to the // server as null. It is an error if a field in this list has a // non-empty value. This may be used to include null fields in Patch // requests. NullFields []string `json:"-"` }
func (*LocationPolicy) MarshalJSON ¶
func (s *LocationPolicy) MarshalJSON() ([]byte, error)
type LogsPolicy ¶
type LogsPolicy struct { // Destination: Where logs should be saved. // // Possible values: // "DESTINATION_UNSPECIFIED" - Logs are not preserved. // "CLOUD_LOGGING" - Logs are streamed to Cloud Logging. // "PATH" - Logs are saved to a file path. Destination string `json:"destination,omitempty"` // LogsPath: 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 `json:"logsPath,omitempty"` // ForceSendFields is a list of field names (e.g. "Destination") to // unconditionally include in API requests. By default, fields with // empty or default values are omitted from API requests. However, any // non-pointer, non-interface field appearing in ForceSendFields will be // sent to the server regardless of whether the field is empty or not. // This may be used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` // NullFields is a list of field names (e.g. "Destination") to include // in API requests with the JSON null value. By default, fields with // empty values are omitted from API requests. However, any field with // an empty value appearing in NullFields will be sent to the server as // null. It is an error if a field in this list has a non-empty value. // This may be used to include null fields in Patch requests. NullFields []string `json:"-"` }
LogsPolicy: LogsPolicy describes how outputs from a Job's Tasks (stdout/stderr) will be preserved.
func (*LogsPolicy) MarshalJSON ¶
func (s *LogsPolicy) MarshalJSON() ([]byte, error)
type Message ¶
type Message struct { // NewJobState: The new job state. // // Possible values: // "STATE_UNSPECIFIED" // "QUEUED" - Job is admitted (validated and persisted) and waiting // for resources. // "SCHEDULED" - 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. // "RUNNING" - Resource allocation has been successful. At least one // Task in the Job is RUNNING. // "SUCCEEDED" - All Tasks in the Job have finished successfully. // "FAILED" - At least one Task in the Job has failed. // "DELETION_IN_PROGRESS" - 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. NewJobState string `json:"newJobState,omitempty"` // NewTaskState: The new task state. // // Possible values: // "STATE_UNSPECIFIED" - unknown state // "PENDING" - The Task is created and waiting for resources. // "ASSIGNED" - The Task is assigned to at least one VM. // "RUNNING" - The Task is running. // "FAILED" - The Task has failed. // "SUCCEEDED" - The Task has succeeded. NewTaskState string `json:"newTaskState,omitempty"` // Type: The message type. // // Possible values: // "TYPE_UNSPECIFIED" - Unspecified. // "JOB_STATE_CHANGED" - Notify users that the job state has changed. // "TASK_STATE_CHANGED" - Notify users that the task state has // changed. Type string `json:"type,omitempty"` // ForceSendFields is a list of field names (e.g. "NewJobState") to // unconditionally include in API requests. By default, fields with // empty or default values are omitted from API requests. However, any // non-pointer, non-interface field appearing in ForceSendFields will be // sent to the server regardless of whether the field is empty or not. // This may be used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` // NullFields is a list of field names (e.g. "NewJobState") to include // in API requests with the JSON null value. By default, fields with // empty values are omitted from API requests. However, any field with // an empty value appearing in NullFields will be sent to the server as // null. It is an error if a field in this list has a non-empty value. // This may be used to include null fields in Patch requests. NullFields []string `json:"-"` }
Message: Message details. Describe the attribute that a message should have. Without specified message attributes, no message will be sent by default.
func (*Message) MarshalJSON ¶
type NFS ¶
type NFS struct { // RemotePath: Remote source path exported from the NFS, e.g., "/share". RemotePath string `json:"remotePath,omitempty"` // Server: The IP address of the NFS. Server string `json:"server,omitempty"` // ForceSendFields is a list of field names (e.g. "RemotePath") to // unconditionally include in API requests. By default, fields with // empty or default values are omitted from API requests. However, any // non-pointer, non-interface field appearing in ForceSendFields will be // sent to the server regardless of whether the field is empty or not. // This may be used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` // NullFields is a list of field names (e.g. "RemotePath") to include in // API requests with the JSON null value. By default, fields with empty // values are omitted from API requests. However, any field with an // empty value appearing in NullFields will be sent to the server as // null. It is an error if a field in this list has a non-empty value. // This may be used to include null fields in Patch requests. NullFields []string `json:"-"` }
NFS: Represents an NFS volume.
func (*NFS) MarshalJSON ¶
type NetworkInterface ¶
type NetworkInterface struct { // Network: 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 `json:"network,omitempty"` // NoExternalIpAddress: 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 `json:"noExternalIpAddress,omitempty"` // Subnetwork: 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 `json:"subnetwork,omitempty"` // ForceSendFields is a list of field names (e.g. "Network") to // unconditionally include in API requests. By default, fields with // empty or default values are omitted from API requests. However, any // non-pointer, non-interface field appearing in ForceSendFields will be // sent to the server regardless of whether the field is empty or not. // This may be used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` // NullFields is a list of field names (e.g. "Network") to include in // API requests with the JSON null value. By default, fields with empty // values are omitted from API requests. However, any field with an // empty value appearing in NullFields will be sent to the server as // null. It is an error if a field in this list has a non-empty value. // This may be used to include null fields in Patch requests. NullFields []string `json:"-"` }
NetworkInterface: A network interface.
func (*NetworkInterface) MarshalJSON ¶
func (s *NetworkInterface) MarshalJSON() ([]byte, error)
type NetworkPolicy ¶
type NetworkPolicy struct { // NetworkInterfaces: Network configurations. NetworkInterfaces []*NetworkInterface `json:"networkInterfaces,omitempty"` // ForceSendFields is a list of field names (e.g. "NetworkInterfaces") // to unconditionally include in API requests. By default, fields with // empty or default values are omitted from API requests. However, any // non-pointer, non-interface field appearing in ForceSendFields will be // sent to the server regardless of whether the field is empty or not. // This may be used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` // NullFields is a list of field names (e.g. "NetworkInterfaces") to // include in API requests with the JSON null value. By default, fields // with empty values are omitted from API requests. However, any field // with an empty value appearing in NullFields will be sent to the // server as null. It is an error if a field in this list has a // non-empty value. This may be used to include null fields in Patch // requests. NullFields []string `json:"-"` }
NetworkPolicy: NetworkPolicy describes VM instance network configurations.
func (*NetworkPolicy) MarshalJSON ¶
func (s *NetworkPolicy) MarshalJSON() ([]byte, error)
type Operation ¶
type Operation struct { // Done: If the value is `false`, it means the operation is still in // progress. If `true`, the operation is completed, and either `error` // or `response` is available. Done bool `json:"done,omitempty"` // Error: The error result of the operation in case of failure or // cancellation. Error *Status `json:"error,omitempty"` // Metadata: Service-specific metadata associated with the operation. It // typically contains progress information and common metadata such as // create time. Some services might not provide such metadata. Any // method that returns a long-running operation should document the // metadata type, if any. Metadata googleapi.RawMessage `json:"metadata,omitempty"` // Name: The server-assigned name, which is only unique within the same // service that originally returns it. If you use the default HTTP // mapping, the `name` should be a resource name ending with // `operations/{unique_id}`. Name string `json:"name,omitempty"` // Response: The normal response of the operation in case of success. If // the original method returns no data on success, such as `Delete`, the // response is `google.protobuf.Empty`. If the original method is // standard `Get`/`Create`/`Update`, the response should be the // resource. For other methods, the response should have the type // `XxxResponse`, where `Xxx` is the original method name. For example, // if the original method name is `TakeSnapshot()`, the inferred // response type is `TakeSnapshotResponse`. Response googleapi.RawMessage `json:"response,omitempty"` // ServerResponse contains the HTTP response code and headers from the // server. googleapi.ServerResponse `json:"-"` // ForceSendFields is a list of field names (e.g. "Done") to // unconditionally include in API requests. By default, fields with // empty or default values are omitted from API requests. However, any // non-pointer, non-interface field appearing in ForceSendFields will be // sent to the server regardless of whether the field is empty or not. // This may be used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` // NullFields is a list of field names (e.g. "Done") to include in API // requests with the JSON null value. By default, fields with empty // values are omitted from API requests. However, any field with an // empty value appearing in NullFields will be sent to the server as // null. It is an error if a field in this list has a non-empty value. // This may be used to include null fields in Patch requests. NullFields []string `json:"-"` }
Operation: This resource represents a long-running operation that is the result of a network API call.
func (*Operation) MarshalJSON ¶
type OperationMetadata ¶
type OperationMetadata struct { // ApiVersion: Output only. API version used to start the operation. ApiVersion string `json:"apiVersion,omitempty"` // CreateTime: Output only. The time the operation was created. CreateTime string `json:"createTime,omitempty"` // EndTime: Output only. The time the operation finished running. EndTime string `json:"endTime,omitempty"` // RequestedCancellation: 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 of 1, corresponding to `Code.CANCELLED`. RequestedCancellation bool `json:"requestedCancellation,omitempty"` // StatusMessage: Output only. Human-readable status of the operation, // if any. StatusMessage string `json:"statusMessage,omitempty"` // Target: Output only. Server-defined resource path for the target of // the operation. Target string `json:"target,omitempty"` // Verb: Output only. Name of the verb executed by the operation. Verb string `json:"verb,omitempty"` // ForceSendFields is a list of field names (e.g. "ApiVersion") to // unconditionally include in API requests. By default, fields with // empty or default values are omitted from API requests. However, any // non-pointer, non-interface field appearing in ForceSendFields will be // sent to the server regardless of whether the field is empty or not. // This may be used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` // NullFields is a list of field names (e.g. "ApiVersion") to include in // API requests with the JSON null value. By default, fields with empty // values are omitted from API requests. However, any field with an // empty value appearing in NullFields will be sent to the server as // null. It is an error if a field in this list has a non-empty value. // This may be used to include null fields in Patch requests. NullFields []string `json:"-"` }
OperationMetadata: Represents the metadata of the long-running operation.
func (*OperationMetadata) MarshalJSON ¶
func (s *OperationMetadata) MarshalJSON() ([]byte, error)
type Policy ¶
type Policy struct { // AuditConfigs: Specifies cloud audit logging configuration for this // policy. AuditConfigs []*AuditConfig `json:"auditConfigs,omitempty"` // Bindings: Associates a list of `members`, or principals, with a // `role`. Optionally, may specify a `condition` that determines how and // when the `bindings` are applied. Each of the `bindings` must contain // at least one principal. The `bindings` in a `Policy` can refer to up // to 1,500 principals; up to 250 of these principals can be Google // groups. Each occurrence of a principal counts towards these limits. // For example, if the `bindings` grant 50 different roles to // `user:alice@example.com`, and not to any other principal, then you // can add another 1,450 principals to the `bindings` in the `Policy`. Bindings []*Binding `json:"bindings,omitempty"` // Etag: `etag` is used for optimistic concurrency control as a way to // help prevent simultaneous updates of a policy from overwriting each // other. It is strongly suggested that systems make use of the `etag` // in the read-modify-write cycle to perform policy updates in order to // avoid race conditions: An `etag` is returned in the response to // `getIamPolicy`, and systems are expected to put that etag in the // request to `setIamPolicy` to ensure that their change will be applied // to the same version of the policy. **Important:** If you use IAM // Conditions, you must include the `etag` field whenever you call // `setIamPolicy`. If you omit this field, then IAM allows you to // overwrite a version `3` policy with a version `1` policy, and all of // the conditions in the version `3` policy are lost. Etag string `json:"etag,omitempty"` // Version: Specifies the format of the policy. Valid values are `0`, // `1`, and `3`. Requests that specify an invalid value are rejected. // Any operation that affects conditional role bindings must specify // version `3`. This requirement applies to the following operations: * // Getting a policy that includes a conditional role binding * Adding a // conditional role binding to a policy * Changing a conditional role // binding in a policy * Removing any role binding, with or without a // condition, from a policy that includes conditions **Important:** If // you use IAM Conditions, you must include the `etag` field whenever // you call `setIamPolicy`. If you omit this field, then IAM allows you // to overwrite a version `3` policy with a version `1` policy, and all // of the conditions in the version `3` policy are lost. If a policy // does not include any conditions, operations on that policy may // specify any valid version or leave the field unset. To learn which // resources support conditions in their IAM policies, see the IAM // documentation // (https://cloud.google.com/iam/help/conditions/resource-policies). Version int64 `json:"version,omitempty"` // ServerResponse contains the HTTP response code and headers from the // server. googleapi.ServerResponse `json:"-"` // ForceSendFields is a list of field names (e.g. "AuditConfigs") to // unconditionally include in API requests. By default, fields with // empty or default values are omitted from API requests. However, any // non-pointer, non-interface field appearing in ForceSendFields will be // sent to the server regardless of whether the field is empty or not. // This may be used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` // NullFields is a list of field names (e.g. "AuditConfigs") to include // in API requests with the JSON null value. By default, fields with // empty values are omitted from API requests. However, any field with // an empty value appearing in NullFields will be sent to the server as // null. It is an error if a field in this list has a non-empty value. // This may be used to include null fields in Patch requests. NullFields []string `json:"-"` }
Policy: An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources. A `Policy` is a collection of `bindings`. A `binding` binds one or more `members`, or principals, to a single `role`. Principals can be user accounts, service accounts, Google groups, and domains (such as G Suite). A `role` is a named list of permissions; each `role` can be an IAM predefined role or a user-created custom role. For some types of Google Cloud resources, a `binding` can also specify a `condition`, which is a logical expression that allows access to a resource only if the expression evaluates to `true`. A condition can add constraints based on attributes of the request, the resource, or both. To learn which resources support conditions in their IAM policies, see the IAM documentation (https://cloud.google.com/iam/help/conditions/resource-policies). **JSON example:** { "bindings": [ { "role": "roles/resourcemanager.organizationAdmin", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-project-id@appspot.gserviceaccount.com" ] }, { "role": "roles/resourcemanager.organizationViewer", "members": [ "user:eve@example.com" ], "condition": { "title": "expirable access", "description": "Does not grant access after Sep 2020", "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')", } } ], "etag": "BwWWja0YfJA=", "version": 3 } **YAML example:** bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-project-id@appspot.gserviceaccount.com role: roles/resourcemanager.organizationAdmin - members: - user:eve@example.com role: roles/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time < timestamp('2020-10-01T00:00:00.000Z') etag: BwWWja0YfJA= version: 3 For a description of IAM and its features, see the IAM documentation (https://cloud.google.com/iam/docs/).
func (*Policy) MarshalJSON ¶
type ProjectsLocationsGetCall ¶
type ProjectsLocationsGetCall struct {
// contains filtered or unexported fields
}
func (*ProjectsLocationsGetCall) Context ¶
func (c *ProjectsLocationsGetCall) Context(ctx context.Context) *ProjectsLocationsGetCall
Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.
func (*ProjectsLocationsGetCall) Do ¶
func (c *ProjectsLocationsGetCall) Do(opts ...googleapi.CallOption) (*Location, error)
Do executes the "batch.projects.locations.get" call. Exactly one of *Location or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *Location.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.
func (*ProjectsLocationsGetCall) Fields ¶
func (c *ProjectsLocationsGetCall) Fields(s ...googleapi.Field) *ProjectsLocationsGetCall
Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.
func (*ProjectsLocationsGetCall) Header ¶
func (c *ProjectsLocationsGetCall) Header() http.Header
Header returns an http.Header that can be modified by the caller to add HTTP headers to the request.
func (*ProjectsLocationsGetCall) IfNoneMatch ¶
func (c *ProjectsLocationsGetCall) IfNoneMatch(entityTag string) *ProjectsLocationsGetCall
IfNoneMatch sets the optional parameter which makes the operation fail if the object's ETag matches the given value. This is useful for getting updates only after the object has changed since the last request. Use googleapi.IsNotModified to check whether the response error from Do is the result of In-None-Match.
type ProjectsLocationsJobsCreateCall ¶
type ProjectsLocationsJobsCreateCall struct {
// contains filtered or unexported fields
}
func (*ProjectsLocationsJobsCreateCall) Context ¶
func (c *ProjectsLocationsJobsCreateCall) Context(ctx context.Context) *ProjectsLocationsJobsCreateCall
Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.
func (*ProjectsLocationsJobsCreateCall) Do ¶
func (c *ProjectsLocationsJobsCreateCall) Do(opts ...googleapi.CallOption) (*Job, error)
Do executes the "batch.projects.locations.jobs.create" call. Exactly one of *Job or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *Job.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.
func (*ProjectsLocationsJobsCreateCall) Fields ¶
func (c *ProjectsLocationsJobsCreateCall) Fields(s ...googleapi.Field) *ProjectsLocationsJobsCreateCall
Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.
func (*ProjectsLocationsJobsCreateCall) Header ¶
func (c *ProjectsLocationsJobsCreateCall) Header() http.Header
Header returns an http.Header that can be modified by the caller to add HTTP headers to the request.
func (*ProjectsLocationsJobsCreateCall) JobId ¶
func (c *ProjectsLocationsJobsCreateCall) JobId(jobId string) *ProjectsLocationsJobsCreateCall
JobId sets the optional parameter "jobId": 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}".
func (*ProjectsLocationsJobsCreateCall) RequestId ¶
func (c *ProjectsLocationsJobsCreateCall) RequestId(requestId string) *ProjectsLocationsJobsCreateCall
RequestId sets the optional parameter "requestId": 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).
type ProjectsLocationsJobsDeleteCall ¶
type ProjectsLocationsJobsDeleteCall struct {
// contains filtered or unexported fields
}
func (*ProjectsLocationsJobsDeleteCall) Context ¶
func (c *ProjectsLocationsJobsDeleteCall) Context(ctx context.Context) *ProjectsLocationsJobsDeleteCall
Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.
func (*ProjectsLocationsJobsDeleteCall) Do ¶
func (c *ProjectsLocationsJobsDeleteCall) Do(opts ...googleapi.CallOption) (*Operation, error)
Do executes the "batch.projects.locations.jobs.delete" call. Exactly one of *Operation or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *Operation.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.
func (*ProjectsLocationsJobsDeleteCall) Fields ¶
func (c *ProjectsLocationsJobsDeleteCall) Fields(s ...googleapi.Field) *ProjectsLocationsJobsDeleteCall
Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.
func (*ProjectsLocationsJobsDeleteCall) Header ¶
func (c *ProjectsLocationsJobsDeleteCall) Header() http.Header
Header returns an http.Header that can be modified by the caller to add HTTP headers to the request.
func (*ProjectsLocationsJobsDeleteCall) Reason ¶
func (c *ProjectsLocationsJobsDeleteCall) Reason(reason string) *ProjectsLocationsJobsDeleteCall
Reason sets the optional parameter "reason": Reason for this deletion.
func (*ProjectsLocationsJobsDeleteCall) RequestId ¶
func (c *ProjectsLocationsJobsDeleteCall) RequestId(requestId string) *ProjectsLocationsJobsDeleteCall
RequestId sets the optional parameter "requestId": 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).
type ProjectsLocationsJobsGetCall ¶
type ProjectsLocationsJobsGetCall struct {
// contains filtered or unexported fields
}
func (*ProjectsLocationsJobsGetCall) Context ¶
func (c *ProjectsLocationsJobsGetCall) Context(ctx context.Context) *ProjectsLocationsJobsGetCall
Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.
func (*ProjectsLocationsJobsGetCall) Do ¶
func (c *ProjectsLocationsJobsGetCall) Do(opts ...googleapi.CallOption) (*Job, error)
Do executes the "batch.projects.locations.jobs.get" call. Exactly one of *Job or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *Job.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.
func (*ProjectsLocationsJobsGetCall) Fields ¶
func (c *ProjectsLocationsJobsGetCall) Fields(s ...googleapi.Field) *ProjectsLocationsJobsGetCall
Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.
func (*ProjectsLocationsJobsGetCall) Header ¶
func (c *ProjectsLocationsJobsGetCall) Header() http.Header
Header returns an http.Header that can be modified by the caller to add HTTP headers to the request.
func (*ProjectsLocationsJobsGetCall) IfNoneMatch ¶
func (c *ProjectsLocationsJobsGetCall) IfNoneMatch(entityTag string) *ProjectsLocationsJobsGetCall
IfNoneMatch sets the optional parameter which makes the operation fail if the object's ETag matches the given value. This is useful for getting updates only after the object has changed since the last request. Use googleapi.IsNotModified to check whether the response error from Do is the result of In-None-Match.
type ProjectsLocationsJobsGetIamPolicyCall ¶
type ProjectsLocationsJobsGetIamPolicyCall struct {
// contains filtered or unexported fields
}
func (*ProjectsLocationsJobsGetIamPolicyCall) Context ¶
func (c *ProjectsLocationsJobsGetIamPolicyCall) Context(ctx context.Context) *ProjectsLocationsJobsGetIamPolicyCall
Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.
func (*ProjectsLocationsJobsGetIamPolicyCall) Do ¶
func (c *ProjectsLocationsJobsGetIamPolicyCall) Do(opts ...googleapi.CallOption) (*Policy, error)
Do executes the "batch.projects.locations.jobs.getIamPolicy" call. Exactly one of *Policy or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *Policy.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.
func (*ProjectsLocationsJobsGetIamPolicyCall) Fields ¶
func (c *ProjectsLocationsJobsGetIamPolicyCall) Fields(s ...googleapi.Field) *ProjectsLocationsJobsGetIamPolicyCall
Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.
func (*ProjectsLocationsJobsGetIamPolicyCall) Header ¶
func (c *ProjectsLocationsJobsGetIamPolicyCall) Header() http.Header
Header returns an http.Header that can be modified by the caller to add HTTP headers to the request.
func (*ProjectsLocationsJobsGetIamPolicyCall) IfNoneMatch ¶
func (c *ProjectsLocationsJobsGetIamPolicyCall) IfNoneMatch(entityTag string) *ProjectsLocationsJobsGetIamPolicyCall
IfNoneMatch sets the optional parameter which makes the operation fail if the object's ETag matches the given value. This is useful for getting updates only after the object has changed since the last request. Use googleapi.IsNotModified to check whether the response error from Do is the result of In-None-Match.
func (*ProjectsLocationsJobsGetIamPolicyCall) OptionsRequestedPolicyVersion ¶
func (c *ProjectsLocationsJobsGetIamPolicyCall) OptionsRequestedPolicyVersion(optionsRequestedPolicyVersion int64) *ProjectsLocationsJobsGetIamPolicyCall
OptionsRequestedPolicyVersion sets the optional parameter "options.requestedPolicyVersion": The maximum policy version that will be used to format the policy. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for policies with any conditional role bindings must specify version 3. Policies with no conditional role bindings may specify any valid value or leave the field unset. The policy in the response might use the policy version that you specified, or it might use a lower policy version. For example, if you specify version 3, but the policy has no conditional role bindings, the response uses version 1. To learn which resources support conditions in their IAM policies, see the IAM documentation (https://cloud.google.com/iam/help/conditions/resource-policies).
type ProjectsLocationsJobsListCall ¶
type ProjectsLocationsJobsListCall struct {
// contains filtered or unexported fields
}
func (*ProjectsLocationsJobsListCall) Context ¶
func (c *ProjectsLocationsJobsListCall) Context(ctx context.Context) *ProjectsLocationsJobsListCall
Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.
func (*ProjectsLocationsJobsListCall) Do ¶
func (c *ProjectsLocationsJobsListCall) Do(opts ...googleapi.CallOption) (*ListJobsResponse, error)
Do executes the "batch.projects.locations.jobs.list" call. Exactly one of *ListJobsResponse or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *ListJobsResponse.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.
func (*ProjectsLocationsJobsListCall) Fields ¶
func (c *ProjectsLocationsJobsListCall) Fields(s ...googleapi.Field) *ProjectsLocationsJobsListCall
Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.
func (*ProjectsLocationsJobsListCall) Filter ¶
func (c *ProjectsLocationsJobsListCall) Filter(filter string) *ProjectsLocationsJobsListCall
Filter sets the optional parameter "filter": List filter.
func (*ProjectsLocationsJobsListCall) Header ¶
func (c *ProjectsLocationsJobsListCall) Header() http.Header
Header returns an http.Header that can be modified by the caller to add HTTP headers to the request.
func (*ProjectsLocationsJobsListCall) IfNoneMatch ¶
func (c *ProjectsLocationsJobsListCall) IfNoneMatch(entityTag string) *ProjectsLocationsJobsListCall
IfNoneMatch sets the optional parameter which makes the operation fail if the object's ETag matches the given value. This is useful for getting updates only after the object has changed since the last request. Use googleapi.IsNotModified to check whether the response error from Do is the result of In-None-Match.
func (*ProjectsLocationsJobsListCall) PageSize ¶
func (c *ProjectsLocationsJobsListCall) PageSize(pageSize int64) *ProjectsLocationsJobsListCall
PageSize sets the optional parameter "pageSize": Page size.
func (*ProjectsLocationsJobsListCall) PageToken ¶
func (c *ProjectsLocationsJobsListCall) PageToken(pageToken string) *ProjectsLocationsJobsListCall
PageToken sets the optional parameter "pageToken": Page token.
func (*ProjectsLocationsJobsListCall) Pages ¶
func (c *ProjectsLocationsJobsListCall) Pages(ctx context.Context, f func(*ListJobsResponse) error) error
Pages invokes f for each page of results. A non-nil error returned from f will halt the iteration. The provided context supersedes any context provided to the Context method.
type ProjectsLocationsJobsService ¶
type ProjectsLocationsJobsService struct { TaskGroups *ProjectsLocationsJobsTaskGroupsService // contains filtered or unexported fields }
func NewProjectsLocationsJobsService ¶
func NewProjectsLocationsJobsService(s *Service) *ProjectsLocationsJobsService
func (*ProjectsLocationsJobsService) Create ¶
func (r *ProjectsLocationsJobsService) Create(parent string, job *Job) *ProjectsLocationsJobsCreateCall
Create: Create a Job.
- parent: The parent resource name where the Job will be created. Pattern: "projects/{project}/locations/{location}".
func (*ProjectsLocationsJobsService) Delete ¶
func (r *ProjectsLocationsJobsService) Delete(name string) *ProjectsLocationsJobsDeleteCall
Delete: Delete a Job.
- name: Job name.
func (*ProjectsLocationsJobsService) Get ¶
func (r *ProjectsLocationsJobsService) Get(name string) *ProjectsLocationsJobsGetCall
Get: Get a Job specified by its resource name.
- name: Job name.
func (*ProjectsLocationsJobsService) GetIamPolicy ¶
func (r *ProjectsLocationsJobsService) GetIamPolicy(resource string) *ProjectsLocationsJobsGetIamPolicyCall
GetIamPolicy: Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.
- resource: REQUIRED: The resource for which the policy is being requested. See Resource names (https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.
func (*ProjectsLocationsJobsService) List ¶
func (r *ProjectsLocationsJobsService) List(parent string) *ProjectsLocationsJobsListCall
List: List all Jobs for a project within a region.
- parent: Parent path.
func (*ProjectsLocationsJobsService) SetIamPolicy ¶
func (r *ProjectsLocationsJobsService) SetIamPolicy(resource string, setiampolicyrequest *SetIamPolicyRequest) *ProjectsLocationsJobsSetIamPolicyCall
SetIamPolicy: Sets the access control policy on the specified resource. Replaces any existing policy. Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED` errors.
- resource: REQUIRED: The resource for which the policy is being specified. See Resource names (https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.
func (*ProjectsLocationsJobsService) TestIamPermissions ¶
func (r *ProjectsLocationsJobsService) TestIamPermissions(resource string, testiampermissionsrequest *TestIamPermissionsRequest) *ProjectsLocationsJobsTestIamPermissionsCall
TestIamPermissions: Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a `NOT_FOUND` error. Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may "fail open" without warning.
- resource: REQUIRED: The resource for which the policy detail is being requested. See Resource names (https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.
type ProjectsLocationsJobsSetIamPolicyCall ¶
type ProjectsLocationsJobsSetIamPolicyCall struct {
// contains filtered or unexported fields
}
func (*ProjectsLocationsJobsSetIamPolicyCall) Context ¶
func (c *ProjectsLocationsJobsSetIamPolicyCall) Context(ctx context.Context) *ProjectsLocationsJobsSetIamPolicyCall
Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.
func (*ProjectsLocationsJobsSetIamPolicyCall) Do ¶
func (c *ProjectsLocationsJobsSetIamPolicyCall) Do(opts ...googleapi.CallOption) (*Policy, error)
Do executes the "batch.projects.locations.jobs.setIamPolicy" call. Exactly one of *Policy or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *Policy.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.
func (*ProjectsLocationsJobsSetIamPolicyCall) Fields ¶
func (c *ProjectsLocationsJobsSetIamPolicyCall) Fields(s ...googleapi.Field) *ProjectsLocationsJobsSetIamPolicyCall
Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.
func (*ProjectsLocationsJobsSetIamPolicyCall) Header ¶
func (c *ProjectsLocationsJobsSetIamPolicyCall) Header() http.Header
Header returns an http.Header that can be modified by the caller to add HTTP headers to the request.
type ProjectsLocationsJobsTaskGroupsService ¶
type ProjectsLocationsJobsTaskGroupsService struct { Tasks *ProjectsLocationsJobsTaskGroupsTasksService // contains filtered or unexported fields }
func NewProjectsLocationsJobsTaskGroupsService ¶
func NewProjectsLocationsJobsTaskGroupsService(s *Service) *ProjectsLocationsJobsTaskGroupsService
type ProjectsLocationsJobsTaskGroupsTasksGetCall ¶
type ProjectsLocationsJobsTaskGroupsTasksGetCall struct {
// contains filtered or unexported fields
}
func (*ProjectsLocationsJobsTaskGroupsTasksGetCall) Context ¶
func (c *ProjectsLocationsJobsTaskGroupsTasksGetCall) Context(ctx context.Context) *ProjectsLocationsJobsTaskGroupsTasksGetCall
Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.
func (*ProjectsLocationsJobsTaskGroupsTasksGetCall) Do ¶
func (c *ProjectsLocationsJobsTaskGroupsTasksGetCall) Do(opts ...googleapi.CallOption) (*Task, error)
Do executes the "batch.projects.locations.jobs.taskGroups.tasks.get" call. Exactly one of *Task or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *Task.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.
func (*ProjectsLocationsJobsTaskGroupsTasksGetCall) Fields ¶
func (c *ProjectsLocationsJobsTaskGroupsTasksGetCall) Fields(s ...googleapi.Field) *ProjectsLocationsJobsTaskGroupsTasksGetCall
Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.
func (*ProjectsLocationsJobsTaskGroupsTasksGetCall) Header ¶
func (c *ProjectsLocationsJobsTaskGroupsTasksGetCall) Header() http.Header
Header returns an http.Header that can be modified by the caller to add HTTP headers to the request.
func (*ProjectsLocationsJobsTaskGroupsTasksGetCall) IfNoneMatch ¶
func (c *ProjectsLocationsJobsTaskGroupsTasksGetCall) IfNoneMatch(entityTag string) *ProjectsLocationsJobsTaskGroupsTasksGetCall
IfNoneMatch sets the optional parameter which makes the operation fail if the object's ETag matches the given value. This is useful for getting updates only after the object has changed since the last request. Use googleapi.IsNotModified to check whether the response error from Do is the result of In-None-Match.
type ProjectsLocationsJobsTaskGroupsTasksListCall ¶
type ProjectsLocationsJobsTaskGroupsTasksListCall struct {
// contains filtered or unexported fields
}
func (*ProjectsLocationsJobsTaskGroupsTasksListCall) Context ¶
func (c *ProjectsLocationsJobsTaskGroupsTasksListCall) Context(ctx context.Context) *ProjectsLocationsJobsTaskGroupsTasksListCall
Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.
func (*ProjectsLocationsJobsTaskGroupsTasksListCall) Do ¶
func (c *ProjectsLocationsJobsTaskGroupsTasksListCall) Do(opts ...googleapi.CallOption) (*ListTasksResponse, error)
Do executes the "batch.projects.locations.jobs.taskGroups.tasks.list" call. Exactly one of *ListTasksResponse or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *ListTasksResponse.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.
func (*ProjectsLocationsJobsTaskGroupsTasksListCall) Fields ¶
func (c *ProjectsLocationsJobsTaskGroupsTasksListCall) Fields(s ...googleapi.Field) *ProjectsLocationsJobsTaskGroupsTasksListCall
Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.
func (*ProjectsLocationsJobsTaskGroupsTasksListCall) Filter ¶
func (c *ProjectsLocationsJobsTaskGroupsTasksListCall) Filter(filter string) *ProjectsLocationsJobsTaskGroupsTasksListCall
Filter sets the optional parameter "filter": Task filter, null filter matches all Tasks. Filter string should be of the format State=TaskStatus.State e.g. State=RUNNING
func (*ProjectsLocationsJobsTaskGroupsTasksListCall) Header ¶
func (c *ProjectsLocationsJobsTaskGroupsTasksListCall) Header() http.Header
Header returns an http.Header that can be modified by the caller to add HTTP headers to the request.
func (*ProjectsLocationsJobsTaskGroupsTasksListCall) IfNoneMatch ¶
func (c *ProjectsLocationsJobsTaskGroupsTasksListCall) IfNoneMatch(entityTag string) *ProjectsLocationsJobsTaskGroupsTasksListCall
IfNoneMatch sets the optional parameter which makes the operation fail if the object's ETag matches the given value. This is useful for getting updates only after the object has changed since the last request. Use googleapi.IsNotModified to check whether the response error from Do is the result of In-None-Match.
func (*ProjectsLocationsJobsTaskGroupsTasksListCall) PageSize ¶
func (c *ProjectsLocationsJobsTaskGroupsTasksListCall) PageSize(pageSize int64) *ProjectsLocationsJobsTaskGroupsTasksListCall
PageSize sets the optional parameter "pageSize": Page size.
func (*ProjectsLocationsJobsTaskGroupsTasksListCall) PageToken ¶
func (c *ProjectsLocationsJobsTaskGroupsTasksListCall) PageToken(pageToken string) *ProjectsLocationsJobsTaskGroupsTasksListCall
PageToken sets the optional parameter "pageToken": Page token.
func (*ProjectsLocationsJobsTaskGroupsTasksListCall) Pages ¶
func (c *ProjectsLocationsJobsTaskGroupsTasksListCall) Pages(ctx context.Context, f func(*ListTasksResponse) error) error
Pages invokes f for each page of results. A non-nil error returned from f will halt the iteration. The provided context supersedes any context provided to the Context method.
type ProjectsLocationsJobsTaskGroupsTasksService ¶
type ProjectsLocationsJobsTaskGroupsTasksService struct {
// contains filtered or unexported fields
}
func NewProjectsLocationsJobsTaskGroupsTasksService ¶
func NewProjectsLocationsJobsTaskGroupsTasksService(s *Service) *ProjectsLocationsJobsTaskGroupsTasksService
func (*ProjectsLocationsJobsTaskGroupsTasksService) Get ¶
func (r *ProjectsLocationsJobsTaskGroupsTasksService) Get(name string) *ProjectsLocationsJobsTaskGroupsTasksGetCall
Get: Return a single Task.
- name: Task name.
func (*ProjectsLocationsJobsTaskGroupsTasksService) List ¶
func (r *ProjectsLocationsJobsTaskGroupsTasksService) List(parent string) *ProjectsLocationsJobsTaskGroupsTasksListCall
List: List Tasks associated with a job.
- parent: Name of a TaskGroup from which Tasks are being requested. Pattern: "projects/{project}/locations/{location}/jobs/{job}/taskGroups/{task _group}".
type ProjectsLocationsJobsTestIamPermissionsCall ¶
type ProjectsLocationsJobsTestIamPermissionsCall struct {
// contains filtered or unexported fields
}
func (*ProjectsLocationsJobsTestIamPermissionsCall) Context ¶
func (c *ProjectsLocationsJobsTestIamPermissionsCall) Context(ctx context.Context) *ProjectsLocationsJobsTestIamPermissionsCall
Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.
func (*ProjectsLocationsJobsTestIamPermissionsCall) Do ¶
func (c *ProjectsLocationsJobsTestIamPermissionsCall) Do(opts ...googleapi.CallOption) (*TestIamPermissionsResponse, error)
Do executes the "batch.projects.locations.jobs.testIamPermissions" call. Exactly one of *TestIamPermissionsResponse or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *TestIamPermissionsResponse.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.
func (*ProjectsLocationsJobsTestIamPermissionsCall) Fields ¶
func (c *ProjectsLocationsJobsTestIamPermissionsCall) Fields(s ...googleapi.Field) *ProjectsLocationsJobsTestIamPermissionsCall
Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.
func (*ProjectsLocationsJobsTestIamPermissionsCall) Header ¶
func (c *ProjectsLocationsJobsTestIamPermissionsCall) Header() http.Header
Header returns an http.Header that can be modified by the caller to add HTTP headers to the request.
type ProjectsLocationsListCall ¶
type ProjectsLocationsListCall struct {
// contains filtered or unexported fields
}
func (*ProjectsLocationsListCall) Context ¶
func (c *ProjectsLocationsListCall) Context(ctx context.Context) *ProjectsLocationsListCall
Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.
func (*ProjectsLocationsListCall) Do ¶
func (c *ProjectsLocationsListCall) Do(opts ...googleapi.CallOption) (*ListLocationsResponse, error)
Do executes the "batch.projects.locations.list" call. Exactly one of *ListLocationsResponse or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *ListLocationsResponse.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.
func (*ProjectsLocationsListCall) Fields ¶
func (c *ProjectsLocationsListCall) Fields(s ...googleapi.Field) *ProjectsLocationsListCall
Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.
func (*ProjectsLocationsListCall) Filter ¶
func (c *ProjectsLocationsListCall) Filter(filter string) *ProjectsLocationsListCall
Filter sets the optional parameter "filter": A filter to narrow down results to a preferred subset. The filtering language accepts strings like "displayName=tokyo", and is documented in more detail in AIP-160 (https://google.aip.dev/160).
func (*ProjectsLocationsListCall) Header ¶
func (c *ProjectsLocationsListCall) Header() http.Header
Header returns an http.Header that can be modified by the caller to add HTTP headers to the request.
func (*ProjectsLocationsListCall) IfNoneMatch ¶
func (c *ProjectsLocationsListCall) IfNoneMatch(entityTag string) *ProjectsLocationsListCall
IfNoneMatch sets the optional parameter which makes the operation fail if the object's ETag matches the given value. This is useful for getting updates only after the object has changed since the last request. Use googleapi.IsNotModified to check whether the response error from Do is the result of In-None-Match.
func (*ProjectsLocationsListCall) PageSize ¶
func (c *ProjectsLocationsListCall) PageSize(pageSize int64) *ProjectsLocationsListCall
PageSize sets the optional parameter "pageSize": The maximum number of results to return. If not set, the service selects a default.
func (*ProjectsLocationsListCall) PageToken ¶
func (c *ProjectsLocationsListCall) PageToken(pageToken string) *ProjectsLocationsListCall
PageToken sets the optional parameter "pageToken": A page token received from the `next_page_token` field in the response. Send that page token to receive the subsequent page.
func (*ProjectsLocationsListCall) Pages ¶
func (c *ProjectsLocationsListCall) Pages(ctx context.Context, f func(*ListLocationsResponse) error) error
Pages invokes f for each page of results. A non-nil error returned from f will halt the iteration. The provided context supersedes any context provided to the Context method.
type ProjectsLocationsOperationsCancelCall ¶
type ProjectsLocationsOperationsCancelCall struct {
// contains filtered or unexported fields
}
func (*ProjectsLocationsOperationsCancelCall) Context ¶
func (c *ProjectsLocationsOperationsCancelCall) Context(ctx context.Context) *ProjectsLocationsOperationsCancelCall
Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.
func (*ProjectsLocationsOperationsCancelCall) Do ¶
func (c *ProjectsLocationsOperationsCancelCall) Do(opts ...googleapi.CallOption) (*Empty, error)
Do executes the "batch.projects.locations.operations.cancel" call. Exactly one of *Empty or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *Empty.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.
func (*ProjectsLocationsOperationsCancelCall) Fields ¶
func (c *ProjectsLocationsOperationsCancelCall) Fields(s ...googleapi.Field) *ProjectsLocationsOperationsCancelCall
Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.
func (*ProjectsLocationsOperationsCancelCall) Header ¶
func (c *ProjectsLocationsOperationsCancelCall) Header() http.Header
Header returns an http.Header that can be modified by the caller to add HTTP headers to the request.
type ProjectsLocationsOperationsDeleteCall ¶
type ProjectsLocationsOperationsDeleteCall struct {
// contains filtered or unexported fields
}
func (*ProjectsLocationsOperationsDeleteCall) Context ¶
func (c *ProjectsLocationsOperationsDeleteCall) Context(ctx context.Context) *ProjectsLocationsOperationsDeleteCall
Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.
func (*ProjectsLocationsOperationsDeleteCall) Do ¶
func (c *ProjectsLocationsOperationsDeleteCall) Do(opts ...googleapi.CallOption) (*Empty, error)
Do executes the "batch.projects.locations.operations.delete" call. Exactly one of *Empty or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *Empty.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.
func (*ProjectsLocationsOperationsDeleteCall) Fields ¶
func (c *ProjectsLocationsOperationsDeleteCall) Fields(s ...googleapi.Field) *ProjectsLocationsOperationsDeleteCall
Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.
func (*ProjectsLocationsOperationsDeleteCall) Header ¶
func (c *ProjectsLocationsOperationsDeleteCall) Header() http.Header
Header returns an http.Header that can be modified by the caller to add HTTP headers to the request.
type ProjectsLocationsOperationsGetCall ¶
type ProjectsLocationsOperationsGetCall struct {
// contains filtered or unexported fields
}
func (*ProjectsLocationsOperationsGetCall) Context ¶
func (c *ProjectsLocationsOperationsGetCall) Context(ctx context.Context) *ProjectsLocationsOperationsGetCall
Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.
func (*ProjectsLocationsOperationsGetCall) Do ¶
func (c *ProjectsLocationsOperationsGetCall) Do(opts ...googleapi.CallOption) (*Operation, error)
Do executes the "batch.projects.locations.operations.get" call. Exactly one of *Operation or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *Operation.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.
func (*ProjectsLocationsOperationsGetCall) Fields ¶
func (c *ProjectsLocationsOperationsGetCall) Fields(s ...googleapi.Field) *ProjectsLocationsOperationsGetCall
Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.
func (*ProjectsLocationsOperationsGetCall) Header ¶
func (c *ProjectsLocationsOperationsGetCall) Header() http.Header
Header returns an http.Header that can be modified by the caller to add HTTP headers to the request.
func (*ProjectsLocationsOperationsGetCall) IfNoneMatch ¶
func (c *ProjectsLocationsOperationsGetCall) IfNoneMatch(entityTag string) *ProjectsLocationsOperationsGetCall
IfNoneMatch sets the optional parameter which makes the operation fail if the object's ETag matches the given value. This is useful for getting updates only after the object has changed since the last request. Use googleapi.IsNotModified to check whether the response error from Do is the result of In-None-Match.
type ProjectsLocationsOperationsListCall ¶
type ProjectsLocationsOperationsListCall struct {
// contains filtered or unexported fields
}
func (*ProjectsLocationsOperationsListCall) Context ¶
func (c *ProjectsLocationsOperationsListCall) Context(ctx context.Context) *ProjectsLocationsOperationsListCall
Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.
func (*ProjectsLocationsOperationsListCall) Do ¶
func (c *ProjectsLocationsOperationsListCall) Do(opts ...googleapi.CallOption) (*ListOperationsResponse, error)
Do executes the "batch.projects.locations.operations.list" call. Exactly one of *ListOperationsResponse or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *ListOperationsResponse.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.
func (*ProjectsLocationsOperationsListCall) Fields ¶
func (c *ProjectsLocationsOperationsListCall) Fields(s ...googleapi.Field) *ProjectsLocationsOperationsListCall
Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.
func (*ProjectsLocationsOperationsListCall) Filter ¶
func (c *ProjectsLocationsOperationsListCall) Filter(filter string) *ProjectsLocationsOperationsListCall
Filter sets the optional parameter "filter": The standard list filter.
func (*ProjectsLocationsOperationsListCall) Header ¶
func (c *ProjectsLocationsOperationsListCall) Header() http.Header
Header returns an http.Header that can be modified by the caller to add HTTP headers to the request.
func (*ProjectsLocationsOperationsListCall) IfNoneMatch ¶
func (c *ProjectsLocationsOperationsListCall) IfNoneMatch(entityTag string) *ProjectsLocationsOperationsListCall
IfNoneMatch sets the optional parameter which makes the operation fail if the object's ETag matches the given value. This is useful for getting updates only after the object has changed since the last request. Use googleapi.IsNotModified to check whether the response error from Do is the result of In-None-Match.
func (*ProjectsLocationsOperationsListCall) PageSize ¶
func (c *ProjectsLocationsOperationsListCall) PageSize(pageSize int64) *ProjectsLocationsOperationsListCall
PageSize sets the optional parameter "pageSize": The standard list page size.
func (*ProjectsLocationsOperationsListCall) PageToken ¶
func (c *ProjectsLocationsOperationsListCall) PageToken(pageToken string) *ProjectsLocationsOperationsListCall
PageToken sets the optional parameter "pageToken": The standard list page token.
func (*ProjectsLocationsOperationsListCall) Pages ¶
func (c *ProjectsLocationsOperationsListCall) Pages(ctx context.Context, f func(*ListOperationsResponse) error) error
Pages invokes f for each page of results. A non-nil error returned from f will halt the iteration. The provided context supersedes any context provided to the Context method.
type ProjectsLocationsOperationsService ¶
type ProjectsLocationsOperationsService struct {
// contains filtered or unexported fields
}
func NewProjectsLocationsOperationsService ¶
func NewProjectsLocationsOperationsService(s *Service) *ProjectsLocationsOperationsService
func (*ProjectsLocationsOperationsService) Cancel ¶
func (r *ProjectsLocationsOperationsService) Cancel(name string, canceloperationrequest *CancelOperationRequest) *ProjectsLocationsOperationsCancelCall
Cancel: Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of 1, corresponding to `Code.CANCELLED`.
- name: The name of the operation resource to be cancelled.
func (*ProjectsLocationsOperationsService) Delete ¶
func (r *ProjectsLocationsOperationsService) Delete(name string) *ProjectsLocationsOperationsDeleteCall
Delete: Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.
- name: The name of the operation resource to be deleted.
func (*ProjectsLocationsOperationsService) Get ¶
func (r *ProjectsLocationsOperationsService) Get(name string) *ProjectsLocationsOperationsGetCall
Get: Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.
- name: The name of the operation resource.
func (*ProjectsLocationsOperationsService) List ¶
func (r *ProjectsLocationsOperationsService) List(name string) *ProjectsLocationsOperationsListCall
List: Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. NOTE: the `name` binding allows API services to override the binding to use different resource name schemes, such as `users/*/operations`. To override the binding, API services can add a binding such as "/v1/{name=users/*}/operations" to their service configuration. For backwards compatibility, the default name includes the operations collection id, however overriding users must ensure the name binding is the parent resource, without the operations collection id.
- name: The name of the operation's parent resource.
type ProjectsLocationsService ¶
type ProjectsLocationsService struct { Jobs *ProjectsLocationsJobsService Operations *ProjectsLocationsOperationsService State *ProjectsLocationsStateService // contains filtered or unexported fields }
func NewProjectsLocationsService ¶
func NewProjectsLocationsService(s *Service) *ProjectsLocationsService
func (*ProjectsLocationsService) Get ¶
func (r *ProjectsLocationsService) Get(name string) *ProjectsLocationsGetCall
Get: Gets information about a location.
- name: Resource name for the location.
func (*ProjectsLocationsService) List ¶
func (r *ProjectsLocationsService) List(name string) *ProjectsLocationsListCall
List: Lists information about the supported locations for this service.
- name: The resource that owns the locations collection, if applicable.
type ProjectsLocationsStateReportCall ¶
type ProjectsLocationsStateReportCall struct {
// contains filtered or unexported fields
}
func (*ProjectsLocationsStateReportCall) Context ¶
func (c *ProjectsLocationsStateReportCall) Context(ctx context.Context) *ProjectsLocationsStateReportCall
Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.
func (*ProjectsLocationsStateReportCall) Do ¶
func (c *ProjectsLocationsStateReportCall) Do(opts ...googleapi.CallOption) (*ReportAgentStateResponse, error)
Do executes the "batch.projects.locations.state.report" call. Exactly one of *ReportAgentStateResponse or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *ReportAgentStateResponse.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.
func (*ProjectsLocationsStateReportCall) Fields ¶
func (c *ProjectsLocationsStateReportCall) Fields(s ...googleapi.Field) *ProjectsLocationsStateReportCall
Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.
func (*ProjectsLocationsStateReportCall) Header ¶
func (c *ProjectsLocationsStateReportCall) Header() http.Header
Header returns an http.Header that can be modified by the caller to add HTTP headers to the request.
type ProjectsLocationsStateService ¶
type ProjectsLocationsStateService struct {
// contains filtered or unexported fields
}
func NewProjectsLocationsStateService ¶
func NewProjectsLocationsStateService(s *Service) *ProjectsLocationsStateService
func (*ProjectsLocationsStateService) Report ¶
func (r *ProjectsLocationsStateService) Report(parent string, reportagentstaterequest *ReportAgentStateRequest) *ProjectsLocationsStateReportCall
Report: Report agent's state, e.g. agent status and tasks information
- parent: Format: projects/{project}/locations/{location} {project} should be a project number.
type ProjectsService ¶
type ProjectsService struct { Locations *ProjectsLocationsService // contains filtered or unexported fields }
func NewProjectsService ¶
func NewProjectsService(s *Service) *ProjectsService
type ReportAgentStateRequest ¶
type ReportAgentStateRequest struct { // AgentInfo: Agent info. AgentInfo *AgentInfo `json:"agentInfo,omitempty"` // AgentTimingInfo: Agent timing info. AgentTimingInfo *AgentTimingInfo `json:"agentTimingInfo,omitempty"` // Metadata: Agent metadata. Metadata *AgentMetadata `json:"metadata,omitempty"` // ForceSendFields is a list of field names (e.g. "AgentInfo") to // unconditionally include in API requests. By default, fields with // empty or default values are omitted from API requests. However, any // non-pointer, non-interface field appearing in ForceSendFields will be // sent to the server regardless of whether the field is empty or not. // This may be used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` // NullFields is a list of field names (e.g. "AgentInfo") to include in // API requests with the JSON null value. By default, fields with empty // values are omitted from API requests. However, any field with an // empty value appearing in NullFields will be sent to the server as // null. It is an error if a field in this list has a non-empty value. // This may be used to include null fields in Patch requests. NullFields []string `json:"-"` }
ReportAgentStateRequest: Request to report agent's state. The Request itself implies the agent is healthy.
func (*ReportAgentStateRequest) MarshalJSON ¶
func (s *ReportAgentStateRequest) MarshalJSON() ([]byte, error)
type ReportAgentStateResponse ¶
type ReportAgentStateResponse struct { // DefaultReportInterval: Default report interval override DefaultReportInterval string `json:"defaultReportInterval,omitempty"` // MinReportInterval: Minimum report interval override MinReportInterval string `json:"minReportInterval,omitempty"` // Tasks: Tasks assigned to the agent Tasks []*AgentTask `json:"tasks,omitempty"` // ServerResponse contains the HTTP response code and headers from the // server. googleapi.ServerResponse `json:"-"` // ForceSendFields is a list of field names (e.g. // "DefaultReportInterval") to unconditionally include in API requests. // By default, fields with empty or default values are omitted from API // requests. However, any non-pointer, non-interface field appearing in // ForceSendFields will be sent to the server regardless of whether the // field is empty or not. This may be used to include empty fields in // Patch requests. ForceSendFields []string `json:"-"` // NullFields is a list of field names (e.g. "DefaultReportInterval") to // include in API requests with the JSON null value. By default, fields // with empty values are omitted from API requests. However, any field // with an empty value appearing in NullFields will be sent to the // server as null. It is an error if a field in this list has a // non-empty value. This may be used to include null fields in Patch // requests. NullFields []string `json:"-"` }
ReportAgentStateResponse: Response to ReportAgentStateRequest.
func (*ReportAgentStateResponse) MarshalJSON ¶
func (s *ReportAgentStateResponse) MarshalJSON() ([]byte, error)
type Runnable ¶
type Runnable struct { // AlwaysRun: 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 `json:"alwaysRun,omitempty"` // Background: 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 `json:"background,omitempty"` // Barrier: Barrier runnable. Barrier *Barrier `json:"barrier,omitempty"` // Container: Container runnable. Container *Container `json:"container,omitempty"` // Environment: Environment variables for this Runnable (overrides // variables set for the whole Task or TaskGroup). Environment *Environment `json:"environment,omitempty"` // IgnoreExitStatus: Normally, a non-zero exit status causes the Task to // fail. This flag allows execution of other Runnables to continue // instead. IgnoreExitStatus bool `json:"ignoreExitStatus,omitempty"` // Script: Script runnable. Script *Script `json:"script,omitempty"` // Timeout: Timeout for this Runnable. Timeout string `json:"timeout,omitempty"` // ForceSendFields is a list of field names (e.g. "AlwaysRun") to // unconditionally include in API requests. By default, fields with // empty or default values are omitted from API requests. However, any // non-pointer, non-interface field appearing in ForceSendFields will be // sent to the server regardless of whether the field is empty or not. // This may be used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` // NullFields is a list of field names (e.g. "AlwaysRun") to include in // API requests with the JSON null value. By default, fields with empty // values are omitted from API requests. However, any field with an // empty value appearing in NullFields will be sent to the server as // null. It is an error if a field in this list has a non-empty value. // This may be used to include null fields in Patch requests. NullFields []string `json:"-"` }
Runnable: Runnable describes instructions for executing a specific script or container as part of a Task.
func (*Runnable) MarshalJSON ¶
type Script ¶
type Script struct { // Path: Script file path on the host VM. Path string `json:"path,omitempty"` // Text: Shell script text. Text string `json:"text,omitempty"` // ForceSendFields is a list of field names (e.g. "Path") to // unconditionally include in API requests. By default, fields with // empty or default values are omitted from API requests. However, any // non-pointer, non-interface field appearing in ForceSendFields will be // sent to the server regardless of whether the field is empty or not. // This may be used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` // NullFields is a list of field names (e.g. "Path") to include in API // requests with the JSON null value. By default, fields with empty // values are omitted from API requests. However, any field with an // empty value appearing in NullFields will be sent to the server as // null. It is an error if a field in this list has a non-empty value. // This may be used to include null fields in Patch requests. NullFields []string `json:"-"` }
Script: Script runnable.
func (*Script) MarshalJSON ¶
type Service ¶
type Service struct { BasePath string // API endpoint base URL UserAgent string // optional additional User-Agent fragment Projects *ProjectsService // contains filtered or unexported fields }
func New
deprecated
New creates a new Service. It uses the provided http.Client for requests.
Deprecated: please use NewService instead. To provide a custom HTTP client, use option.WithHTTPClient. If you are using google.golang.org/api/googleapis/transport.APIKey, use option.WithAPIKey with NewService instead.
func NewService ¶
NewService creates a new Service.
type ServiceAccount ¶
type ServiceAccount struct { // Email: 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 `json:"email,omitempty"` // ForceSendFields is a list of field names (e.g. "Email") to // unconditionally include in API requests. By default, fields with // empty or default values are omitted from API requests. However, any // non-pointer, non-interface field appearing in ForceSendFields will be // sent to the server regardless of whether the field is empty or not. // This may be used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` // NullFields is a list of field names (e.g. "Email") to include in API // requests with the JSON null value. By default, fields with empty // values are omitted from API requests. However, any field with an // empty value appearing in NullFields will be sent to the server as // null. It is an error if a field in this list has a non-empty value. // This may be used to include null fields in Patch requests. NullFields []string `json:"-"` }
ServiceAccount: Carries information about a Google Cloud service account.
func (*ServiceAccount) MarshalJSON ¶
func (s *ServiceAccount) MarshalJSON() ([]byte, error)
type SetIamPolicyRequest ¶
type SetIamPolicyRequest struct { // Policy: REQUIRED: The complete policy to be applied to the // `resource`. The size of the policy is limited to a few 10s of KB. An // empty policy is a valid policy but certain Google Cloud services // (such as Projects) might reject them. Policy *Policy `json:"policy,omitempty"` // UpdateMask: OPTIONAL: A FieldMask specifying which fields of the // policy to modify. Only the fields in the mask will be modified. If no // mask is provided, the following default mask is used: `paths: // "bindings, etag" UpdateMask string `json:"updateMask,omitempty"` // ForceSendFields is a list of field names (e.g. "Policy") to // unconditionally include in API requests. By default, fields with // empty or default values are omitted from API requests. However, any // non-pointer, non-interface field appearing in ForceSendFields will be // sent to the server regardless of whether the field is empty or not. // This may be used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` // NullFields is a list of field names (e.g. "Policy") to include in API // requests with the JSON null value. By default, fields with empty // values are omitted from API requests. However, any field with an // empty value appearing in NullFields will be sent to the server as // null. It is an error if a field in this list has a non-empty value. // This may be used to include null fields in Patch requests. NullFields []string `json:"-"` }
SetIamPolicyRequest: Request message for `SetIamPolicy` method.
func (*SetIamPolicyRequest) MarshalJSON ¶
func (s *SetIamPolicyRequest) MarshalJSON() ([]byte, error)
type Status ¶
type Status struct { // Code: The status code, which should be an enum value of // google.rpc.Code. Code int64 `json:"code,omitempty"` // Details: A list of messages that carry the error details. There is a // common set of message types for APIs to use. Details []googleapi.RawMessage `json:"details,omitempty"` // Message: A developer-facing error message, which should be in // English. Any user-facing error message should be localized and sent // in the google.rpc.Status.details field, or localized by the client. Message string `json:"message,omitempty"` // ForceSendFields is a list of field names (e.g. "Code") to // unconditionally include in API requests. By default, fields with // empty or default values are omitted from API requests. However, any // non-pointer, non-interface field appearing in ForceSendFields will be // sent to the server regardless of whether the field is empty or not. // This may be used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` // NullFields is a list of field names (e.g. "Code") to include in API // requests with the JSON null value. By default, fields with empty // values are omitted from API requests. However, any field with an // empty value appearing in NullFields will be sent to the server as // null. It is an error if a field in this list has a non-empty value. // This may be used to include null fields in Patch requests. NullFields []string `json:"-"` }
Status: The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by gRPC (https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the API Design Guide (https://cloud.google.com/apis/design/errors).
func (*Status) MarshalJSON ¶
type StatusEvent ¶
type StatusEvent struct { // Description: Description of the event. Description string `json:"description,omitempty"` // EventTime: The time this event occurred. EventTime string `json:"eventTime,omitempty"` // TaskExecution: Task Execution TaskExecution *TaskExecution `json:"taskExecution,omitempty"` // Type: Type of the event. Type string `json:"type,omitempty"` // ForceSendFields is a list of field names (e.g. "Description") to // unconditionally include in API requests. By default, fields with // empty or default values are omitted from API requests. However, any // non-pointer, non-interface field appearing in ForceSendFields will be // sent to the server regardless of whether the field is empty or not. // This may be used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` // NullFields is a list of field names (e.g. "Description") to include // in API requests with the JSON null value. By default, fields with // empty values are omitted from API requests. However, any field with // an empty value appearing in NullFields will be sent to the server as // null. It is an error if a field in this list has a non-empty value. // This may be used to include null fields in Patch requests. NullFields []string `json:"-"` }
StatusEvent: Status event
func (*StatusEvent) MarshalJSON ¶
func (s *StatusEvent) MarshalJSON() ([]byte, error)
type Task ¶
type Task struct { // Name: 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/task // s/task01". Name string `json:"name,omitempty"` // Status: Task Status. Status *TaskStatus `json:"status,omitempty"` // ServerResponse contains the HTTP response code and headers from the // server. googleapi.ServerResponse `json:"-"` // ForceSendFields is a list of field names (e.g. "Name") to // unconditionally include in API requests. By default, fields with // empty or default values are omitted from API requests. However, any // non-pointer, non-interface field appearing in ForceSendFields will be // sent to the server regardless of whether the field is empty or not. // This may be used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` // NullFields is a list of field names (e.g. "Name") to include in API // requests with the JSON null value. By default, fields with empty // values are omitted from API requests. However, any field with an // empty value appearing in NullFields will be sent to the server as // null. It is an error if a field in this list has a non-empty value. // This may be used to include null fields in Patch requests. NullFields []string `json:"-"` }
Task: A Cloud Batch task.
func (*Task) MarshalJSON ¶
type TaskExecution ¶
type TaskExecution struct { // ExitCode: 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 int64 `json:"exitCode,omitempty"` // ForceSendFields is a list of field names (e.g. "ExitCode") to // unconditionally include in API requests. By default, fields with // empty or default values are omitted from API requests. However, any // non-pointer, non-interface field appearing in ForceSendFields will be // sent to the server regardless of whether the field is empty or not. // This may be used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` // NullFields is a list of field names (e.g. "ExitCode") to include in // API requests with the JSON null value. By default, fields with empty // values are omitted from API requests. However, any field with an // empty value appearing in NullFields will be sent to the server as // null. It is an error if a field in this list has a non-empty value. // This may be used to include null fields in Patch requests. NullFields []string `json:"-"` }
TaskExecution: This Task Execution field includes detail information for task execution procedures, based on StatusEvent types.
func (*TaskExecution) MarshalJSON ¶
func (s *TaskExecution) MarshalJSON() ([]byte, error)
type TaskGroup ¶
type TaskGroup struct { // Name: 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 `json:"name,omitempty"` // Parallelism: Max number of tasks that can run in parallel. Default to // min(task_count, 1000). Parallelism int64 `json:"parallelism,omitempty,string"` // PermissiveSsh: When true, Batch will configure SSH to allow // passwordless login between VMs running the Batch tasks in the same // TaskGroup. PermissiveSsh bool `json:"permissiveSsh,omitempty"` // RequireHostsFile: 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 `json:"requireHostsFile,omitempty"` // TaskCount: Number of Tasks in the TaskGroup. default is 1 TaskCount int64 `json:"taskCount,omitempty,string"` // TaskCountPerNode: 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 `json:"taskCountPerNode,omitempty,string"` // TaskEnvironments: 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 []*Environment `json:"taskEnvironments,omitempty"` // TaskSpec: Required. Tasks in the group share the same task spec. TaskSpec *TaskSpec `json:"taskSpec,omitempty"` // ForceSendFields is a list of field names (e.g. "Name") to // unconditionally include in API requests. By default, fields with // empty or default values are omitted from API requests. However, any // non-pointer, non-interface field appearing in ForceSendFields will be // sent to the server regardless of whether the field is empty or not. // This may be used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` // NullFields is a list of field names (e.g. "Name") to include in API // requests with the JSON null value. By default, fields with empty // values are omitted from API requests. However, any field with an // empty value appearing in NullFields will be sent to the server as // null. It is an error if a field in this list has a non-empty value. // This may be used to include null fields in Patch requests. NullFields []string `json:"-"` }
TaskGroup: A TaskGroup contains one or multiple Tasks that share the same Runnable but with different runtime parameters.
func (*TaskGroup) MarshalJSON ¶
type TaskGroupStatus ¶
type TaskGroupStatus struct { // Counts: Count of task in each state in the TaskGroup. The map key is // task state name. Counts map[string]string `json:"counts,omitempty"` // Instances: Status of instances allocated for the TaskGroup. Instances []*InstanceStatus `json:"instances,omitempty"` // ForceSendFields is a list of field names (e.g. "Counts") to // unconditionally include in API requests. By default, fields with // empty or default values are omitted from API requests. However, any // non-pointer, non-interface field appearing in ForceSendFields will be // sent to the server regardless of whether the field is empty or not. // This may be used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` // NullFields is a list of field names (e.g. "Counts") to include in API // requests with the JSON null value. By default, fields with empty // values are omitted from API requests. However, any field with an // empty value appearing in NullFields will be sent to the server as // null. It is an error if a field in this list has a non-empty value. // This may be used to include null fields in Patch requests. NullFields []string `json:"-"` }
TaskGroupStatus: Aggregated task status for a TaskGroup.
func (*TaskGroupStatus) MarshalJSON ¶
func (s *TaskGroupStatus) MarshalJSON() ([]byte, error)
type TaskSpec ¶
type TaskSpec struct { // ComputeResource: ComputeResource requirements. ComputeResource *ComputeResource `json:"computeResource,omitempty"` // Environment: Environment variables to set before running the Task. Environment *Environment `json:"environment,omitempty"` // Environments: Deprecated: please use environment(non-plural) instead. Environments map[string]string `json:"environments,omitempty"` // LifecyclePolicies: 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 execute. 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 `json:"lifecyclePolicies,omitempty"` // MaxRetryCount: Maximum number of retries on failures. The default, 0, // which means never retry. The valid value range is [0, 10]. MaxRetryCount int64 `json:"maxRetryCount,omitempty"` // MaxRunDuration: Maximum duration the task should run. The task will // be killed and marked as FAILED if over this limit. MaxRunDuration string `json:"maxRunDuration,omitempty"` // Runnables: 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 `json:"runnables,omitempty"` // Volumes: Volumes to mount before running Tasks using this TaskSpec. Volumes []*Volume `json:"volumes,omitempty"` // ForceSendFields is a list of field names (e.g. "ComputeResource") to // unconditionally include in API requests. By default, fields with // empty or default values are omitted from API requests. However, any // non-pointer, non-interface field appearing in ForceSendFields will be // sent to the server regardless of whether the field is empty or not. // This may be used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` // NullFields is a list of field names (e.g. "ComputeResource") to // include in API requests with the JSON null value. By default, fields // with empty values are omitted from API requests. However, any field // with an empty value appearing in NullFields will be sent to the // server as null. It is an error if a field in this list has a // non-empty value. This may be used to include null fields in Patch // requests. NullFields []string `json:"-"` }
TaskSpec: Spec of a task
func (*TaskSpec) MarshalJSON ¶
type TaskStatus ¶
type TaskStatus struct { // State: Task state // // Possible values: // "STATE_UNSPECIFIED" - unknown state // "PENDING" - The Task is created and waiting for resources. // "ASSIGNED" - The Task is assigned to at least one VM. // "RUNNING" - The Task is running. // "FAILED" - The Task has failed. // "SUCCEEDED" - The Task has succeeded. State string `json:"state,omitempty"` // StatusEvents: Detailed info about why the state is reached. StatusEvents []*StatusEvent `json:"statusEvents,omitempty"` // ForceSendFields is a list of field names (e.g. "State") to // unconditionally include in API requests. By default, fields with // empty or default values are omitted from API requests. However, any // non-pointer, non-interface field appearing in ForceSendFields will be // sent to the server regardless of whether the field is empty or not. // This may be used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` // NullFields is a list of field names (e.g. "State") to include in API // requests with the JSON null value. By default, fields with empty // values are omitted from API requests. However, any field with an // empty value appearing in NullFields will be sent to the server as // null. It is an error if a field in this list has a non-empty value. // This may be used to include null fields in Patch requests. NullFields []string `json:"-"` }
TaskStatus: Status of a task
func (*TaskStatus) MarshalJSON ¶
func (s *TaskStatus) MarshalJSON() ([]byte, error)
type TestIamPermissionsRequest ¶
type TestIamPermissionsRequest struct { // Permissions: The set of permissions to check for the `resource`. // Permissions with wildcards (such as `*` or `storage.*`) are not // allowed. For more information see IAM Overview // (https://cloud.google.com/iam/docs/overview#permissions). Permissions []string `json:"permissions,omitempty"` // ForceSendFields is a list of field names (e.g. "Permissions") to // unconditionally include in API requests. By default, fields with // empty or default values are omitted from API requests. However, any // non-pointer, non-interface field appearing in ForceSendFields will be // sent to the server regardless of whether the field is empty or not. // This may be used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` // NullFields is a list of field names (e.g. "Permissions") to include // in API requests with the JSON null value. By default, fields with // empty values are omitted from API requests. However, any field with // an empty value appearing in NullFields will be sent to the server as // null. It is an error if a field in this list has a non-empty value. // This may be used to include null fields in Patch requests. NullFields []string `json:"-"` }
TestIamPermissionsRequest: Request message for `TestIamPermissions` method.
func (*TestIamPermissionsRequest) MarshalJSON ¶
func (s *TestIamPermissionsRequest) MarshalJSON() ([]byte, error)
type TestIamPermissionsResponse ¶
type TestIamPermissionsResponse struct { // Permissions: A subset of `TestPermissionsRequest.permissions` that // the caller is allowed. Permissions []string `json:"permissions,omitempty"` // ServerResponse contains the HTTP response code and headers from the // server. googleapi.ServerResponse `json:"-"` // ForceSendFields is a list of field names (e.g. "Permissions") to // unconditionally include in API requests. By default, fields with // empty or default values are omitted from API requests. However, any // non-pointer, non-interface field appearing in ForceSendFields will be // sent to the server regardless of whether the field is empty or not. // This may be used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` // NullFields is a list of field names (e.g. "Permissions") to include // in API requests with the JSON null value. By default, fields with // empty values are omitted from API requests. However, any field with // an empty value appearing in NullFields will be sent to the server as // null. It is an error if a field in this list has a non-empty value. // This may be used to include null fields in Patch requests. NullFields []string `json:"-"` }
TestIamPermissionsResponse: Response message for `TestIamPermissions` method.
func (*TestIamPermissionsResponse) MarshalJSON ¶
func (s *TestIamPermissionsResponse) MarshalJSON() ([]byte, error)
type Volume ¶
type Volume struct { // DeviceName: 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 `json:"deviceName,omitempty"` // Gcs: A Google Cloud Storage (GCS) volume. Gcs *GCS `json:"gcs,omitempty"` // MountOptions: 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 `json:"mountOptions,omitempty"` // MountPath: The mount path for the volume, e.g. /mnt/disks/share. MountPath string `json:"mountPath,omitempty"` // Nfs: A Network File System (NFS) volume. For example, a Filestore // file share. Nfs *NFS `json:"nfs,omitempty"` // ForceSendFields is a list of field names (e.g. "DeviceName") to // unconditionally include in API requests. By default, fields with // empty or default values are omitted from API requests. However, any // non-pointer, non-interface field appearing in ForceSendFields will be // sent to the server regardless of whether the field is empty or not. // This may be used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` // NullFields is a list of field names (e.g. "DeviceName") to include in // API requests with the JSON null value. By default, fields with empty // values are omitted from API requests. However, any field with an // empty value appearing in NullFields will be sent to the server as // null. It is an error if a field in this list has a non-empty value. // This may be used to include null fields in Patch requests. NullFields []string `json:"-"` }
Volume: Volume describes a volume and parameters for it to be mounted to a VM.