Show / Hide Table of Contents

Namespace Google.Apis.CloudBuild.v2.Data

Classes

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.

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.

BatchCreateRepositoriesRequest

Message for creating repositoritories in batch.

BatchCreateRepositoriesResponse

Message for response of creating repositories in batch.

Binding

Associates members, or principals, with a role.

BitbucketCloudConfig

Configuration for connections to Bitbucket Cloud.

BitbucketDataCenterConfig

Configuration for connections to Bitbucket Data Center.

CancelOperationRequest

The request message for Operations.CancelOperation.

Capabilities

Capabilities adds and removes POSIX capabilities from running containers.

ChildStatusReference

ChildStatusReference is used to point to the statuses of individual TaskRuns and Runs within this PipelineRun.

Connection

A connection to a SCM like GitHub, GitHub Enterprise, Bitbucket Data Center, Bitbucket Cloud or GitLab.

CreateRepositoryRequest

Message for creating a Repository.

EmbeddedTask

EmbeddedTask defines a Task that is embedded in a Pipeline.

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); }

EmptyDirVolumeSource

Represents an empty Volume source.

EnvVar

Environment variable.

ExecAction

ExecAction describes a "run in container" action.

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.

FetchGitRefsResponse

Response for fetching git refs

FetchLinkableRepositoriesResponse

Response message for FetchLinkableRepositories.

FetchReadTokenRequest

Message for fetching SCM read token.

FetchReadTokenResponse

Message for responding to get read token.

FetchReadWriteTokenRequest

Message for fetching SCM read/write token.

FetchReadWriteTokenResponse

Message for responding to get read/write token.

GitHubConfig

Configuration for connections to github.com.

GoogleDevtoolsCloudbuildV2Condition

Conditions defines a readiness condition for a Knative resource.

GoogleDevtoolsCloudbuildV2GitHubEnterpriseConfig

Configuration for connections to an instance of GitHub Enterprise.

GoogleDevtoolsCloudbuildV2GitLabConfig

Configuration for connections to gitlab.com or an instance of GitLab Enterprise.

GoogleDevtoolsCloudbuildV2OperationMetadata

Represents the metadata of the long-running operation.

GoogleDevtoolsCloudbuildV2ServiceDirectoryConfig

ServiceDirectoryConfig represents Service Directory configuration for a connection.

HttpBody

Message that represents an arbitrary HTTP body. It should only be used for payload formats that can't be represented as JSON, such as raw binary or an HTML page. This message can be used both in streaming and non-streaming API methods in the request as well as the response. It can be used as a top-level request field, which is convenient if one wants to extract parameters from either the URL or HTTP template into the request fields and also want access to the raw HTTP body. Example: message GetResourceRequest { // A unique request id. string request_id = 1; // The raw HTTP body is bound to this field. google.api.HttpBody http_body = 2; } service ResourceService { rpc GetResource(GetResourceRequest) returns (google.api.HttpBody); rpc UpdateResource(google.api.HttpBody) returns (google.protobuf.Empty); } Example with streaming methods: service CaldavService { rpc GetCalendar(stream google.api.HttpBody) returns (stream google.api.HttpBody); rpc UpdateCalendar(stream google.api.HttpBody) returns (stream google.api.HttpBody); } Use of this type only changes how the request and response bodies are handled, all other features will continue to work unchanged.

InstallationState

Describes stage and necessary actions to be taken by the user to complete the installation. Used for GitHub and GitHub Enterprise based connections.

ListConnectionsResponse

Message for response to listing Connections.

ListLocationsResponse

The response message for Locations.ListLocations.

ListRepositoriesResponse

Message for response to listing Repositories.

Location

A resource that represents a Google Cloud location.

OAuthCredential

Represents an OAuth token of the account that authorized the Connection, and associated metadata.

Operation

This resource represents a long-running operation that is the result of a network API call.

OperationMetadata

Represents the metadata of the long-running operation.

Param

Param defined with name and value. PipelineRef can be used to refer to a specific instance of a Pipeline.

ParamSpec

ParamSpec defines parameters needed beyond typed inputs (such as resources). Parameter values are provided by users as inputs on a TaskRun or PipelineRun.

ParamValue

Parameter value.

PipelineRef

PipelineRef can be used to refer to a specific instance of a Pipeline.

PipelineResult

A value produced by a Pipeline.

PipelineRun

Message describing PipelineRun object

PipelineRunResult

PipelineRunResult used to describe the results of a pipeline

PipelineSpec

PipelineSpec defines the desired state of Pipeline.

PipelineTask

PipelineTask defines a task in a Pipeline.

PipelineWorkspaceDeclaration

Workspaces declares a set of named workspaces that are expected to be provided by a PipelineRun.

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

Probe

Probe describes a health check to be performed against a container to determine whether it is alive or ready to receive traffic.

PropertySpec

PropertySpec holds information about a property in an object.

Provenance

Provenance configuration.

Repository

A repository associated to a parent connection.

ResultValue

ResultValue holds different types of data for a single result.

RunWorkflowCustomOperationMetadata

Represents the custom metadata of the RunWorkflow long-running operation.

SecretVolumeSource

Secret Volume Source.

Security

Security configuration.

SecurityContext

Security options the container should be run with.

SetIamPolicyRequest

Request message for SetIamPolicy method.

Sidecar

Sidecars run alongside the Task's step containers.

SkippedTask

SkippedTask is used to describe the Tasks that were skipped due to their When Expressions evaluating to False.

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

Step

Step embeds the Container type, which allows it to include fields not provided by Container.

StepRef

A reference to a remote Step, i.e. a StepAction.

StepTemplate

StepTemplate can be used as the basis for all step containers within the Task, so that the steps inherit settings on the base container.

TaskRef

TaskRef can be used to refer to a specific instance of a task. PipelineRef can be used to refer to a specific instance of a Pipeline.

TaskResult

TaskResult is used to describe the results of a task.

TaskSpec

TaskSpec contains the Spec to instantiate a TaskRun.

TestIamPermissionsRequest

Request message for TestIamPermissions method.

TestIamPermissionsResponse

Response message for TestIamPermissions method.

TimeoutFields

TimeoutFields allows granular specification of pipeline, task, and finally timeouts

UserCredential

Represents a personal access token that authorized the Connection, and associated metadata.

VolumeMount

Pod volumes to mount into the container's filesystem.

VolumeSource

Volumes available to mount.

WhenExpression

Conditions that need to be true for the task to run.

Worker

Configuration for the worker.

WorkspaceBinding

WorkspaceBinding maps a workspace to a Volume. PipelineRef can be used to refer to a specific instance of a Pipeline.

WorkspaceDeclaration

WorkspaceDeclaration is a declaration of a volume that a Task requires.

WorkspacePipelineTaskBinding

WorkspacePipelineTaskBinding maps workspaces from the PipelineSpec to the workspaces declared in the Task.

In this article
Back to top Generated by DocFX