alpha

package
v1.84.0 Latest Latest
Warning

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

 Go to latest Published: Feb 12, 2026 License: Apache-2.0 Imports: 11 Imported by: 0

Documentation

Overview

Copyright 2026 Google LLC. All Rights Reserved.

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at 

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License. Package alpha defines operations in the declarative SDK.

Copyright 2026 Google LLC. All Rights Reserved.

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at 

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

Copyright 2026 Google LLC. All Rights Reserved.

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at 

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

Copyright 2026 Google LLC. All Rights Reserved.

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at 

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

Copyright 2026 Google LLC. All Rights Reserved.

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at 

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

Index

Constants

View Source 
const JobMaxPage = -1

Variables

View Source 
var YAML_job []byte

Functions

func DCLJobSchema added in v1.10.3 

func DCLJobSchema() *dcl.Schema

Types

type Client 

type Client struct {
	Config *dcl.Config
}

The Client is the base struct of all operations. This will receive the Get, Delete, List, and Apply operations on all resources.

func NewClient 

func NewClient(c *dcl.Config) *Client

NewClient creates a client that retries all operations a few times each.

func (*Client) ApplyJob 

func (c *Client) ApplyJob(ctx context.Context, rawDesired *Job, opts ...dcl.ApplyOption) (*Job, error)

func (*Client) DeleteAllJob 

func (c *Client) DeleteAllJob(ctx context.Context, project, location string, filter func(*Job) bool) error

DeleteAllJob deletes all resources that the filter functions returns true on.

func (*Client) DeleteJob 

func (c *Client) DeleteJob(ctx context.Context, r *Job) error

func (*Client) GetJob 

func (c *Client) GetJob(ctx context.Context, r *Job) (*Job, error)

func (*Client) ListJob 

func (c *Client) ListJob(ctx context.Context, project, location string) (*JobList, error)

func (*Client) ListJobWithMaxResults 

func (c *Client) ListJobWithMaxResults(ctx context.Context, project, location string, pageSize int32) (*JobList, error)

type Job 

type Job struct {
	Name                *string                 `json:"name"`
	Description         *string                 `json:"description"`
	PubsubTarget        *JobPubsubTarget        `json:"pubsubTarget"`
	AppEngineHttpTarget *JobAppEngineHttpTarget `json:"appEngineHttpTarget"`
	HttpTarget          *JobHttpTarget          `json:"httpTarget"`
	Schedule            *string                 `json:"schedule"`
	TimeZone            *string                 `json:"timeZone"`
	UserUpdateTime      *string                 `json:"userUpdateTime"`
	State               *JobStateEnum           `json:"state"`
	Status              *JobStatus              `json:"status"`
	ScheduleTime        *string                 `json:"scheduleTime"`
	LastAttemptTime     *string                 `json:"lastAttemptTime"`
	RetryConfig         *JobRetryConfig         `json:"retryConfig"`
	AttemptDeadline     *string                 `json:"attemptDeadline"`
	Project             *string                 `json:"project"`
	Location            *string                 `json:"location"`
}

func (*Job) Describe 

func (r *Job) Describe() dcl.ServiceTypeVersion

Describe returns a simple description of this resource to ensure that automated tools can identify it.

func (*Job) ID 

func (r *Job) ID() (string, error)

func (*Job) String 

func (r *Job) String() string

type JobAppEngineHttpTarget 

type JobAppEngineHttpTarget struct {
	HttpMethod       *JobAppEngineHttpTargetHttpMethodEnum   `json:"httpMethod"`
	AppEngineRouting *JobAppEngineHttpTargetAppEngineRouting `json:"appEngineRouting"`
	RelativeUri      *string                                 `json:"relativeUri"`
	Headers          map[string]string                       `json:"headers"`
	Body             *string                                 `json:"body"`
	// contains filtered or unexported fields
}
var EmptyJobAppEngineHttpTarget *JobAppEngineHttpTarget = &JobAppEngineHttpTarget{empty: true}

This object is used to assert a desired state where this JobAppEngineHttpTarget is empty. Go lacks global const objects, but this object should be treated as one. Modifying this object will have undesirable results.

func (*JobAppEngineHttpTarget) Empty 

func (r *JobAppEngineHttpTarget) Empty() bool

func (*JobAppEngineHttpTarget) HashCode 

func (r *JobAppEngineHttpTarget) HashCode() string

func (*JobAppEngineHttpTarget) String 

func (r *JobAppEngineHttpTarget) String() string

func (*JobAppEngineHttpTarget) UnmarshalJSON 

func (r *JobAppEngineHttpTarget) UnmarshalJSON(data []byte) error

type JobAppEngineHttpTargetAppEngineRouting 

type JobAppEngineHttpTargetAppEngineRouting struct {
	Service  *string `json:"service"`
	Version  *string `json:"version"`
	Instance *string `json:"instance"`
	Host     *string `json:"host"`
	// contains filtered or unexported fields
}
var EmptyJobAppEngineHttpTargetAppEngineRouting *JobAppEngineHttpTargetAppEngineRouting = &JobAppEngineHttpTargetAppEngineRouting{empty: true}

