Update docs (#291)
diff --git a/docs/dyn/cloudbuild_v1.projects.builds.html b/docs/dyn/cloudbuild_v1.projects.builds.html
index 5c40535..1ab68eb 100644
--- a/docs/dyn/cloudbuild_v1.projects.builds.html
+++ b/docs/dyn/cloudbuild_v1.projects.builds.html
@@ -84,7 +84,7 @@
<code><a href="#get">get(projectId, id, x__xgafv=None)</a></code></p>
<p class="firstline">Returns information about a previously requested build.</p>
<p class="toc_element">
- <code><a href="#list">list(projectId, pageSize=None, pageToken=None, x__xgafv=None)</a></code></p>
+ <code><a href="#list">list(projectId, pageSize=None, filter=None, pageToken=None, x__xgafv=None)</a></code></p>
<p class="firstline">Lists previously requested builds.</p>
<p class="toc_element">
<code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
@@ -116,6 +116,17 @@
# At a high level, a Build describes where to find source code, how to build
# it (for example, the builder image to run on the source), and what tag to
# apply to the built image when it is pushed to Google Container Registry.
+ #
+ # Fields can include the following variables which will be expanded when the
+ # build is created:
+ #
+ # - $PROJECT_ID: the project ID of the build.
+ # - $BUILD_ID: the autogenerated ID of the build.
+ # - $REPO_NAME: the source repository name specified by RepoSource.
+ # - $BRANCH_NAME: the branch name specified by RepoSource.
+ # - $TAG_NAME: the tag name specified by RepoSource.
+ # - $REVISION_ID or $COMMIT_SHA: the commit SHA specified by RepoSource or
+ # resolved from the specified branch or tag.
"status": "A String", # Status of the build.
# @OutputOnly
"finishTime": "A String", # Time at which execution of the build was finished.
@@ -184,12 +195,35 @@
# successfully.
"A String",
],
- "name": "A String", # Name of the container image to use for creating this stage in the
- # pipeline, as presented to `docker pull`.
- "args": [ # Command-line arguments to use when running this step's container.
+ "name": "A String", # The name of the container image that will run this particular build step.
+ #
+ # If the image is already available in the host's
+ # Docker daemon's cache, it will be run directly. If not, the host will
+ # attempt to pull the image first, using the builder service account's
+ # credentials if necessary.
+ #
+ # The Docker daemon's cache will already have the latest versions of all of
+ # the officially supported build steps
+ # (https://github.com/GoogleCloudPlatform/cloud-builders). The Docker daemon
+ # will also have cached many of the layers for some popular images, like
+ # "ubuntu", "debian", but they will be refreshed at the time you attempt to
+ # use them.
+ #
+ # 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.
+ "args": [ # A list of arguments that will be presented to the step when it is started.
+ #
+ # If the image used to run the step's container has an entrypoint, these args
+ # will be used as arguments to that entrypoint. If the image does not define
+ # an entrypoint, the first element in args will be used as the entrypoint,
+ # and the remainder will be used as arguments.
"A String",
],
- "env": [ # Additional environment variables to set for this step's container.
+ "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",
],
"id": "A String", # Optional unique identifier for this build step, used in wait_for to
@@ -247,14 +281,20 @@
},
"projectId": "A String", # ID of the project.
# @OutputOnly.
- "images": [ # List of images expected to be built and pushed to Google Container
- # Registry. If an image is listed here and the image is not produced by
- # one of the build steps, the build will fail. Any images present when
- # the build steps are complete will be pushed to Container Registry.
+ "images": [ # A list of images to be pushed upon the successful completion of all build
+ # steps.
+ #
+ # The images will be pushed using the builder
+ # service account's credentials.
+ #
+ # The digests of the pushed images will be stored in the Build resource's
+ # results field.
+ #
+ # If any of the images fail to be pushed, the build is marked FAILURE.
"A String",
],
"options": { # Optional arguments to enable specific features of builds. # Special options for this build.
- "requestedVerifyOption": "A String", # Options for a verifiable build with details uploaded to the Analysis API.
+ "requestedVerifyOption": "A String", # Requested verifiability options.
"sourceProvenanceHash": [ # Requested hash for SourceProvenance.
"A String",
],
@@ -282,6 +322,17 @@
# At a high level, a Build describes where to find source code, how to build
# it (for example, the builder image to run on the source), and what tag to
# apply to the built image when it is pushed to Google Container Registry.
+ #
+ # Fields can include the following variables which will be expanded when the
+ # build is created:
+ #
+ # - $PROJECT_ID: the project ID of the build.
+ # - $BUILD_ID: the autogenerated ID of the build.
+ # - $REPO_NAME: the source repository name specified by RepoSource.
+ # - $BRANCH_NAME: the branch name specified by RepoSource.
+ # - $TAG_NAME: the tag name specified by RepoSource.
+ # - $REVISION_ID or $COMMIT_SHA: the commit SHA specified by RepoSource or
+ # resolved from the specified branch or tag.
"status": "A String", # Status of the build.
# @OutputOnly
"finishTime": "A String", # Time at which execution of the build was finished.
@@ -350,12 +401,35 @@
# successfully.
"A String",
],
- "name": "A String", # Name of the container image to use for creating this stage in the
- # pipeline, as presented to `docker pull`.
- "args": [ # Command-line arguments to use when running this step's container.
+ "name": "A String", # The name of the container image that will run this particular build step.
+ #
+ # If the image is already available in the host's
+ # Docker daemon's cache, it will be run directly. If not, the host will
+ # attempt to pull the image first, using the builder service account's
+ # credentials if necessary.
+ #
+ # The Docker daemon's cache will already have the latest versions of all of
+ # the officially supported build steps
+ # (https://github.com/GoogleCloudPlatform/cloud-builders). The Docker daemon
+ # will also have cached many of the layers for some popular images, like
+ # "ubuntu", "debian", but they will be refreshed at the time you attempt to
+ # use them.
+ #
+ # 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.
+ "args": [ # A list of arguments that will be presented to the step when it is started.
+ #
+ # If the image used to run the step's container has an entrypoint, these args
+ # will be used as arguments to that entrypoint. If the image does not define
+ # an entrypoint, the first element in args will be used as the entrypoint,
+ # and the remainder will be used as arguments.
"A String",
],
- "env": [ # Additional environment variables to set for this step's container.
+ "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",
],
"id": "A String", # Optional unique identifier for this build step, used in wait_for to
@@ -413,14 +487,20 @@
},
"projectId": "A String", # ID of the project.
# @OutputOnly.
- "images": [ # List of images expected to be built and pushed to Google Container
- # Registry. If an image is listed here and the image is not produced by
- # one of the build steps, the build will fail. Any images present when
- # the build steps are complete will be pushed to Container Registry.
+ "images": [ # A list of images to be pushed upon the successful completion of all build
+ # steps.
+ #
+ # The images will be pushed using the builder
+ # service account's credentials.
+ #
+ # The digests of the pushed images will be stored in the Build resource's
+ # results field.
+ #
+ # If any of the images fail to be pushed, the build is marked FAILURE.
"A String",
],
"options": { # Optional arguments to enable specific features of builds. # Special options for this build.
- "requestedVerifyOption": "A String", # Options for a verifiable build with details uploaded to the Analysis API.
+ "requestedVerifyOption": "A String", # Requested verifiability options.
"sourceProvenanceHash": [ # Requested hash for SourceProvenance.
"A String",
],
@@ -461,7 +541,7 @@
"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 have the format of `operations/some/unique/name`.
- "error": { # The `Status` type defines a logical error model that is suitable for different # The error result of the operation in case of failure.
+ "error": { # The `Status` type defines a logical error model that is suitable for different # The error result of the operation in case of failure or cancellation.
# programming environments, including REST APIs and RPC APIs. It is used by
# [gRPC](https://github.com/grpc). The error model is designed to be:
#
@@ -550,6 +630,17 @@
# At a high level, a Build describes where to find source code, how to build
# it (for example, the builder image to run on the source), and what tag to
# apply to the built image when it is pushed to Google Container Registry.
+ #
+ # Fields can include the following variables which will be expanded when the
+ # build is created:
+ #
+ # - $PROJECT_ID: the project ID of the build.
+ # - $BUILD_ID: the autogenerated ID of the build.
+ # - $REPO_NAME: the source repository name specified by RepoSource.
+ # - $BRANCH_NAME: the branch name specified by RepoSource.
+ # - $TAG_NAME: the tag name specified by RepoSource.
+ # - $REVISION_ID or $COMMIT_SHA: the commit SHA specified by RepoSource or
+ # resolved from the specified branch or tag.
"status": "A String", # Status of the build.
# @OutputOnly
"finishTime": "A String", # Time at which execution of the build was finished.
@@ -618,12 +709,35 @@
# successfully.
"A String",
],
- "name": "A String", # Name of the container image to use for creating this stage in the
- # pipeline, as presented to `docker pull`.
- "args": [ # Command-line arguments to use when running this step's container.
+ "name": "A String", # The name of the container image that will run this particular build step.
+ #
+ # If the image is already available in the host's
+ # Docker daemon's cache, it will be run directly. If not, the host will
+ # attempt to pull the image first, using the builder service account's
+ # credentials if necessary.
+ #
+ # The Docker daemon's cache will already have the latest versions of all of
+ # the officially supported build steps
+ # (https://github.com/GoogleCloudPlatform/cloud-builders). The Docker daemon
+ # will also have cached many of the layers for some popular images, like
+ # "ubuntu", "debian", but they will be refreshed at the time you attempt to
+ # use them.
+ #
+ # 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.
+ "args": [ # A list of arguments that will be presented to the step when it is started.
+ #
+ # If the image used to run the step's container has an entrypoint, these args
+ # will be used as arguments to that entrypoint. If the image does not define
+ # an entrypoint, the first element in args will be used as the entrypoint,
+ # and the remainder will be used as arguments.
"A String",
],
- "env": [ # Additional environment variables to set for this step's container.
+ "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",
],
"id": "A String", # Optional unique identifier for this build step, used in wait_for to
@@ -681,14 +795,20 @@
},
"projectId": "A String", # ID of the project.
# @OutputOnly.
- "images": [ # List of images expected to be built and pushed to Google Container
- # Registry. If an image is listed here and the image is not produced by
- # one of the build steps, the build will fail. Any images present when
- # the build steps are complete will be pushed to Container Registry.
+ "images": [ # A list of images to be pushed upon the successful completion of all build
+ # steps.
+ #
+ # The images will be pushed using the builder
+ # service account's credentials.
+ #
+ # The digests of the pushed images will be stored in the Build resource's
+ # results field.
+ #
+ # If any of the images fail to be pushed, the build is marked FAILURE.
"A String",
],
"options": { # Optional arguments to enable specific features of builds. # Special options for this build.
- "requestedVerifyOption": "A String", # Options for a verifiable build with details uploaded to the Analysis API.
+ "requestedVerifyOption": "A String", # Requested verifiability options.
"sourceProvenanceHash": [ # Requested hash for SourceProvenance.
"A String",
],
@@ -699,7 +819,7 @@
</div>
<div class="method">
- <code class="details" id="list">list(projectId, pageSize=None, pageToken=None, x__xgafv=None)</code>
+ <code class="details" id="list">list(projectId, pageSize=None, filter=None, pageToken=None, x__xgafv=None)</code>
<pre>Lists previously requested builds.
Previously requested builds may still be in-progress, or may have finished
@@ -708,6 +828,7 @@
Args:
projectId: string, ID of the project. (required)
pageSize: integer, Number of results to return in the list.
+ filter: string, The raw filter text to constrain the results.
pageToken: string, Token to provide to skip to a particular spot in the list.
x__xgafv: string, V1 error format.
Allowed values
@@ -725,6 +846,17 @@
# At a high level, a Build describes where to find source code, how to build
# it (for example, the builder image to run on the source), and what tag to
# apply to the built image when it is pushed to Google Container Registry.
+ #
+ # Fields can include the following variables which will be expanded when the
+ # build is created:
+ #
+ # - $PROJECT_ID: the project ID of the build.
+ # - $BUILD_ID: the autogenerated ID of the build.
+ # - $REPO_NAME: the source repository name specified by RepoSource.
+ # - $BRANCH_NAME: the branch name specified by RepoSource.
+ # - $TAG_NAME: the tag name specified by RepoSource.
+ # - $REVISION_ID or $COMMIT_SHA: the commit SHA specified by RepoSource or
+ # resolved from the specified branch or tag.
"status": "A String", # Status of the build.
# @OutputOnly
"finishTime": "A String", # Time at which execution of the build was finished.
@@ -793,12 +925,35 @@
# successfully.
"A String",
],
- "name": "A String", # Name of the container image to use for creating this stage in the
- # pipeline, as presented to `docker pull`.
- "args": [ # Command-line arguments to use when running this step's container.
+ "name": "A String", # The name of the container image that will run this particular build step.
+ #
+ # If the image is already available in the host's
+ # Docker daemon's cache, it will be run directly. If not, the host will
+ # attempt to pull the image first, using the builder service account's
+ # credentials if necessary.
+ #
+ # The Docker daemon's cache will already have the latest versions of all of
+ # the officially supported build steps
+ # (https://github.com/GoogleCloudPlatform/cloud-builders). The Docker daemon
+ # will also have cached many of the layers for some popular images, like
+ # "ubuntu", "debian", but they will be refreshed at the time you attempt to
+ # use them.
+ #
+ # 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.
+ "args": [ # A list of arguments that will be presented to the step when it is started.
+ #
+ # If the image used to run the step's container has an entrypoint, these args
+ # will be used as arguments to that entrypoint. If the image does not define
+ # an entrypoint, the first element in args will be used as the entrypoint,
+ # and the remainder will be used as arguments.
"A String",
],
- "env": [ # Additional environment variables to set for this step's container.
+ "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",
],
"id": "A String", # Optional unique identifier for this build step, used in wait_for to
@@ -856,14 +1011,20 @@
},
"projectId": "A String", # ID of the project.
# @OutputOnly.
- "images": [ # List of images expected to be built and pushed to Google Container
- # Registry. If an image is listed here and the image is not produced by
- # one of the build steps, the build will fail. Any images present when
- # the build steps are complete will be pushed to Container Registry.
+ "images": [ # A list of images to be pushed upon the successful completion of all build
+ # steps.
+ #
+ # The images will be pushed using the builder
+ # service account's credentials.
+ #
+ # The digests of the pushed images will be stored in the Build resource's
+ # results field.
+ #
+ # If any of the images fail to be pushed, the build is marked FAILURE.
"A String",
],
"options": { # Optional arguments to enable specific features of builds. # Special options for this build.
- "requestedVerifyOption": "A String", # Options for a verifiable build with details uploaded to the Analysis API.
+ "requestedVerifyOption": "A String", # Requested verifiability options.
"sourceProvenanceHash": [ # Requested hash for SourceProvenance.
"A String",
],