docs: update docs (#916)
* fix: re-run script
* test: fix noxfile
diff --git a/docs/dyn/cloudbuild_v1.projects.builds.html b/docs/dyn/cloudbuild_v1.projects.builds.html
index 48eefbe..a52a756 100644
--- a/docs/dyn/cloudbuild_v1.projects.builds.html
+++ b/docs/dyn/cloudbuild_v1.projects.builds.html
@@ -131,6 +131,85 @@
# - $REVISION_ID or $COMMIT_SHA: the commit SHA specified by RepoSource or
# resolved from the specified branch or tag.
# - $SHORT_SHA: first 7 characters of $REVISION_ID or $COMMIT_SHA.
+ "startTime": "A String", # Output only. Time at which execution of the build was started.
+ "substitutions": { # Substitutions data for `Build` resource.
+ "a_key": "A String",
+ },
+ "timing": { # Output only. Stores timing information for phases of the build. Valid keys
+ # are:
+ #
+ # * BUILD: time to execute all build steps
+ # * PUSH: time to push all specified images.
+ # * FETCHSOURCE: time to fetch source.
+ #
+ # If the build does not specify source or images,
+ # these keys will not be included.
+ "a_key": { # Start and end times for a build execution phase.
+ "endTime": "A String", # End of time span.
+ "startTime": "A String", # Start of time span.
+ },
+ },
+ "createTime": "A String", # Output only. Time at which the request to create the build was received.
+ "sourceProvenance": { # Provenance of the source. Ways to find the original source, or verify that # Output only. A permanent fixed identifier for source.
+ # some source was used for this build.
+ "fileHashes": { # Output only. Hash(es) of the build source, which can be used to verify that
+ # the original source integrity was maintained in the build. Note that
+ # `FileHashes` will only be populated if `BuildOptions` has requested a
+ # `SourceProvenanceHash`.
+ #
+ # The keys to this map are file paths used as build source and the values
+ # contain the hash values for those files.
+ #
+ # If the build source came in a single package such as a gzipped tarfile
+ # (`.tar.gz`), the `FileHash` will be for the single path to that file.
+ "a_key": { # Container message for hashes of byte content of files, used in
+ # SourceProvenance messages to verify integrity of source input to the build.
+ "fileHash": [ # Collection of file hashes.
+ { # Container message for hash values.
+ "type": "A String", # The type of hash that was performed.
+ "value": "A String", # The hash value.
+ },
+ ],
+ },
+ },
+ "resolvedRepoSource": { # Location of the source in a Google Cloud Source Repository. # A copy of the build's `source.repo_source`, if exists, with any
+ # revisions resolved.
+ "branchName": "A String", # Regex matching branches to build.
+ #
+ # The syntax of the regular expressions accepted is the syntax accepted by
+ # RE2 and described at https://github.com/google/re2/wiki/Syntax
+ "dir": "A String", # Directory, relative to the source root, in which to run the build.
+ #
+ # This must be a relative path. If a step's `dir` is specified and is an
+ # absolute path, this value is ignored for that step's execution.
+ "tagName": "A String", # Regex matching tags to build.
+ #
+ # The syntax of the regular expressions accepted is the syntax accepted by
+ # RE2 and described at https://github.com/google/re2/wiki/Syntax
+ "projectId": "A String", # ID of the project that owns the Cloud Source Repository. If omitted, the
+ # project ID requesting the build is assumed.
+ "repoName": "A String", # Required. Name of the Cloud Source Repository.
+ "commitSha": "A String", # Explicit commit SHA to build.
+ "substitutions": { # Substitutions to use in a triggered build.
+ # Should only be used with RunBuildTrigger
+ "a_key": "A String",
+ },
+ "invertRegex": True or False, # Only trigger a build if the revision regex does NOT match the revision
+ # regex.
+ },
+ "resolvedStorageSource": { # Location of the source in an archive file in Google Cloud Storage. # A copy of the build's `source.storage_source`, if exists, with any
+ # generations resolved.
+ "object": "A String", # Google Cloud Storage object containing the source.
+ #
+ # This object must be a gzipped archive file (`.tar.gz`) containing source to
+ # build.
+ "generation": "A String", # Google Cloud Storage generation for the object. If the generation is
+ # omitted, the latest generation will be used.
+ "bucket": "A String", # Google Cloud Storage bucket containing the source (see
+ # [Bucket Name
+ # Requirements](https://cloud.google.com/storage/docs/bucket-naming#requirements)).
+ },
+ },
"images": [ # A list of images to be pushed upon the successful completion of all build
# steps.
#
@@ -155,34 +234,16 @@
# The difference between finish_time and start_time is the duration of the
# build's execution.
"source": { # Location of the source in a supported storage service. # The location of the source files to build.
- "storageSource": { # Location of the source in an archive file in Google Cloud Storage. # If provided, get the source from this location in Google Cloud Storage.
- "generation": "A String", # Google Cloud Storage generation for the object. If the generation is
- # omitted, the latest generation will be used.
- "bucket": "A String", # Google Cloud Storage bucket containing the source (see
- # [Bucket Name
- # Requirements](https://cloud.google.com/storage/docs/bucket-naming#requirements)).
- "object": "A String", # Google Cloud Storage object containing the source.
- #
- # This object must be a gzipped archive file (`.tar.gz`) containing source to
- # build.
- },
"repoSource": { # Location of the source in a Google Cloud Source Repository. # If provided, get the source from this location in a Cloud Source
# Repository.
- "commitSha": "A String", # Explicit commit SHA to build.
- "substitutions": { # Substitutions to use in a triggered build.
- # Should only be used with RunBuildTrigger
- "a_key": "A String",
- },
- "invertRegex": True or False, # Only trigger a build if the revision regex does NOT match the revision
- # regex.
- "dir": "A String", # Directory, relative to the source root, in which to run the build.
- #
- # This must be a relative path. If a step's `dir` is specified and is an
- # absolute path, this value is ignored for that step's execution.
"branchName": "A String", # Regex matching branches to build.
#
# The syntax of the regular expressions accepted is the syntax accepted by
# RE2 and described at https://github.com/google/re2/wiki/Syntax
+ "dir": "A String", # Directory, relative to the source root, in which to run the build.
+ #
+ # This must be a relative path. If a step's `dir` is specified and is an
+ # absolute path, this value is ignored for that step's execution.
"tagName": "A String", # Regex matching tags to build.
#
# The syntax of the regular expressions accepted is the syntax accepted by
@@ -190,13 +251,29 @@
"projectId": "A String", # ID of the project that owns the Cloud Source Repository. If omitted, the
# project ID requesting the build is assumed.
"repoName": "A String", # Required. Name of the Cloud Source Repository.
+ "commitSha": "A String", # Explicit commit SHA to build.
+ "substitutions": { # Substitutions to use in a triggered build.
+ # Should only be used with RunBuildTrigger
+ "a_key": "A String",
+ },
+ "invertRegex": True or False, # Only trigger a build if the revision regex does NOT match the revision
+ # regex.
+ },
+ "storageSource": { # Location of the source in an archive file in Google Cloud Storage. # If provided, get the source from this location in Google Cloud Storage.
+ "object": "A String", # Google Cloud Storage object containing the source.
+ #
+ # This object must be a gzipped archive file (`.tar.gz`) containing source to
+ # build.
+ "generation": "A String", # Google Cloud Storage generation for the object. If the generation is
+ # omitted, the latest generation will be used.
+ "bucket": "A String", # Google Cloud Storage bucket containing the source (see
+ # [Bucket Name
+ # Requirements](https://cloud.google.com/storage/docs/bucket-naming#requirements)).
},
},
"options": { # Optional arguments to enable specific features of builds. # Special options for this build.
- "workerPool": "A String", # Option to specify a `WorkerPool` for the build.
- # Format: projects/{project}/workerPools/{workerPool}
- #
- # This field is experimental.
+ "logStreamingOption": "A String", # Option to define build log streaming behavior to Google Cloud
+ # Storage.
"env": [ # A list of global environment variable definitions that will exist for all
# build steps in this build. If a variable is defined in both globally and in
# a build step, the variable will use the build step value.
@@ -205,11 +282,15 @@
# being given the value "VALUE".
"A String",
],
+ "workerPool": "A String", # Option to specify a `WorkerPool` for the build.
+ # Format: projects/{project}/workerPools/{workerPool}
+ #
+ # This field is experimental.
"logging": "A String", # Option to specify the logging mode, which determines where the logs are
# stored.
- "requestedVerifyOption": "A String", # Requested verifiability options.
"substitutionOption": "A String", # Option to specify behavior when there is an error in the substitution
# checks.
+ "requestedVerifyOption": "A String", # Requested verifiability options.
"diskSizeGb": "A String", # Requested disk size for the VM that runs the build. Note that this is *NOT*
# "disk free"; some of the space will be used by the operating system and
# build utilities. Also note that this is the minimum disk size that will be
@@ -225,6 +306,7 @@
# in this build.
"A String",
],
+ "machineType": "A String", # Compute Engine machine type on which to run the build.
"volumes": [ # Global list of volumes to mount for ALL build steps
#
# Each volume is created as an empty volume prior to starting the build
@@ -246,14 +328,13 @@
# Docker volumes. Each named volume must be used by at least two build steps.
},
],
- "machineType": "A String", # Compute Engine machine type on which to run the build.
- "logStreamingOption": "A String", # Option to define build log streaming behavior to Google Cloud
- # Storage.
},
"timeout": "A String", # Amount of time that this build should be allowed to run, to second
# granularity. If this amount of time elapses, work on the build will cease
# and the build status will be `TIMEOUT`.
#
+ # `timeout` starts ticking from `startTime`.
+ #
# Default time is ten minutes.
"status": "A String", # Output only. Status of the build.
"statusDetail": "A String", # Output only. Customer-readable message about the current status.
@@ -276,15 +357,15 @@
"endTime": "A String", # End of time span.
"startTime": "A String", # Start of time span.
},
- "paths": [ # Path globs used to match files in the build's workspace.
- "A String",
- ],
"location": "A String", # Cloud Storage bucket and optional object path, in the form
# "gs://bucket/path/to/somewhere/". (see [Bucket Name
# Requirements](https://cloud.google.com/storage/docs/bucket-naming#requirements)).
#
# Files in the workspace matching any path pattern will be uploaded to
# Cloud Storage with this location as a prefix.
+ "paths": [ # Path globs used to match files in the build's workspace.
+ "A String",
+ ],
},
"images": [ # A list of images to be pushed upon the successful completion of all build
# steps.
@@ -301,6 +382,7 @@
"secrets": [ # Secrets to decrypt using Cloud Key Management Service.
{ # Pairs a set of secret environment variables containing encrypted
# values with the Cloud KMS key to use to decrypt the value.
+ "kmsKeyName": "A String", # Cloud KMS key name to use to decrypt these envs.
"secretEnv": { # Map of environment variable name to its encrypted value.
#
# Secret environment variables must be unique across all of a build's
@@ -309,10 +391,11 @@
# build's secrets.
"a_key": "A String",
},
- "kmsKeyName": "A String", # Cloud KMS key name to use to decrypt these envs.
},
],
"results": { # Artifacts created by the build pipeline. # Output only. Results of the build.
+ "numArtifacts": "A String", # Number of artifacts uploaded. Only populated when artifacts are uploaded.
+ "artifactManifest": "A String", # Path to the artifact manifest. Only populated when artifacts are uploaded.
"buildStepImages": [ # List of build step digests, in the order corresponding to build step
# indices.
"A String",
@@ -340,8 +423,6 @@
},
},
],
- "numArtifacts": "A String", # Number of artifacts uploaded. Only populated when artifacts are uploaded.
- "artifactManifest": "A String", # Path to the artifact manifest. Only populated when artifacts are uploaded.
},
"logsBucket": "A String", # Google Cloud Storage bucket where logs should be written (see
# [Bucket Name
@@ -407,13 +488,13 @@
# If you built an image in a previous build step, it will be stored in the
# host's Docker daemon's cache and is available to use as the name for a
# later build step.
- "id": "A String", # Unique identifier for this build step, used in `wait_for` to
- # reference this build step as a dependency.
"secretEnv": [ # A list of environment variables which are encrypted using a Cloud Key
# Management Service crypto key. These values must be specified in the
# build's `Secret`.
"A String",
],
+ "id": "A String", # Unique identifier for this build step, used in `wait_for` to
+ # reference this build step as a dependency.
"dir": "A String", # Working directory to use when running this step's container.
#
# If this value is a relative path, it is relative to the build's working
@@ -424,12 +505,10 @@
# If the build specifies a `RepoSource` with `dir` and a step with a `dir`,
# which specifies an absolute path, the `RepoSource` `dir` is ignored for
# the step's execution.
- "env": [ # A list of environment variable definitions to be used when running a step.
- #
- # The elements are of the form "KEY=VALUE" for the environment variable "KEY"
- # being given the value "VALUE".
- "A String",
- ],
+ "timing": { # Start and end times for a build execution phase. # Output only. Stores timing information for executing this build step.
+ "endTime": "A String", # End of time span.
+ "startTime": "A String", # Start of time span.
+ },
"waitFor": [ # The ID(s) of the step(s) that this build step depends on.
# This build step will not start until all the build steps in `wait_for`
# have completed successfully. If `wait_for` is empty, this build step will
@@ -437,10 +516,12 @@
# completed successfully.
"A String",
],
- "timing": { # Start and end times for a build execution phase. # Output only. Stores timing information for executing this build step.
- "endTime": "A String", # End of time span.
- "startTime": "A String", # Start of time span.
- },
+ "env": [ # A list of environment variable definitions to be used when running a step.
+ #
+ # The elements are of the form "KEY=VALUE" for the environment variable "KEY"
+ # being given the value "VALUE".
+ "A String",
+ ],
},
],
"buildTriggerId": "A String", # Output only. The ID of the `BuildTrigger` that triggered this build, if it
@@ -449,85 +530,6 @@
"tags": [ # Tags for annotation of a `Build`. These are not docker tags.
"A String",
],
- "substitutions": { # Substitutions data for `Build` resource.
- "a_key": "A String",
- },
- "startTime": "A String", # Output only. Time at which execution of the build was started.
- "timing": { # Output only. Stores timing information for phases of the build. Valid keys
- # are:
- #
- # * BUILD: time to execute all build steps
- # * PUSH: time to push all specified images.
- # * FETCHSOURCE: time to fetch source.
- #
- # If the build does not specify source or images,
- # these keys will not be included.
- "a_key": { # Start and end times for a build execution phase.
- "endTime": "A String", # End of time span.
- "startTime": "A String", # Start of time span.
- },
- },
- "sourceProvenance": { # Provenance of the source. Ways to find the original source, or verify that # Output only. A permanent fixed identifier for source.
- # some source was used for this build.
- "resolvedRepoSource": { # Location of the source in a Google Cloud Source Repository. # A copy of the build's `source.repo_source`, if exists, with any
- # revisions resolved.
- "commitSha": "A String", # Explicit commit SHA to build.
- "substitutions": { # Substitutions to use in a triggered build.
- # Should only be used with RunBuildTrigger
- "a_key": "A String",
- },
- "invertRegex": True or False, # Only trigger a build if the revision regex does NOT match the revision
- # regex.
- "dir": "A String", # Directory, relative to the source root, in which to run the build.
- #
- # This must be a relative path. If a step's `dir` is specified and is an
- # absolute path, this value is ignored for that step's execution.
- "branchName": "A String", # Regex matching branches to build.
- #
- # The syntax of the regular expressions accepted is the syntax accepted by
- # RE2 and described at https://github.com/google/re2/wiki/Syntax
- "tagName": "A String", # Regex matching tags to build.
- #
- # The syntax of the regular expressions accepted is the syntax accepted by
- # RE2 and described at https://github.com/google/re2/wiki/Syntax
- "projectId": "A String", # ID of the project that owns the Cloud Source Repository. If omitted, the
- # project ID requesting the build is assumed.
- "repoName": "A String", # Required. Name of the Cloud Source Repository.
- },
- "resolvedStorageSource": { # Location of the source in an archive file in Google Cloud Storage. # A copy of the build's `source.storage_source`, if exists, with any
- # generations resolved.
- "generation": "A String", # Google Cloud Storage generation for the object. If the generation is
- # omitted, the latest generation will be used.
- "bucket": "A String", # Google Cloud Storage bucket containing the source (see
- # [Bucket Name
- # Requirements](https://cloud.google.com/storage/docs/bucket-naming#requirements)).
- "object": "A String", # Google Cloud Storage object containing the source.
- #
- # This object must be a gzipped archive file (`.tar.gz`) containing source to
- # build.
- },
- "fileHashes": { # Output only. Hash(es) of the build source, which can be used to verify that
- # the original source integrity was maintained in the build. Note that
- # `FileHashes` will only be populated if `BuildOptions` has requested a
- # `SourceProvenanceHash`.
- #
- # The keys to this map are file paths used as build source and the values
- # contain the hash values for those files.
- #
- # If the build source came in a single package such as a gzipped tarfile
- # (`.tar.gz`), the `FileHash` will be for the single path to that file.
- "a_key": { # Container message for hashes of byte content of files, used in
- # SourceProvenance messages to verify integrity of source input to the build.
- "fileHash": [ # Collection of file hashes.
- { # Container message for hash values.
- "value": "A String", # The hash value.
- "type": "A String", # The type of hash that was performed.
- },
- ],
- },
- },
- },
- "createTime": "A String", # Output only. Time at which the request to create the build was received.
}</pre>
</div>
@@ -561,6 +563,85 @@
# - $REVISION_ID or $COMMIT_SHA: the commit SHA specified by RepoSource or
# resolved from the specified branch or tag.
# - $SHORT_SHA: first 7 characters of $REVISION_ID or $COMMIT_SHA.
+ "startTime": "A String", # Output only. Time at which execution of the build was started.
+ "substitutions": { # Substitutions data for `Build` resource.
+ "a_key": "A String",
+ },
+ "timing": { # Output only. Stores timing information for phases of the build. Valid keys
+ # are:
+ #
+ # * BUILD: time to execute all build steps
+ # * PUSH: time to push all specified images.
+ # * FETCHSOURCE: time to fetch source.
+ #
+ # If the build does not specify source or images,
+ # these keys will not be included.
+ "a_key": { # Start and end times for a build execution phase.
+ "endTime": "A String", # End of time span.
+ "startTime": "A String", # Start of time span.
+ },
+ },
+ "createTime": "A String", # Output only. Time at which the request to create the build was received.
+ "sourceProvenance": { # Provenance of the source. Ways to find the original source, or verify that # Output only. A permanent fixed identifier for source.
+ # some source was used for this build.
+ "fileHashes": { # Output only. Hash(es) of the build source, which can be used to verify that
+ # the original source integrity was maintained in the build. Note that
+ # `FileHashes` will only be populated if `BuildOptions` has requested a
+ # `SourceProvenanceHash`.
+ #
+ # The keys to this map are file paths used as build source and the values
+ # contain the hash values for those files.
+ #
+ # If the build source came in a single package such as a gzipped tarfile
+ # (`.tar.gz`), the `FileHash` will be for the single path to that file.
+ "a_key": { # Container message for hashes of byte content of files, used in
+ # SourceProvenance messages to verify integrity of source input to the build.
+ "fileHash": [ # Collection of file hashes.
+ { # Container message for hash values.
+ "type": "A String", # The type of hash that was performed.
+ "value": "A String", # The hash value.
+ },
+ ],
+ },
+ },
+ "resolvedRepoSource": { # Location of the source in a Google Cloud Source Repository. # A copy of the build's `source.repo_source`, if exists, with any
+ # revisions resolved.
+ "branchName": "A String", # Regex matching branches to build.
+ #
+ # The syntax of the regular expressions accepted is the syntax accepted by
+ # RE2 and described at https://github.com/google/re2/wiki/Syntax
+ "dir": "A String", # Directory, relative to the source root, in which to run the build.
+ #
+ # This must be a relative path. If a step's `dir` is specified and is an
+ # absolute path, this value is ignored for that step's execution.
+ "tagName": "A String", # Regex matching tags to build.
+ #
+ # The syntax of the regular expressions accepted is the syntax accepted by
+ # RE2 and described at https://github.com/google/re2/wiki/Syntax
+ "projectId": "A String", # ID of the project that owns the Cloud Source Repository. If omitted, the
+ # project ID requesting the build is assumed.
+ "repoName": "A String", # Required. Name of the Cloud Source Repository.
+ "commitSha": "A String", # Explicit commit SHA to build.
+ "substitutions": { # Substitutions to use in a triggered build.
+ # Should only be used with RunBuildTrigger
+ "a_key": "A String",
+ },
+ "invertRegex": True or False, # Only trigger a build if the revision regex does NOT match the revision
+ # regex.
+ },
+ "resolvedStorageSource": { # Location of the source in an archive file in Google Cloud Storage. # A copy of the build's `source.storage_source`, if exists, with any
+ # generations resolved.
+ "object": "A String", # Google Cloud Storage object containing the source.
+ #
+ # This object must be a gzipped archive file (`.tar.gz`) containing source to
+ # build.
+ "generation": "A String", # Google Cloud Storage generation for the object. If the generation is
+ # omitted, the latest generation will be used.
+ "bucket": "A String", # Google Cloud Storage bucket containing the source (see
+ # [Bucket Name
+ # Requirements](https://cloud.google.com/storage/docs/bucket-naming#requirements)).
+ },
+ },
"images": [ # A list of images to be pushed upon the successful completion of all build
# steps.
#
@@ -585,34 +666,16 @@
# The difference between finish_time and start_time is the duration of the
# build's execution.
"source": { # Location of the source in a supported storage service. # The location of the source files to build.
- "storageSource": { # Location of the source in an archive file in Google Cloud Storage. # If provided, get the source from this location in Google Cloud Storage.
- "generation": "A String", # Google Cloud Storage generation for the object. If the generation is
- # omitted, the latest generation will be used.
- "bucket": "A String", # Google Cloud Storage bucket containing the source (see
- # [Bucket Name
- # Requirements](https://cloud.google.com/storage/docs/bucket-naming#requirements)).
- "object": "A String", # Google Cloud Storage object containing the source.
- #
- # This object must be a gzipped archive file (`.tar.gz`) containing source to
- # build.
- },
"repoSource": { # Location of the source in a Google Cloud Source Repository. # If provided, get the source from this location in a Cloud Source
# Repository.
- "commitSha": "A String", # Explicit commit SHA to build.
- "substitutions": { # Substitutions to use in a triggered build.
- # Should only be used with RunBuildTrigger
- "a_key": "A String",
- },
- "invertRegex": True or False, # Only trigger a build if the revision regex does NOT match the revision
- # regex.
- "dir": "A String", # Directory, relative to the source root, in which to run the build.
- #
- # This must be a relative path. If a step's `dir` is specified and is an
- # absolute path, this value is ignored for that step's execution.
"branchName": "A String", # Regex matching branches to build.
#
# The syntax of the regular expressions accepted is the syntax accepted by
# RE2 and described at https://github.com/google/re2/wiki/Syntax
+ "dir": "A String", # Directory, relative to the source root, in which to run the build.
+ #
+ # This must be a relative path. If a step's `dir` is specified and is an
+ # absolute path, this value is ignored for that step's execution.
"tagName": "A String", # Regex matching tags to build.
#
# The syntax of the regular expressions accepted is the syntax accepted by
@@ -620,13 +683,29 @@
"projectId": "A String", # ID of the project that owns the Cloud Source Repository. If omitted, the
# project ID requesting the build is assumed.
"repoName": "A String", # Required. Name of the Cloud Source Repository.
+ "commitSha": "A String", # Explicit commit SHA to build.
+ "substitutions": { # Substitutions to use in a triggered build.
+ # Should only be used with RunBuildTrigger
+ "a_key": "A String",
+ },
+ "invertRegex": True or False, # Only trigger a build if the revision regex does NOT match the revision
+ # regex.
+ },
+ "storageSource": { # Location of the source in an archive file in Google Cloud Storage. # If provided, get the source from this location in Google Cloud Storage.
+ "object": "A String", # Google Cloud Storage object containing the source.
+ #
+ # This object must be a gzipped archive file (`.tar.gz`) containing source to
+ # build.
+ "generation": "A String", # Google Cloud Storage generation for the object. If the generation is
+ # omitted, the latest generation will be used.
+ "bucket": "A String", # Google Cloud Storage bucket containing the source (see
+ # [Bucket Name
+ # Requirements](https://cloud.google.com/storage/docs/bucket-naming#requirements)).
},
},
"options": { # Optional arguments to enable specific features of builds. # Special options for this build.
- "workerPool": "A String", # Option to specify a `WorkerPool` for the build.
- # Format: projects/{project}/workerPools/{workerPool}
- #
- # This field is experimental.
+ "logStreamingOption": "A String", # Option to define build log streaming behavior to Google Cloud
+ # Storage.
"env": [ # A list of global environment variable definitions that will exist for all
# build steps in this build. If a variable is defined in both globally and in
# a build step, the variable will use the build step value.
@@ -635,11 +714,15 @@
# being given the value "VALUE".
"A String",
],
+ "workerPool": "A String", # Option to specify a `WorkerPool` for the build.
+ # Format: projects/{project}/workerPools/{workerPool}
+ #
+ # This field is experimental.
"logging": "A String", # Option to specify the logging mode, which determines where the logs are
# stored.
- "requestedVerifyOption": "A String", # Requested verifiability options.
"substitutionOption": "A String", # Option to specify behavior when there is an error in the substitution
# checks.
+ "requestedVerifyOption": "A String", # Requested verifiability options.
"diskSizeGb": "A String", # Requested disk size for the VM that runs the build. Note that this is *NOT*
# "disk free"; some of the space will be used by the operating system and
# build utilities. Also note that this is the minimum disk size that will be
@@ -655,6 +738,7 @@
# in this build.
"A String",
],
+ "machineType": "A String", # Compute Engine machine type on which to run the build.
"volumes": [ # Global list of volumes to mount for ALL build steps
#
# Each volume is created as an empty volume prior to starting the build
@@ -676,14 +760,13 @@
# Docker volumes. Each named volume must be used by at least two build steps.
},
],
- "machineType": "A String", # Compute Engine machine type on which to run the build.
- "logStreamingOption": "A String", # Option to define build log streaming behavior to Google Cloud
- # Storage.
},
"timeout": "A String", # Amount of time that this build should be allowed to run, to second
# granularity. If this amount of time elapses, work on the build will cease
# and the build status will be `TIMEOUT`.
#
+ # `timeout` starts ticking from `startTime`.
+ #
# Default time is ten minutes.
"status": "A String", # Output only. Status of the build.
"statusDetail": "A String", # Output only. Customer-readable message about the current status.
@@ -706,15 +789,15 @@
"endTime": "A String", # End of time span.
"startTime": "A String", # Start of time span.
},
- "paths": [ # Path globs used to match files in the build's workspace.
- "A String",
- ],
"location": "A String", # Cloud Storage bucket and optional object path, in the form
# "gs://bucket/path/to/somewhere/". (see [Bucket Name
# Requirements](https://cloud.google.com/storage/docs/bucket-naming#requirements)).
#
# Files in the workspace matching any path pattern will be uploaded to
# Cloud Storage with this location as a prefix.
+ "paths": [ # Path globs used to match files in the build's workspace.
+ "A String",
+ ],
},
"images": [ # A list of images to be pushed upon the successful completion of all build
# steps.
@@ -731,6 +814,7 @@
"secrets": [ # Secrets to decrypt using Cloud Key Management Service.
{ # Pairs a set of secret environment variables containing encrypted
# values with the Cloud KMS key to use to decrypt the value.
+ "kmsKeyName": "A String", # Cloud KMS key name to use to decrypt these envs.
"secretEnv": { # Map of environment variable name to its encrypted value.
#
# Secret environment variables must be unique across all of a build's
@@ -739,10 +823,11 @@
# build's secrets.
"a_key": "A String",
},
- "kmsKeyName": "A String", # Cloud KMS key name to use to decrypt these envs.
},
],
"results": { # Artifacts created by the build pipeline. # Output only. Results of the build.
+ "numArtifacts": "A String", # Number of artifacts uploaded. Only populated when artifacts are uploaded.
+ "artifactManifest": "A String", # Path to the artifact manifest. Only populated when artifacts are uploaded.
"buildStepImages": [ # List of build step digests, in the order corresponding to build step
# indices.
"A String",
@@ -770,8 +855,6 @@
},
},
],
- "numArtifacts": "A String", # Number of artifacts uploaded. Only populated when artifacts are uploaded.
- "artifactManifest": "A String", # Path to the artifact manifest. Only populated when artifacts are uploaded.
},
"logsBucket": "A String", # Google Cloud Storage bucket where logs should be written (see
# [Bucket Name
@@ -837,13 +920,13 @@
# If you built an image in a previous build step, it will be stored in the
# host's Docker daemon's cache and is available to use as the name for a
# later build step.
- "id": "A String", # Unique identifier for this build step, used in `wait_for` to
- # reference this build step as a dependency.
"secretEnv": [ # A list of environment variables which are encrypted using a Cloud Key
# Management Service crypto key. These values must be specified in the
# build's `Secret`.
"A String",
],
+ "id": "A String", # Unique identifier for this build step, used in `wait_for` to
+ # reference this build step as a dependency.
"dir": "A String", # Working directory to use when running this step's container.
#
# If this value is a relative path, it is relative to the build's working
@@ -854,12 +937,10 @@
# If the build specifies a `RepoSource` with `dir` and a step with a `dir`,
# which specifies an absolute path, the `RepoSource` `dir` is ignored for
# the step's execution.
- "env": [ # A list of environment variable definitions to be used when running a step.
- #
- # The elements are of the form "KEY=VALUE" for the environment variable "KEY"
- # being given the value "VALUE".
- "A String",
- ],
+ "timing": { # Start and end times for a build execution phase. # Output only. Stores timing information for executing this build step.
+ "endTime": "A String", # End of time span.
+ "startTime": "A String", # Start of time span.
+ },
"waitFor": [ # The ID(s) of the step(s) that this build step depends on.
# This build step will not start until all the build steps in `wait_for`
# have completed successfully. If `wait_for` is empty, this build step will
@@ -867,10 +948,12 @@
# completed successfully.
"A String",
],
- "timing": { # Start and end times for a build execution phase. # Output only. Stores timing information for executing this build step.
- "endTime": "A String", # End of time span.
- "startTime": "A String", # Start of time span.
- },
+ "env": [ # A list of environment variable definitions to be used when running a step.
+ #
+ # The elements are of the form "KEY=VALUE" for the environment variable "KEY"
+ # being given the value "VALUE".
+ "A String",
+ ],
},
],
"buildTriggerId": "A String", # Output only. The ID of the `BuildTrigger` that triggered this build, if it
@@ -879,85 +962,6 @@
"tags": [ # Tags for annotation of a `Build`. These are not docker tags.
"A String",
],
- "substitutions": { # Substitutions data for `Build` resource.
- "a_key": "A String",
- },
- "startTime": "A String", # Output only. Time at which execution of the build was started.
- "timing": { # Output only. Stores timing information for phases of the build. Valid keys
- # are:
- #
- # * BUILD: time to execute all build steps
- # * PUSH: time to push all specified images.
- # * FETCHSOURCE: time to fetch source.
- #
- # If the build does not specify source or images,
- # these keys will not be included.
- "a_key": { # Start and end times for a build execution phase.
- "endTime": "A String", # End of time span.
- "startTime": "A String", # Start of time span.
- },
- },
- "sourceProvenance": { # Provenance of the source. Ways to find the original source, or verify that # Output only. A permanent fixed identifier for source.
- # some source was used for this build.
- "resolvedRepoSource": { # Location of the source in a Google Cloud Source Repository. # A copy of the build's `source.repo_source`, if exists, with any
- # revisions resolved.
- "commitSha": "A String", # Explicit commit SHA to build.
- "substitutions": { # Substitutions to use in a triggered build.
- # Should only be used with RunBuildTrigger
- "a_key": "A String",
- },
- "invertRegex": True or False, # Only trigger a build if the revision regex does NOT match the revision
- # regex.
- "dir": "A String", # Directory, relative to the source root, in which to run the build.
- #
- # This must be a relative path. If a step's `dir` is specified and is an
- # absolute path, this value is ignored for that step's execution.
- "branchName": "A String", # Regex matching branches to build.
- #
- # The syntax of the regular expressions accepted is the syntax accepted by
- # RE2 and described at https://github.com/google/re2/wiki/Syntax
- "tagName": "A String", # Regex matching tags to build.
- #
- # The syntax of the regular expressions accepted is the syntax accepted by
- # RE2 and described at https://github.com/google/re2/wiki/Syntax
- "projectId": "A String", # ID of the project that owns the Cloud Source Repository. If omitted, the
- # project ID requesting the build is assumed.
- "repoName": "A String", # Required. Name of the Cloud Source Repository.
- },
- "resolvedStorageSource": { # Location of the source in an archive file in Google Cloud Storage. # A copy of the build's `source.storage_source`, if exists, with any
- # generations resolved.
- "generation": "A String", # Google Cloud Storage generation for the object. If the generation is
- # omitted, the latest generation will be used.
- "bucket": "A String", # Google Cloud Storage bucket containing the source (see
- # [Bucket Name
- # Requirements](https://cloud.google.com/storage/docs/bucket-naming#requirements)).
- "object": "A String", # Google Cloud Storage object containing the source.
- #
- # This object must be a gzipped archive file (`.tar.gz`) containing source to
- # build.
- },
- "fileHashes": { # Output only. Hash(es) of the build source, which can be used to verify that
- # the original source integrity was maintained in the build. Note that
- # `FileHashes` will only be populated if `BuildOptions` has requested a
- # `SourceProvenanceHash`.
- #
- # The keys to this map are file paths used as build source and the values
- # contain the hash values for those files.
- #
- # If the build source came in a single package such as a gzipped tarfile
- # (`.tar.gz`), the `FileHash` will be for the single path to that file.
- "a_key": { # Container message for hashes of byte content of files, used in
- # SourceProvenance messages to verify integrity of source input to the build.
- "fileHash": [ # Collection of file hashes.
- { # Container message for hash values.
- "value": "A String", # The hash value.
- "type": "A String", # The type of hash that was performed.
- },
- ],
- },
- },
- },
- "createTime": "A String", # Output only. Time at which the request to create the build was received.
}
x__xgafv: string, V1 error format.
@@ -970,6 +974,33 @@
{ # This resource represents a long-running operation that is the result of a
# network API call.
+ "name": "A String", # 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}`.
+ "error": { # The `Status` type defines a logical error model that is suitable for # The error result of the operation in case of failure or cancellation.
+ # 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).
+ "message": "A String", # 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.
+ "details": [ # A list of messages that carry the error details. There is a common set of
+ # message types for APIs to use.
+ {
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
+ ],
+ "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+ },
+ "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.
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
"done": True or False, # 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.
@@ -983,33 +1014,6 @@
# `TakeSnapshotResponse`.
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
- "name": "A String", # 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}`.
- "error": { # The `Status` type defines a logical error model that is suitable for # The error result of the operation in case of failure or cancellation.
- # 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).
- "code": 42, # The status code, which should be an enum value of google.rpc.Code.
- "message": "A String", # 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.
- "details": [ # A list of messages that carry the error details. There is a common set of
- # message types for APIs to use.
- {
- "a_key": "", # Properties of the object. Contains field @type with type URL.
- },
- ],
- },
- "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.
- "a_key": "", # Properties of the object. Contains field @type with type URL.
- },
}</pre>
</div>
@@ -1048,6 +1052,85 @@
# - $REVISION_ID or $COMMIT_SHA: the commit SHA specified by RepoSource or
# resolved from the specified branch or tag.
# - $SHORT_SHA: first 7 characters of $REVISION_ID or $COMMIT_SHA.
+ "startTime": "A String", # Output only. Time at which execution of the build was started.
+ "substitutions": { # Substitutions data for `Build` resource.
+ "a_key": "A String",
+ },
+ "timing": { # Output only. Stores timing information for phases of the build. Valid keys
+ # are:
+ #
+ # * BUILD: time to execute all build steps
+ # * PUSH: time to push all specified images.
+ # * FETCHSOURCE: time to fetch source.
+ #
+ # If the build does not specify source or images,
+ # these keys will not be included.
+ "a_key": { # Start and end times for a build execution phase.
+ "endTime": "A String", # End of time span.
+ "startTime": "A String", # Start of time span.
+ },
+ },
+ "createTime": "A String", # Output only. Time at which the request to create the build was received.
+ "sourceProvenance": { # Provenance of the source. Ways to find the original source, or verify that # Output only. A permanent fixed identifier for source.
+ # some source was used for this build.
+ "fileHashes": { # Output only. Hash(es) of the build source, which can be used to verify that
+ # the original source integrity was maintained in the build. Note that
+ # `FileHashes` will only be populated if `BuildOptions` has requested a
+ # `SourceProvenanceHash`.
+ #
+ # The keys to this map are file paths used as build source and the values
+ # contain the hash values for those files.
+ #
+ # If the build source came in a single package such as a gzipped tarfile
+ # (`.tar.gz`), the `FileHash` will be for the single path to that file.
+ "a_key": { # Container message for hashes of byte content of files, used in
+ # SourceProvenance messages to verify integrity of source input to the build.
+ "fileHash": [ # Collection of file hashes.
+ { # Container message for hash values.
+ "type": "A String", # The type of hash that was performed.
+ "value": "A String", # The hash value.
+ },
+ ],
+ },
+ },
+ "resolvedRepoSource": { # Location of the source in a Google Cloud Source Repository. # A copy of the build's `source.repo_source`, if exists, with any
+ # revisions resolved.
+ "branchName": "A String", # Regex matching branches to build.
+ #
+ # The syntax of the regular expressions accepted is the syntax accepted by
+ # RE2 and described at https://github.com/google/re2/wiki/Syntax
+ "dir": "A String", # Directory, relative to the source root, in which to run the build.
+ #
+ # This must be a relative path. If a step's `dir` is specified and is an
+ # absolute path, this value is ignored for that step's execution.
+ "tagName": "A String", # Regex matching tags to build.
+ #
+ # The syntax of the regular expressions accepted is the syntax accepted by
+ # RE2 and described at https://github.com/google/re2/wiki/Syntax
+ "projectId": "A String", # ID of the project that owns the Cloud Source Repository. If omitted, the
+ # project ID requesting the build is assumed.
+ "repoName": "A String", # Required. Name of the Cloud Source Repository.
+ "commitSha": "A String", # Explicit commit SHA to build.
+ "substitutions": { # Substitutions to use in a triggered build.
+ # Should only be used with RunBuildTrigger
+ "a_key": "A String",
+ },
+ "invertRegex": True or False, # Only trigger a build if the revision regex does NOT match the revision
+ # regex.
+ },
+ "resolvedStorageSource": { # Location of the source in an archive file in Google Cloud Storage. # A copy of the build's `source.storage_source`, if exists, with any
+ # generations resolved.
+ "object": "A String", # Google Cloud Storage object containing the source.
+ #
+ # This object must be a gzipped archive file (`.tar.gz`) containing source to
+ # build.
+ "generation": "A String", # Google Cloud Storage generation for the object. If the generation is
+ # omitted, the latest generation will be used.
+ "bucket": "A String", # Google Cloud Storage bucket containing the source (see
+ # [Bucket Name
+ # Requirements](https://cloud.google.com/storage/docs/bucket-naming#requirements)).
+ },
+ },
"images": [ # A list of images to be pushed upon the successful completion of all build
# steps.
#
@@ -1072,34 +1155,16 @@
# The difference between finish_time and start_time is the duration of the
# build's execution.
"source": { # Location of the source in a supported storage service. # The location of the source files to build.
- "storageSource": { # Location of the source in an archive file in Google Cloud Storage. # If provided, get the source from this location in Google Cloud Storage.
- "generation": "A String", # Google Cloud Storage generation for the object. If the generation is
- # omitted, the latest generation will be used.
- "bucket": "A String", # Google Cloud Storage bucket containing the source (see
- # [Bucket Name
- # Requirements](https://cloud.google.com/storage/docs/bucket-naming#requirements)).
- "object": "A String", # Google Cloud Storage object containing the source.
- #
- # This object must be a gzipped archive file (`.tar.gz`) containing source to
- # build.
- },
"repoSource": { # Location of the source in a Google Cloud Source Repository. # If provided, get the source from this location in a Cloud Source
# Repository.
- "commitSha": "A String", # Explicit commit SHA to build.
- "substitutions": { # Substitutions to use in a triggered build.
- # Should only be used with RunBuildTrigger
- "a_key": "A String",
- },
- "invertRegex": True or False, # Only trigger a build if the revision regex does NOT match the revision
- # regex.
- "dir": "A String", # Directory, relative to the source root, in which to run the build.
- #
- # This must be a relative path. If a step's `dir` is specified and is an
- # absolute path, this value is ignored for that step's execution.
"branchName": "A String", # Regex matching branches to build.
#
# The syntax of the regular expressions accepted is the syntax accepted by
# RE2 and described at https://github.com/google/re2/wiki/Syntax
+ "dir": "A String", # Directory, relative to the source root, in which to run the build.
+ #
+ # This must be a relative path. If a step's `dir` is specified and is an
+ # absolute path, this value is ignored for that step's execution.
"tagName": "A String", # Regex matching tags to build.
#
# The syntax of the regular expressions accepted is the syntax accepted by
@@ -1107,13 +1172,29 @@
"projectId": "A String", # ID of the project that owns the Cloud Source Repository. If omitted, the
# project ID requesting the build is assumed.
"repoName": "A String", # Required. Name of the Cloud Source Repository.
+ "commitSha": "A String", # Explicit commit SHA to build.
+ "substitutions": { # Substitutions to use in a triggered build.
+ # Should only be used with RunBuildTrigger
+ "a_key": "A String",
+ },
+ "invertRegex": True or False, # Only trigger a build if the revision regex does NOT match the revision
+ # regex.
+ },
+ "storageSource": { # Location of the source in an archive file in Google Cloud Storage. # If provided, get the source from this location in Google Cloud Storage.
+ "object": "A String", # Google Cloud Storage object containing the source.
+ #
+ # This object must be a gzipped archive file (`.tar.gz`) containing source to
+ # build.
+ "generation": "A String", # Google Cloud Storage generation for the object. If the generation is
+ # omitted, the latest generation will be used.
+ "bucket": "A String", # Google Cloud Storage bucket containing the source (see
+ # [Bucket Name
+ # Requirements](https://cloud.google.com/storage/docs/bucket-naming#requirements)).
},
},
"options": { # Optional arguments to enable specific features of builds. # Special options for this build.
- "workerPool": "A String", # Option to specify a `WorkerPool` for the build.
- # Format: projects/{project}/workerPools/{workerPool}
- #
- # This field is experimental.
+ "logStreamingOption": "A String", # Option to define build log streaming behavior to Google Cloud
+ # Storage.
"env": [ # A list of global environment variable definitions that will exist for all
# build steps in this build. If a variable is defined in both globally and in
# a build step, the variable will use the build step value.
@@ -1122,11 +1203,15 @@
# being given the value "VALUE".
"A String",
],
+ "workerPool": "A String", # Option to specify a `WorkerPool` for the build.
+ # Format: projects/{project}/workerPools/{workerPool}
+ #
+ # This field is experimental.
"logging": "A String", # Option to specify the logging mode, which determines where the logs are
# stored.
- "requestedVerifyOption": "A String", # Requested verifiability options.
"substitutionOption": "A String", # Option to specify behavior when there is an error in the substitution
# checks.
+ "requestedVerifyOption": "A String", # Requested verifiability options.
"diskSizeGb": "A String", # Requested disk size for the VM that runs the build. Note that this is *NOT*
# "disk free"; some of the space will be used by the operating system and
# build utilities. Also note that this is the minimum disk size that will be
@@ -1142,6 +1227,7 @@
# in this build.
"A String",
],
+ "machineType": "A String", # Compute Engine machine type on which to run the build.
"volumes": [ # Global list of volumes to mount for ALL build steps
#
# Each volume is created as an empty volume prior to starting the build
@@ -1163,14 +1249,13 @@
# Docker volumes. Each named volume must be used by at least two build steps.
},
],
- "machineType": "A String", # Compute Engine machine type on which to run the build.
- "logStreamingOption": "A String", # Option to define build log streaming behavior to Google Cloud
- # Storage.
},
"timeout": "A String", # Amount of time that this build should be allowed to run, to second
# granularity. If this amount of time elapses, work on the build will cease
# and the build status will be `TIMEOUT`.
#
+ # `timeout` starts ticking from `startTime`.
+ #
# Default time is ten minutes.
"status": "A String", # Output only. Status of the build.
"statusDetail": "A String", # Output only. Customer-readable message about the current status.
@@ -1193,15 +1278,15 @@
"endTime": "A String", # End of time span.
"startTime": "A String", # Start of time span.
},
- "paths": [ # Path globs used to match files in the build's workspace.
- "A String",
- ],
"location": "A String", # Cloud Storage bucket and optional object path, in the form
# "gs://bucket/path/to/somewhere/". (see [Bucket Name
# Requirements](https://cloud.google.com/storage/docs/bucket-naming#requirements)).
#
# Files in the workspace matching any path pattern will be uploaded to
# Cloud Storage with this location as a prefix.
+ "paths": [ # Path globs used to match files in the build's workspace.
+ "A String",
+ ],
},
"images": [ # A list of images to be pushed upon the successful completion of all build
# steps.
@@ -1218,6 +1303,7 @@
"secrets": [ # Secrets to decrypt using Cloud Key Management Service.
{ # Pairs a set of secret environment variables containing encrypted
# values with the Cloud KMS key to use to decrypt the value.
+ "kmsKeyName": "A String", # Cloud KMS key name to use to decrypt these envs.
"secretEnv": { # Map of environment variable name to its encrypted value.
#
# Secret environment variables must be unique across all of a build's
@@ -1226,10 +1312,11 @@
# build's secrets.
"a_key": "A String",
},
- "kmsKeyName": "A String", # Cloud KMS key name to use to decrypt these envs.
},
],
"results": { # Artifacts created by the build pipeline. # Output only. Results of the build.
+ "numArtifacts": "A String", # Number of artifacts uploaded. Only populated when artifacts are uploaded.
+ "artifactManifest": "A String", # Path to the artifact manifest. Only populated when artifacts are uploaded.
"buildStepImages": [ # List of build step digests, in the order corresponding to build step
# indices.
"A String",
@@ -1257,8 +1344,6 @@
},
},
],
- "numArtifacts": "A String", # Number of artifacts uploaded. Only populated when artifacts are uploaded.
- "artifactManifest": "A String", # Path to the artifact manifest. Only populated when artifacts are uploaded.
},
"logsBucket": "A String", # Google Cloud Storage bucket where logs should be written (see
# [Bucket Name
@@ -1324,13 +1409,13 @@
# If you built an image in a previous build step, it will be stored in the
# host's Docker daemon's cache and is available to use as the name for a
# later build step.
- "id": "A String", # Unique identifier for this build step, used in `wait_for` to
- # reference this build step as a dependency.
"secretEnv": [ # A list of environment variables which are encrypted using a Cloud Key
# Management Service crypto key. These values must be specified in the
# build's `Secret`.
"A String",
],
+ "id": "A String", # Unique identifier for this build step, used in `wait_for` to
+ # reference this build step as a dependency.
"dir": "A String", # Working directory to use when running this step's container.
#
# If this value is a relative path, it is relative to the build's working
@@ -1341,12 +1426,10 @@
# If the build specifies a `RepoSource` with `dir` and a step with a `dir`,
# which specifies an absolute path, the `RepoSource` `dir` is ignored for
# the step's execution.
- "env": [ # A list of environment variable definitions to be used when running a step.
- #
- # The elements are of the form "KEY=VALUE" for the environment variable "KEY"
- # being given the value "VALUE".
- "A String",
- ],
+ "timing": { # Start and end times for a build execution phase. # Output only. Stores timing information for executing this build step.
+ "endTime": "A String", # End of time span.
+ "startTime": "A String", # Start of time span.
+ },
"waitFor": [ # The ID(s) of the step(s) that this build step depends on.
# This build step will not start until all the build steps in `wait_for`
# have completed successfully. If `wait_for` is empty, this build step will
@@ -1354,10 +1437,12 @@
# completed successfully.
"A String",
],
- "timing": { # Start and end times for a build execution phase. # Output only. Stores timing information for executing this build step.
- "endTime": "A String", # End of time span.
- "startTime": "A String", # Start of time span.
- },
+ "env": [ # A list of environment variable definitions to be used when running a step.
+ #
+ # The elements are of the form "KEY=VALUE" for the environment variable "KEY"
+ # being given the value "VALUE".
+ "A String",
+ ],
},
],
"buildTriggerId": "A String", # Output only. The ID of the `BuildTrigger` that triggered this build, if it
@@ -1366,85 +1451,6 @@
"tags": [ # Tags for annotation of a `Build`. These are not docker tags.
"A String",
],
- "substitutions": { # Substitutions data for `Build` resource.
- "a_key": "A String",
- },
- "startTime": "A String", # Output only. Time at which execution of the build was started.
- "timing": { # Output only. Stores timing information for phases of the build. Valid keys
- # are:
- #
- # * BUILD: time to execute all build steps
- # * PUSH: time to push all specified images.
- # * FETCHSOURCE: time to fetch source.
- #
- # If the build does not specify source or images,
- # these keys will not be included.
- "a_key": { # Start and end times for a build execution phase.
- "endTime": "A String", # End of time span.
- "startTime": "A String", # Start of time span.
- },
- },
- "sourceProvenance": { # Provenance of the source. Ways to find the original source, or verify that # Output only. A permanent fixed identifier for source.
- # some source was used for this build.
- "resolvedRepoSource": { # Location of the source in a Google Cloud Source Repository. # A copy of the build's `source.repo_source`, if exists, with any
- # revisions resolved.
- "commitSha": "A String", # Explicit commit SHA to build.
- "substitutions": { # Substitutions to use in a triggered build.
- # Should only be used with RunBuildTrigger
- "a_key": "A String",
- },
- "invertRegex": True or False, # Only trigger a build if the revision regex does NOT match the revision
- # regex.
- "dir": "A String", # Directory, relative to the source root, in which to run the build.
- #
- # This must be a relative path. If a step's `dir` is specified and is an
- # absolute path, this value is ignored for that step's execution.
- "branchName": "A String", # Regex matching branches to build.
- #
- # The syntax of the regular expressions accepted is the syntax accepted by
- # RE2 and described at https://github.com/google/re2/wiki/Syntax
- "tagName": "A String", # Regex matching tags to build.
- #
- # The syntax of the regular expressions accepted is the syntax accepted by
- # RE2 and described at https://github.com/google/re2/wiki/Syntax
- "projectId": "A String", # ID of the project that owns the Cloud Source Repository. If omitted, the
- # project ID requesting the build is assumed.
- "repoName": "A String", # Required. Name of the Cloud Source Repository.
- },
- "resolvedStorageSource": { # Location of the source in an archive file in Google Cloud Storage. # A copy of the build's `source.storage_source`, if exists, with any
- # generations resolved.
- "generation": "A String", # Google Cloud Storage generation for the object. If the generation is
- # omitted, the latest generation will be used.
- "bucket": "A String", # Google Cloud Storage bucket containing the source (see
- # [Bucket Name
- # Requirements](https://cloud.google.com/storage/docs/bucket-naming#requirements)).
- "object": "A String", # Google Cloud Storage object containing the source.
- #
- # This object must be a gzipped archive file (`.tar.gz`) containing source to
- # build.
- },
- "fileHashes": { # Output only. Hash(es) of the build source, which can be used to verify that
- # the original source integrity was maintained in the build. Note that
- # `FileHashes` will only be populated if `BuildOptions` has requested a
- # `SourceProvenanceHash`.
- #
- # The keys to this map are file paths used as build source and the values
- # contain the hash values for those files.
- #
- # If the build source came in a single package such as a gzipped tarfile
- # (`.tar.gz`), the `FileHash` will be for the single path to that file.
- "a_key": { # Container message for hashes of byte content of files, used in
- # SourceProvenance messages to verify integrity of source input to the build.
- "fileHash": [ # Collection of file hashes.
- { # Container message for hash values.
- "value": "A String", # The hash value.
- "type": "A String", # The type of hash that was performed.
- },
- ],
- },
- },
- },
- "createTime": "A String", # Output only. Time at which the request to create the build was received.
}</pre>
</div>
@@ -1488,6 +1494,85 @@
# - $REVISION_ID or $COMMIT_SHA: the commit SHA specified by RepoSource or
# resolved from the specified branch or tag.
# - $SHORT_SHA: first 7 characters of $REVISION_ID or $COMMIT_SHA.
+ "startTime": "A String", # Output only. Time at which execution of the build was started.
+ "substitutions": { # Substitutions data for `Build` resource.
+ "a_key": "A String",
+ },
+ "timing": { # Output only. Stores timing information for phases of the build. Valid keys
+ # are:
+ #
+ # * BUILD: time to execute all build steps
+ # * PUSH: time to push all specified images.
+ # * FETCHSOURCE: time to fetch source.
+ #
+ # If the build does not specify source or images,
+ # these keys will not be included.
+ "a_key": { # Start and end times for a build execution phase.
+ "endTime": "A String", # End of time span.
+ "startTime": "A String", # Start of time span.
+ },
+ },
+ "createTime": "A String", # Output only. Time at which the request to create the build was received.
+ "sourceProvenance": { # Provenance of the source. Ways to find the original source, or verify that # Output only. A permanent fixed identifier for source.
+ # some source was used for this build.
+ "fileHashes": { # Output only. Hash(es) of the build source, which can be used to verify that
+ # the original source integrity was maintained in the build. Note that
+ # `FileHashes` will only be populated if `BuildOptions` has requested a
+ # `SourceProvenanceHash`.
+ #
+ # The keys to this map are file paths used as build source and the values
+ # contain the hash values for those files.
+ #
+ # If the build source came in a single package such as a gzipped tarfile
+ # (`.tar.gz`), the `FileHash` will be for the single path to that file.
+ "a_key": { # Container message for hashes of byte content of files, used in
+ # SourceProvenance messages to verify integrity of source input to the build.
+ "fileHash": [ # Collection of file hashes.
+ { # Container message for hash values.
+ "type": "A String", # The type of hash that was performed.
+ "value": "A String", # The hash value.
+ },
+ ],
+ },
+ },
+ "resolvedRepoSource": { # Location of the source in a Google Cloud Source Repository. # A copy of the build's `source.repo_source`, if exists, with any
+ # revisions resolved.
+ "branchName": "A String", # Regex matching branches to build.
+ #
+ # The syntax of the regular expressions accepted is the syntax accepted by
+ # RE2 and described at https://github.com/google/re2/wiki/Syntax
+ "dir": "A String", # Directory, relative to the source root, in which to run the build.
+ #
+ # This must be a relative path. If a step's `dir` is specified and is an
+ # absolute path, this value is ignored for that step's execution.
+ "tagName": "A String", # Regex matching tags to build.
+ #
+ # The syntax of the regular expressions accepted is the syntax accepted by
+ # RE2 and described at https://github.com/google/re2/wiki/Syntax
+ "projectId": "A String", # ID of the project that owns the Cloud Source Repository. If omitted, the
+ # project ID requesting the build is assumed.
+ "repoName": "A String", # Required. Name of the Cloud Source Repository.
+ "commitSha": "A String", # Explicit commit SHA to build.
+ "substitutions": { # Substitutions to use in a triggered build.
+ # Should only be used with RunBuildTrigger
+ "a_key": "A String",
+ },
+ "invertRegex": True or False, # Only trigger a build if the revision regex does NOT match the revision
+ # regex.
+ },
+ "resolvedStorageSource": { # Location of the source in an archive file in Google Cloud Storage. # A copy of the build's `source.storage_source`, if exists, with any
+ # generations resolved.
+ "object": "A String", # Google Cloud Storage object containing the source.
+ #
+ # This object must be a gzipped archive file (`.tar.gz`) containing source to
+ # build.
+ "generation": "A String", # Google Cloud Storage generation for the object. If the generation is
+ # omitted, the latest generation will be used.
+ "bucket": "A String", # Google Cloud Storage bucket containing the source (see
+ # [Bucket Name
+ # Requirements](https://cloud.google.com/storage/docs/bucket-naming#requirements)).
+ },
+ },
"images": [ # A list of images to be pushed upon the successful completion of all build
# steps.
#
@@ -1512,34 +1597,16 @@
# The difference between finish_time and start_time is the duration of the
# build's execution.
"source": { # Location of the source in a supported storage service. # The location of the source files to build.
- "storageSource": { # Location of the source in an archive file in Google Cloud Storage. # If provided, get the source from this location in Google Cloud Storage.
- "generation": "A String", # Google Cloud Storage generation for the object. If the generation is
- # omitted, the latest generation will be used.
- "bucket": "A String", # Google Cloud Storage bucket containing the source (see
- # [Bucket Name
- # Requirements](https://cloud.google.com/storage/docs/bucket-naming#requirements)).
- "object": "A String", # Google Cloud Storage object containing the source.
- #
- # This object must be a gzipped archive file (`.tar.gz`) containing source to
- # build.
- },
"repoSource": { # Location of the source in a Google Cloud Source Repository. # If provided, get the source from this location in a Cloud Source
# Repository.
- "commitSha": "A String", # Explicit commit SHA to build.
- "substitutions": { # Substitutions to use in a triggered build.
- # Should only be used with RunBuildTrigger
- "a_key": "A String",
- },
- "invertRegex": True or False, # Only trigger a build if the revision regex does NOT match the revision
- # regex.
- "dir": "A String", # Directory, relative to the source root, in which to run the build.
- #
- # This must be a relative path. If a step's `dir` is specified and is an
- # absolute path, this value is ignored for that step's execution.
"branchName": "A String", # Regex matching branches to build.
#
# The syntax of the regular expressions accepted is the syntax accepted by
# RE2 and described at https://github.com/google/re2/wiki/Syntax
+ "dir": "A String", # Directory, relative to the source root, in which to run the build.
+ #
+ # This must be a relative path. If a step's `dir` is specified and is an
+ # absolute path, this value is ignored for that step's execution.
"tagName": "A String", # Regex matching tags to build.
#
# The syntax of the regular expressions accepted is the syntax accepted by
@@ -1547,13 +1614,29 @@
"projectId": "A String", # ID of the project that owns the Cloud Source Repository. If omitted, the
# project ID requesting the build is assumed.
"repoName": "A String", # Required. Name of the Cloud Source Repository.
+ "commitSha": "A String", # Explicit commit SHA to build.
+ "substitutions": { # Substitutions to use in a triggered build.
+ # Should only be used with RunBuildTrigger
+ "a_key": "A String",
+ },
+ "invertRegex": True or False, # Only trigger a build if the revision regex does NOT match the revision
+ # regex.
+ },
+ "storageSource": { # Location of the source in an archive file in Google Cloud Storage. # If provided, get the source from this location in Google Cloud Storage.
+ "object": "A String", # Google Cloud Storage object containing the source.
+ #
+ # This object must be a gzipped archive file (`.tar.gz`) containing source to
+ # build.
+ "generation": "A String", # Google Cloud Storage generation for the object. If the generation is
+ # omitted, the latest generation will be used.
+ "bucket": "A String", # Google Cloud Storage bucket containing the source (see
+ # [Bucket Name
+ # Requirements](https://cloud.google.com/storage/docs/bucket-naming#requirements)).
},
},
"options": { # Optional arguments to enable specific features of builds. # Special options for this build.
- "workerPool": "A String", # Option to specify a `WorkerPool` for the build.
- # Format: projects/{project}/workerPools/{workerPool}
- #
- # This field is experimental.
+ "logStreamingOption": "A String", # Option to define build log streaming behavior to Google Cloud
+ # Storage.
"env": [ # A list of global environment variable definitions that will exist for all
# build steps in this build. If a variable is defined in both globally and in
# a build step, the variable will use the build step value.
@@ -1562,11 +1645,15 @@
# being given the value "VALUE".
"A String",
],
+ "workerPool": "A String", # Option to specify a `WorkerPool` for the build.
+ # Format: projects/{project}/workerPools/{workerPool}
+ #
+ # This field is experimental.
"logging": "A String", # Option to specify the logging mode, which determines where the logs are
# stored.
- "requestedVerifyOption": "A String", # Requested verifiability options.
"substitutionOption": "A String", # Option to specify behavior when there is an error in the substitution
# checks.
+ "requestedVerifyOption": "A String", # Requested verifiability options.
"diskSizeGb": "A String", # Requested disk size for the VM that runs the build. Note that this is *NOT*
# "disk free"; some of the space will be used by the operating system and
# build utilities. Also note that this is the minimum disk size that will be
@@ -1582,6 +1669,7 @@
# in this build.
"A String",
],
+ "machineType": "A String", # Compute Engine machine type on which to run the build.
"volumes": [ # Global list of volumes to mount for ALL build steps
#
# Each volume is created as an empty volume prior to starting the build
@@ -1603,14 +1691,13 @@
# Docker volumes. Each named volume must be used by at least two build steps.
},
],
- "machineType": "A String", # Compute Engine machine type on which to run the build.
- "logStreamingOption": "A String", # Option to define build log streaming behavior to Google Cloud
- # Storage.
},
"timeout": "A String", # Amount of time that this build should be allowed to run, to second
# granularity. If this amount of time elapses, work on the build will cease
# and the build status will be `TIMEOUT`.
#
+ # `timeout` starts ticking from `startTime`.
+ #
# Default time is ten minutes.
"status": "A String", # Output only. Status of the build.
"statusDetail": "A String", # Output only. Customer-readable message about the current status.
@@ -1633,15 +1720,15 @@
"endTime": "A String", # End of time span.
"startTime": "A String", # Start of time span.
},
- "paths": [ # Path globs used to match files in the build's workspace.
- "A String",
- ],
"location": "A String", # Cloud Storage bucket and optional object path, in the form
# "gs://bucket/path/to/somewhere/". (see [Bucket Name
# Requirements](https://cloud.google.com/storage/docs/bucket-naming#requirements)).
#
# Files in the workspace matching any path pattern will be uploaded to
# Cloud Storage with this location as a prefix.
+ "paths": [ # Path globs used to match files in the build's workspace.
+ "A String",
+ ],
},
"images": [ # A list of images to be pushed upon the successful completion of all build
# steps.
@@ -1658,6 +1745,7 @@
"secrets": [ # Secrets to decrypt using Cloud Key Management Service.
{ # Pairs a set of secret environment variables containing encrypted
# values with the Cloud KMS key to use to decrypt the value.
+ "kmsKeyName": "A String", # Cloud KMS key name to use to decrypt these envs.
"secretEnv": { # Map of environment variable name to its encrypted value.
#
# Secret environment variables must be unique across all of a build's
@@ -1666,10 +1754,11 @@
# build's secrets.
"a_key": "A String",
},
- "kmsKeyName": "A String", # Cloud KMS key name to use to decrypt these envs.
},
],
"results": { # Artifacts created by the build pipeline. # Output only. Results of the build.
+ "numArtifacts": "A String", # Number of artifacts uploaded. Only populated when artifacts are uploaded.
+ "artifactManifest": "A String", # Path to the artifact manifest. Only populated when artifacts are uploaded.
"buildStepImages": [ # List of build step digests, in the order corresponding to build step
# indices.
"A String",
@@ -1697,8 +1786,6 @@
},
},
],
- "numArtifacts": "A String", # Number of artifacts uploaded. Only populated when artifacts are uploaded.
- "artifactManifest": "A String", # Path to the artifact manifest. Only populated when artifacts are uploaded.
},
"logsBucket": "A String", # Google Cloud Storage bucket where logs should be written (see
# [Bucket Name
@@ -1764,13 +1851,13 @@
# If you built an image in a previous build step, it will be stored in the
# host's Docker daemon's cache and is available to use as the name for a
# later build step.
- "id": "A String", # Unique identifier for this build step, used in `wait_for` to
- # reference this build step as a dependency.
"secretEnv": [ # A list of environment variables which are encrypted using a Cloud Key
# Management Service crypto key. These values must be specified in the
# build's `Secret`.
"A String",
],
+ "id": "A String", # Unique identifier for this build step, used in `wait_for` to
+ # reference this build step as a dependency.
"dir": "A String", # Working directory to use when running this step's container.
#
# If this value is a relative path, it is relative to the build's working
@@ -1781,12 +1868,10 @@
# If the build specifies a `RepoSource` with `dir` and a step with a `dir`,
# which specifies an absolute path, the `RepoSource` `dir` is ignored for
# the step's execution.
- "env": [ # A list of environment variable definitions to be used when running a step.
- #
- # The elements are of the form "KEY=VALUE" for the environment variable "KEY"
- # being given the value "VALUE".
- "A String",
- ],
+ "timing": { # Start and end times for a build execution phase. # Output only. Stores timing information for executing this build step.
+ "endTime": "A String", # End of time span.
+ "startTime": "A String", # Start of time span.
+ },
"waitFor": [ # The ID(s) of the step(s) that this build step depends on.
# This build step will not start until all the build steps in `wait_for`
# have completed successfully. If `wait_for` is empty, this build step will
@@ -1794,10 +1879,12 @@
# completed successfully.
"A String",
],
- "timing": { # Start and end times for a build execution phase. # Output only. Stores timing information for executing this build step.
- "endTime": "A String", # End of time span.
- "startTime": "A String", # Start of time span.
- },
+ "env": [ # A list of environment variable definitions to be used when running a step.
+ #
+ # The elements are of the form "KEY=VALUE" for the environment variable "KEY"
+ # being given the value "VALUE".
+ "A String",
+ ],
},
],
"buildTriggerId": "A String", # Output only. The ID of the `BuildTrigger` that triggered this build, if it
@@ -1806,85 +1893,6 @@
"tags": [ # Tags for annotation of a `Build`. These are not docker tags.
"A String",
],
- "substitutions": { # Substitutions data for `Build` resource.
- "a_key": "A String",
- },
- "startTime": "A String", # Output only. Time at which execution of the build was started.
- "timing": { # Output only. Stores timing information for phases of the build. Valid keys
- # are:
- #
- # * BUILD: time to execute all build steps
- # * PUSH: time to push all specified images.
- # * FETCHSOURCE: time to fetch source.
- #
- # If the build does not specify source or images,
- # these keys will not be included.
- "a_key": { # Start and end times for a build execution phase.
- "endTime": "A String", # End of time span.
- "startTime": "A String", # Start of time span.
- },
- },
- "sourceProvenance": { # Provenance of the source. Ways to find the original source, or verify that # Output only. A permanent fixed identifier for source.
- # some source was used for this build.
- "resolvedRepoSource": { # Location of the source in a Google Cloud Source Repository. # A copy of the build's `source.repo_source`, if exists, with any
- # revisions resolved.
- "commitSha": "A String", # Explicit commit SHA to build.
- "substitutions": { # Substitutions to use in a triggered build.
- # Should only be used with RunBuildTrigger
- "a_key": "A String",
- },
- "invertRegex": True or False, # Only trigger a build if the revision regex does NOT match the revision
- # regex.
- "dir": "A String", # Directory, relative to the source root, in which to run the build.
- #
- # This must be a relative path. If a step's `dir` is specified and is an
- # absolute path, this value is ignored for that step's execution.
- "branchName": "A String", # Regex matching branches to build.
- #
- # The syntax of the regular expressions accepted is the syntax accepted by
- # RE2 and described at https://github.com/google/re2/wiki/Syntax
- "tagName": "A String", # Regex matching tags to build.
- #
- # The syntax of the regular expressions accepted is the syntax accepted by
- # RE2 and described at https://github.com/google/re2/wiki/Syntax
- "projectId": "A String", # ID of the project that owns the Cloud Source Repository. If omitted, the
- # project ID requesting the build is assumed.
- "repoName": "A String", # Required. Name of the Cloud Source Repository.
- },
- "resolvedStorageSource": { # Location of the source in an archive file in Google Cloud Storage. # A copy of the build's `source.storage_source`, if exists, with any
- # generations resolved.
- "generation": "A String", # Google Cloud Storage generation for the object. If the generation is
- # omitted, the latest generation will be used.
- "bucket": "A String", # Google Cloud Storage bucket containing the source (see
- # [Bucket Name
- # Requirements](https://cloud.google.com/storage/docs/bucket-naming#requirements)).
- "object": "A String", # Google Cloud Storage object containing the source.
- #
- # This object must be a gzipped archive file (`.tar.gz`) containing source to
- # build.
- },
- "fileHashes": { # Output only. Hash(es) of the build source, which can be used to verify that
- # the original source integrity was maintained in the build. Note that
- # `FileHashes` will only be populated if `BuildOptions` has requested a
- # `SourceProvenanceHash`.
- #
- # The keys to this map are file paths used as build source and the values
- # contain the hash values for those files.
- #
- # If the build source came in a single package such as a gzipped tarfile
- # (`.tar.gz`), the `FileHash` will be for the single path to that file.
- "a_key": { # Container message for hashes of byte content of files, used in
- # SourceProvenance messages to verify integrity of source input to the build.
- "fileHash": [ # Collection of file hashes.
- { # Container message for hash values.
- "value": "A String", # The hash value.
- "type": "A String", # The type of hash that was performed.
- },
- ],
- },
- },
- },
- "createTime": "A String", # Output only. Time at which the request to create the build was received.
},
],
}</pre>
@@ -1953,6 +1961,33 @@
{ # This resource represents a long-running operation that is the result of a
# network API call.
+ "name": "A String", # 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}`.
+ "error": { # The `Status` type defines a logical error model that is suitable for # The error result of the operation in case of failure or cancellation.
+ # 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).
+ "message": "A String", # 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.
+ "details": [ # A list of messages that carry the error details. There is a common set of
+ # message types for APIs to use.
+ {
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
+ ],
+ "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+ },
+ "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.
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
"done": True or False, # 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.
@@ -1966,33 +2001,6 @@
# `TakeSnapshotResponse`.
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
- "name": "A String", # 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}`.
- "error": { # The `Status` type defines a logical error model that is suitable for # The error result of the operation in case of failure or cancellation.
- # 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).
- "code": 42, # The status code, which should be an enum value of google.rpc.Code.
- "message": "A String", # 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.
- "details": [ # A list of messages that carry the error details. There is a common set of
- # message types for APIs to use.
- {
- "a_key": "", # Properties of the object. Contains field @type with type URL.
- },
- ],
- },
- "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.
- "a_key": "", # Properties of the object. Contains field @type with type URL.
- },
}</pre>
</div>