This object is used to assert a desired state where this JobAppEngineHttpTargetAppEngineRouting is empty. Go lacks global const objects, but this object should be treated as one. Modifying this object will have undesirable results.

func (*JobAppEngineHttpTargetAppEngineRouting) Empty 

func (r *JobAppEngineHttpTargetAppEngineRouting) Empty() bool

func (*JobAppEngineHttpTargetAppEngineRouting) HashCode 

func (r *JobAppEngineHttpTargetAppEngineRouting) HashCode() string

func (*JobAppEngineHttpTargetAppEngineRouting) String 

func (r *JobAppEngineHttpTargetAppEngineRouting) String() string

func (*JobAppEngineHttpTargetAppEngineRouting) UnmarshalJSON 

func (r *JobAppEngineHttpTargetAppEngineRouting) UnmarshalJSON(data []byte) error

type JobAppEngineHttpTargetHttpMethodEnum 

type JobAppEngineHttpTargetHttpMethodEnum string

The enum JobAppEngineHttpTargetHttpMethodEnum.

func JobAppEngineHttpTargetHttpMethodEnumRef 

func JobAppEngineHttpTargetHttpMethodEnumRef(s string) *JobAppEngineHttpTargetHttpMethodEnum

JobAppEngineHttpTargetHttpMethodEnumRef returns a *JobAppEngineHttpTargetHttpMethodEnum with the value of string s If the empty string is provided, nil is returned.

func (JobAppEngineHttpTargetHttpMethodEnum) Validate 

func (v JobAppEngineHttpTargetHttpMethodEnum) Validate() error

type JobHttpTarget 

type JobHttpTarget struct {
	Uri        *string                      `json:"uri"`
	HttpMethod *JobHttpTargetHttpMethodEnum `json:"httpMethod"`
	Headers    map[string]string            `json:"headers"`
	Body       *string                      `json:"body"`
	OAuthToken *JobHttpTargetOAuthToken     `json:"oauthToken"`
	OidcToken  *JobHttpTargetOidcToken      `json:"oidcToken"`
	// contains filtered or unexported fields
}
var EmptyJobHttpTarget *JobHttpTarget = &JobHttpTarget{empty: true}

This object is used to assert a desired state where this JobHttpTarget is empty. Go lacks global const objects, but this object should be treated as one. Modifying this object will have undesirable results.

func (*JobHttpTarget) Empty 

func (r *JobHttpTarget) Empty() bool

func (*JobHttpTarget) HashCode 

func (r *JobHttpTarget) HashCode() string

func (*JobHttpTarget) String 

func (r *JobHttpTarget) String() string

func (*JobHttpTarget) UnmarshalJSON 

func (r *JobHttpTarget) UnmarshalJSON(data []byte) error

type JobHttpTargetHttpMethodEnum 

type JobHttpTargetHttpMethodEnum string

The enum JobHttpTargetHttpMethodEnum.

func JobHttpTargetHttpMethodEnumRef 

func JobHttpTargetHttpMethodEnumRef(s string) *JobHttpTargetHttpMethodEnum

JobHttpTargetHttpMethodEnumRef returns a *JobHttpTargetHttpMethodEnum with the value of string s If the empty string is provided, nil is returned.

func (JobHttpTargetHttpMethodEnum) Validate 

func (v JobHttpTargetHttpMethodEnum) Validate() error

type JobHttpTargetOAuthToken 

type JobHttpTargetOAuthToken struct {
	ServiceAccountEmail *string `json:"serviceAccountEmail"`
	Scope               *string `json:"scope"`
	// contains filtered or unexported fields
}
var EmptyJobHttpTargetOAuthToken *JobHttpTargetOAuthToken = &JobHttpTargetOAuthToken{empty: true}

This object is used to assert a desired state where this JobHttpTargetOAuthToken is empty. Go lacks global const objects, but this object should be treated as one. Modifying this object will have undesirable results.

func (*JobHttpTargetOAuthToken) Empty 

func (r *JobHttpTargetOAuthToken) Empty() bool

func (*JobHttpTargetOAuthToken) HashCode 

func (r *JobHttpTargetOAuthToken) HashCode() string

func (*JobHttpTargetOAuthToken) String 

func (r *JobHttpTargetOAuthToken) String() string

func (*JobHttpTargetOAuthToken) UnmarshalJSON 

func (r *JobHttpTargetOAuthToken) UnmarshalJSON(data []byte) error

type JobHttpTargetOidcToken 

type JobHttpTargetOidcToken struct {
	ServiceAccountEmail *string `json:"serviceAccountEmail"`
	Audience            *string `json:"audience"`
	// contains filtered or unexported fields
}
var EmptyJobHttpTargetOidcToken *JobHttpTargetOidcToken = &JobHttpTargetOidcToken{empty: true}

This object is used to assert a desired state where this JobHttpTargetOidcToken is empty. Go lacks global const objects, but this object should be treated as one. Modifying this object will have undesirable results.

func (*JobHttpTargetOidcToken) Empty 

func (r *JobHttpTargetOidcToken) Empty() bool

func (*JobHttpTargetOidcToken) HashCode 

func (r *JobHttpTargetOidcToken) HashCode() string

func (*JobHttpTargetOidcToken) String 

func (r *JobHttpTargetOidcToken) String() string

func (*JobHttpTargetOidcToken) UnmarshalJSON 

func (r *JobHttpTargetOidcToken) UnmarshalJSON(data []byte) error

type JobList 

type JobList struct {
	Items []*Job
	// contains filtered or unexported fields
}

func (*JobList) HasNext 

func (l *JobList) HasNext() bool

func (*JobList) Next 

func (l *JobList) Next(ctx context.Context, c *Client) error

type JobPubsubTarget 

type JobPubsubTarget struct {
	TopicName  *string           `json:"topicName"`
	Data       *string           `json:"data"`
	Attributes map[string]string `json:"attributes"`
	// contains filtered or unexported fields
}
var EmptyJobPubsubTarget *JobPubsubTarget = &JobPubsubTarget{empty: true}

This object is used to assert a desired state where this JobPubsubTarget is empty. Go lacks global const objects, but this object should be treated as one. Modifying this object will have undesirable results.

func (*JobPubsubTarget) Empty 

func (r *JobPubsubTarget) Empty() bool

func (*JobPubsubTarget) HashCode 

func (r *JobPubsubTarget) HashCode() string

func (*JobPubsubTarget) String 

func (r *JobPubsubTarget) String() string

func (*JobPubsubTarget) UnmarshalJSON 

func (r *JobPubsubTarget) UnmarshalJSON(data []byte) error

type JobRetryConfig 

type JobRetryConfig struct {
	RetryCount         *int64  `json:"retryCount"`
	MaxRetryDuration   *string `json:"maxRetryDuration"`
	MinBackoffDuration *string `json:"minBackoffDuration"`
	MaxBackoffDuration *string `json:"maxBackoffDuration"`
	MaxDoublings       *int64  `json:"maxDoublings"`
	// contains filtered or unexported fields
}
var EmptyJobRetryConfig *JobRetryConfig = &JobRetryConfig{empty: true}

This object is used to assert a desired state where this JobRetryConfig is empty. Go lacks global const objects, but this object should be treated as one. Modifying this object will have undesirable results.

func (*JobRetryConfig) Empty 

func (r *JobRetryConfig) Empty() bool

func (*JobRetryConfig) HashCode 

func (r *JobRetryConfig) HashCode() string

func (*JobRetryConfig) String 

func (r *JobRetryConfig) String() string

func (*JobRetryConfig) UnmarshalJSON 

func (r *JobRetryConfig) UnmarshalJSON(data []byte) error

type JobStateEnum 

type JobStateEnum string

The enum JobStateEnum.

func JobStateEnumRef 

func JobStateEnumRef(s string) *JobStateEnum

JobStateEnumRef returns a *JobStateEnum with the value of string s If the empty string is provided, nil is returned.

func (JobStateEnum) Validate 

func (v JobStateEnum) Validate() error

type JobStatus 

type JobStatus struct {
	Code    *int64             `json:"code"`
	Message *string            `json:"message"`
	Details []JobStatusDetails `json:"details"`
	// contains filtered or unexported fields
}
var EmptyJobStatus *JobStatus = &JobStatus{empty: true}

This object is used to assert a desired state where this JobStatus is empty. Go lacks global const objects, but this object should be treated as one. Modifying this object will have undesirable results.

func (*JobStatus) Empty 

func (r *JobStatus) Empty() bool

func (*JobStatus) HashCode 

func (r *JobStatus) HashCode() string

func (*JobStatus) String 

func (r *JobStatus) String() string

func (*JobStatus) UnmarshalJSON 

func (r *JobStatus) UnmarshalJSON(data []byte) error

type JobStatusDetails 

type JobStatusDetails struct {
	TypeUrl *string `json:"typeUrl"`
	Value   *string `json:"value"`
	// contains filtered or unexported fields
}
var EmptyJobStatusDetails *JobStatusDetails = &JobStatusDetails{empty: true}

This object is used to assert a desired state where this JobStatusDetails is empty. Go lacks global const objects, but this object should be treated as one. Modifying this object will have undesirable results.

func (*JobStatusDetails) Empty 

func (r *JobStatusDetails) Empty() bool

func (*JobStatusDetails) HashCode 

func (r *JobStatusDetails) HashCode() string

func (*JobStatusDetails) String 

func (r *JobStatusDetails) String() string

func (*JobStatusDetails) UnmarshalJSON 

func (r *JobStatusDetails) UnmarshalJSON(data []byte) error

Source Files

View all Source files

Jump to

Keyboard shortcuts

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