docs/dyn/cloudbuild_v1.projects.builds.html

<html><body>
<style>

body, h1, h2, h3, div, span, p, pre, a {
  margin: 0;
  padding: 0;
  border: 0;
  font-weight: inherit;
  font-style: inherit;
  font-size: 100%;
  font-family: inherit;
  vertical-align: baseline;
}

body {
  font-size: 13px;
  padding: 1em;
}

h1 {
  font-size: 26px;
  margin-bottom: 1em;
}

h2 {
  font-size: 24px;
  margin-bottom: 1em;
}

h3 {
  font-size: 20px;
  margin-bottom: 1em;
  margin-top: 1em;
}

pre, code {
  line-height: 1.5;
  font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
}

pre {
  margin-top: 0.5em;
}

h1, h2, h3, p {
  font-family: Arial, sans serif;
}

h1, h2, h3 {
  border-bottom: solid #CCC 1px;
}

.toc_element {
  margin-top: 0.5em;
}

.firstline {
  margin-left: 2 em;
}

.method  {
  margin-top: 1em;
  border: solid 1px #CCC;
  padding: 1em;
  background: #EEE;
}

.details {
  font-weight: bold;
  font-size: 14px;
}

</style>

<h1><a href="cloudbuild_v1.html">Google Cloud Container Builder API</a> . <a href="cloudbuild_v1.projects.html">projects</a> . <a href="cloudbuild_v1.projects.builds.html">builds</a></h1>
<h2>Instance Methods</h2>
<p class="toc_element">
  <code><a href="#cancel">cancel(projectId, id, body, x__xgafv=None)</a></code></p>
<p class="firstline">Cancels a requested build in progress.</p>
<p class="toc_element">
  <code><a href="#create">create(projectId, body, x__xgafv=None)</a></code></p>
<p class="firstline">Starts a build with the specified configuration.</p>
<p class="toc_element">
  <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, 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>
<p class="firstline">Retrieves the next page of results.</p>
<h3>Method Details</h3>
<div class="method">
    <code class="details" id="cancel">cancel(projectId, id, body, x__xgafv=None)</code>
  <pre>Cancels a requested build in progress.

Args:
  projectId: string, ID of the project. (required)
  id: string, ID of the build. (required)
  body: object, The request body. (required)
    The object takes the form of:

{ # Request to cancel an ongoing build.
  }

  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # A build resource in the Container Builder API.
      #
      # 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.
    "finishTime": "A String", # Time at which execution of the build was finished.
        #
        # The difference between finish_time and start_time is the duration of the
        # build's execution.
        # @OutputOnly
    "status": "A String", # Status of the build.
        # @OutputOnly
    "startTime": "A String", # Time at which execution of the build was started.
        # @OutputOnly
    "statusDetail": "A String", # Customer-readable message about the current status.
        # @OutputOnly
    "tags": [ # Tags for annotation of a Build. These are not docker tags.
      "A String",
    ],
    "projectId": "A String", # ID of the project.
        # @OutputOnly.
    "id": "A String", # Unique identifier of the build.
        # @OutputOnly
    "results": { # Results describes the artifacts created by the build pipeline. # Results of the build.
        # @OutputOnly
      "images": [ # Images that were built as a part of the build.
        { # BuiltImage describes an image built by the pipeline.
          "name": "A String", # Name used to push the container image to Google Container Registry, as
              # presented to `docker push`.
          "digest": "A String", # Docker Registry 2.0 digest.
        },
      ],
      "buildStepImages": [ # List of build step digests, in order corresponding to build step indices.
        "A String",
      ],
    },
    "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.
        #
        # Default time is ten minutes.
    "substitutions": { # Substitutions data for Build resource.
      "a_key": "A String",
    },
    "source": { # Source describes the location of the source in a supported storage # Describes where to find the source files to build.
        # service.
      "repoSource": { # RepoSource describes the location of the source in a Google Cloud Source # If provided, get source from this location in a Cloud Repo.
          # Repository.
        "projectId": "A String", # ID of the project that owns the repo. If omitted, the project ID requesting
            # the build is assumed.
        "branchName": "A String", # Name of the branch to build.
        "commitSha": "A String", # Explicit commit SHA to build.
        "tagName": "A String", # Name of the tag to build.
        "repoName": "A String", # Name of the repo. If omitted, the name "default" is assumed.
      },
      "storageSource": { # StorageSource describes the location of the source in an archive file in # If provided, get the source from this location in in Google Cloud
          # Storage.
          # Google Cloud Storage.
        "generation": "A String", # Google Cloud Storage generation for the object. If the generation is
            # omitted, the latest generation will be used.
        "object": "A String", # Google Cloud Storage object containing source.
            #
            # This object must be a gzipped archive file (.tar.gz) containing source to
            # build.
        "bucket": "A String", # Google Cloud Storage bucket containing source (see
            # [Bucket Name
            # Requirements](https://cloud.google.com/storage/docs/bucket-naming#requirements)).
      },
    },
    "buildTriggerId": "A String", # The ID of the BuildTrigger that triggered this build, if it was
        # triggered automatically.
        # @OutputOnly
    "options": { # Optional arguments to enable specific features of builds. # Special options for this build.
      "requestedVerifyOption": "A String", # Requested verifiability options.
      "sourceProvenanceHash": [ # Requested hash for SourceProvenance.
        "A String",
      ],
    },
    "steps": [ # Describes the operations to be performed on the workspace.
      { # BuildStep describes a step to perform in the build pipeline.
        "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
            # start when all previous build steps in the Build.Steps list have completed
            # successfully.
          "A String",
        ],
        "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](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",
        ],
        "entrypoint": "A String", # Optional entrypoint to be used instead of the build step image's default
            # If unset, the image's default will be used.
        "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
            # reference this build step as a dependency.
        "dir": "A String", # Working directory (relative to project source root) to use when running
            # this operation's container.
      },
    ],
    "sourceProvenance": { # Provenance of the source. Ways to find the original source, or verify that # A permanent fixed identifier for source.
        # @OutputOnly
        # some source was used for this build.
      "resolvedRepoSource": { # RepoSource describes the location of the source in a Google Cloud Source # A copy of the build's source.repo_source, if exists, with any
          # revisions resolved.
          # Repository.
        "projectId": "A String", # ID of the project that owns the repo. If omitted, the project ID requesting
            # the build is assumed.
        "branchName": "A String", # Name of the branch to build.
        "commitSha": "A String", # Explicit commit SHA to build.
        "tagName": "A String", # Name of the tag to build.
        "repoName": "A String", # Name of the repo. If omitted, the name "default" is assumed.
      },
      "fileHashes": { # 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.
          # @OutputOnly
        "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.
            },
          ],
        },
      },
      "resolvedStorageSource": { # StorageSource describes the location of the source in an archive file in # A copy of the build's source.storage_source, if exists, with any
          # generations resolved.
          # Google Cloud Storage.
        "generation": "A String", # Google Cloud Storage generation for the object. If the generation is
            # omitted, the latest generation will be used.
        "object": "A String", # Google Cloud Storage object containing source.
            #
            # This object must be a gzipped archive file (.tar.gz) containing source to
            # build.
        "bucket": "A String", # Google Cloud Storage bucket containing source (see
            # [Bucket Name
            # Requirements](https://cloud.google.com/storage/docs/bucket-naming#requirements)).
      },
    },
    "logsBucket": "A String", # Google Cloud Storage bucket where logs should be written (see
        # [Bucket Name
        # Requirements](https://cloud.google.com/storage/docs/bucket-naming#requirements)).
        # Logs file names will be of the format `${logs_bucket}/log-${build_id}.txt`.
    "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",
    ],
    "createTime": "A String", # Time at which the request to create the build was received.
        # @OutputOnly
    "logUrl": "A String", # URL to logs for this build in Google Cloud Logging.
        # @OutputOnly
  }</pre>
</div>

<div class="method">
    <code class="details" id="create">create(projectId, body, x__xgafv=None)</code>
  <pre>Starts a build with the specified configuration.

The long-running Operation returned by this method will include the ID of
the build, which can be passed to GetBuild to determine its status (e.g.,
success or failure).

Args:
  projectId: string, ID of the project. (required)
  body: object, The request body. (required)
    The object takes the form of:

{ # A build resource in the Container Builder API.
    # 
    # 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.
  "finishTime": "A String", # Time at which execution of the build was finished.
      # 
      # The difference between finish_time and start_time is the duration of the
      # build's execution.
      # @OutputOnly
  "status": "A String", # Status of the build.
      # @OutputOnly
  "startTime": "A String", # Time at which execution of the build was started.
      # @OutputOnly
  "statusDetail": "A String", # Customer-readable message about the current status.
      # @OutputOnly
  "tags": [ # Tags for annotation of a Build. These are not docker tags.
    "A String",
  ],
  "projectId": "A String", # ID of the project.
      # @OutputOnly.
  "id": "A String", # Unique identifier of the build.
      # @OutputOnly
  "results": { # Results describes the artifacts created by the build pipeline. # Results of the build.
      # @OutputOnly
    "images": [ # Images that were built as a part of the build.
      { # BuiltImage describes an image built by the pipeline.
        "name": "A String", # Name used to push the container image to Google Container Registry, as
            # presented to `docker push`.
        "digest": "A String", # Docker Registry 2.0 digest.
      },
    ],
    "buildStepImages": [ # List of build step digests, in order corresponding to build step indices.
      "A String",
    ],
  },
  "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.
      # 
      # Default time is ten minutes.
  "substitutions": { # Substitutions data for Build resource.
    "a_key": "A String",
  },
  "source": { # Source describes the location of the source in a supported storage # Describes where to find the source files to build.
      # service.
    "repoSource": { # RepoSource describes the location of the source in a Google Cloud Source # If provided, get source from this location in a Cloud Repo.
        # Repository.
      "projectId": "A String", # ID of the project that owns the repo. If omitted, the project ID requesting
          # the build is assumed.
      "branchName": "A String", # Name of the branch to build.
      "commitSha": "A String", # Explicit commit SHA to build.
      "tagName": "A String", # Name of the tag to build.
      "repoName": "A String", # Name of the repo. If omitted, the name "default" is assumed.
    },
    "storageSource": { # StorageSource describes the location of the source in an archive file in # If provided, get the source from this location in in Google Cloud
        # Storage.
        # Google Cloud Storage.
      "generation": "A String", # Google Cloud Storage generation for the object. If the generation is
          # omitted, the latest generation will be used.
      "object": "A String", # Google Cloud Storage object containing source.
          #
          # This object must be a gzipped archive file (.tar.gz) containing source to
          # build.
      "bucket": "A String", # Google Cloud Storage bucket containing source (see
          # [Bucket Name
          # Requirements](https://cloud.google.com/storage/docs/bucket-naming#requirements)).
    },
  },
  "buildTriggerId": "A String", # The ID of the BuildTrigger that triggered this build, if it was
      # triggered automatically.
      # @OutputOnly
  "options": { # Optional arguments to enable specific features of builds. # Special options for this build.
    "requestedVerifyOption": "A String", # Requested verifiability options.
    "sourceProvenanceHash": [ # Requested hash for SourceProvenance.
      "A String",
    ],
  },
  "steps": [ # Describes the operations to be performed on the workspace.
    { # BuildStep describes a step to perform in the build pipeline.
      "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
          # start when all previous build steps in the Build.Steps list have completed
          # successfully.
        "A String",
      ],
      "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](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",
      ],
      "entrypoint": "A String", # Optional entrypoint to be used instead of the build step image's default
          # If unset, the image's default will be used.
      "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
          # reference this build step as a dependency.
      "dir": "A String", # Working directory (relative to project source root) to use when running
          # this operation's container.
    },
  ],
  "sourceProvenance": { # Provenance of the source. Ways to find the original source, or verify that # A permanent fixed identifier for source.
      # @OutputOnly
      # some source was used for this build.
    "resolvedRepoSource": { # RepoSource describes the location of the source in a Google Cloud Source # A copy of the build's source.repo_source, if exists, with any
        # revisions resolved.
        # Repository.
      "projectId": "A String", # ID of the project that owns the repo. If omitted, the project ID requesting
          # the build is assumed.
      "branchName": "A String", # Name of the branch to build.
      "commitSha": "A String", # Explicit commit SHA to build.
      "tagName": "A String", # Name of the tag to build.
      "repoName": "A String", # Name of the repo. If omitted, the name "default" is assumed.
    },
    "fileHashes": { # 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.
        # @OutputOnly
      "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.
          },
        ],
      },
    },
    "resolvedStorageSource": { # StorageSource describes the location of the source in an archive file in # A copy of the build's source.storage_source, if exists, with any
        # generations resolved.
        # Google Cloud Storage.
      "generation": "A String", # Google Cloud Storage generation for the object. If the generation is
          # omitted, the latest generation will be used.
      "object": "A String", # Google Cloud Storage object containing source.
          #
          # This object must be a gzipped archive file (.tar.gz) containing source to
          # build.
      "bucket": "A String", # Google Cloud Storage bucket containing source (see
          # [Bucket Name
          # Requirements](https://cloud.google.com/storage/docs/bucket-naming#requirements)).
    },
  },
  "logsBucket": "A String", # Google Cloud Storage bucket where logs should be written (see
      # [Bucket Name
      # Requirements](https://cloud.google.com/storage/docs/bucket-naming#requirements)).
      # Logs file names will be of the format `${logs_bucket}/log-${build_id}.txt`.
  "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",
  ],
  "createTime": "A String", # Time at which the request to create the build was received.
      # @OutputOnly
  "logUrl": "A String", # URL to logs for this build in Google Cloud Logging.
      # @OutputOnly
}

  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # This resource represents a long-running operation that is the result of a
      # network API call.
    "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:
        #
        # - Simple to use and understand for most users
        # - Flexible enough to meet unexpected needs
        #
        # # Overview
        #
        # The `Status` message contains three pieces of data: error code, error message,
        # and error details. The error code should be an enum value of
        # google.rpc.Code, but it may accept additional error codes if needed.  The
        # error message should be a developer-facing English message that helps
        # developers *understand* and *resolve* the error. If a localized user-facing
        # error message is needed, put the localized message in the error details or
        # localize it in the client. The optional error details may contain arbitrary
        # information about the error. There is a predefined set of error detail types
        # in the package `google.rpc` that can be used for common error conditions.
        #
        # # Language mapping
        #
        # The `Status` message is the logical representation of the error model, but it
        # is not necessarily the actual wire format. When the `Status` message is
        # exposed in different client libraries and different wire protocols, it can be
        # mapped differently. For example, it will likely be mapped to some exceptions
        # in Java, but more likely mapped to some error codes in C.
        #
        # # Other uses
        #
        # The error model and the `Status` message can be used in a variety of
        # environments, either with or without APIs, to provide a
        # consistent developer experience across different environments.
        #
        # Example uses of this error model include:
        #
        # - Partial errors. If a service needs to return partial errors to the client,
        #     it may embed the `Status` in the normal response to indicate the partial
        #     errors.
        #
        # - Workflow errors. A typical workflow has multiple steps. Each step may
        #     have a `Status` message for error reporting.
        #
        # - Batch operations. If a client uses batch request and batch response, the
        #     `Status` message should be used directly inside batch response, one for
        #     each error sub-response.
        #
        # - Asynchronous operations. If an API call embeds asynchronous operation
        #     results in its response, the status of those operations should be
        #     represented directly using the `Status` message.
        #
        # - Logging. If some API errors are stored in logs, the message `Status` could
        #     be used directly after any stripping needed for security/privacy reasons.
      "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.
      "code": 42, # The status code, which should be an enum value of google.rpc.Code.
      "details": [ # A list of messages that carry the error details.  There will be a
          # common set of message types for APIs to use.
        {
          "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.
    "response": { # The normal response of the operation in case of success.  If the original
        # method returns no data on success, such as `Delete`, the response is
        # `google.protobuf.Empty`.  If the original method is standard
        # `Get`/`Create`/`Update`, the response should be the resource.  For other
        # methods, the response should have the type `XxxResponse`, where `Xxx`
        # is the original method name.  For example, if the original method name
        # is `TakeSnapshot()`, the inferred response type is
        # `TakeSnapshotResponse`.
      "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 have the format of `operations/some/unique/name`.
    "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>

<div class="method">
    <code class="details" id="get">get(projectId, id, x__xgafv=None)</code>
  <pre>Returns information about a previously requested build.

The Build that is returned includes its status (e.g., success or failure,
or in-progress), and timing information.

Args:
  projectId: string, ID of the project. (required)
  id: string, ID of the build. (required)
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # A build resource in the Container Builder API.
      #
      # 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.
    "finishTime": "A String", # Time at which execution of the build was finished.
        #
        # The difference between finish_time and start_time is the duration of the
        # build's execution.
        # @OutputOnly
    "status": "A String", # Status of the build.
        # @OutputOnly
    "startTime": "A String", # Time at which execution of the build was started.
        # @OutputOnly
    "statusDetail": "A String", # Customer-readable message about the current status.
        # @OutputOnly
    "tags": [ # Tags for annotation of a Build. These are not docker tags.
      "A String",
    ],
    "projectId": "A String", # ID of the project.
        # @OutputOnly.
    "id": "A String", # Unique identifier of the build.
        # @OutputOnly
    "results": { # Results describes the artifacts created by the build pipeline. # Results of the build.
        # @OutputOnly
      "images": [ # Images that were built as a part of the build.
        { # BuiltImage describes an image built by the pipeline.
          "name": "A String", # Name used to push the container image to Google Container Registry, as
              # presented to `docker push`.
          "digest": "A String", # Docker Registry 2.0 digest.
        },
      ],
      "buildStepImages": [ # List of build step digests, in order corresponding to build step indices.
        "A String",
      ],
    },
    "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.
        #
        # Default time is ten minutes.
    "substitutions": { # Substitutions data for Build resource.
      "a_key": "A String",
    },
    "source": { # Source describes the location of the source in a supported storage # Describes where to find the source files to build.
        # service.
      "repoSource": { # RepoSource describes the location of the source in a Google Cloud Source # If provided, get source from this location in a Cloud Repo.
          # Repository.
        "projectId": "A String", # ID of the project that owns the repo. If omitted, the project ID requesting
            # the build is assumed.
        "branchName": "A String", # Name of the branch to build.
        "commitSha": "A String", # Explicit commit SHA to build.
        "tagName": "A String", # Name of the tag to build.
        "repoName": "A String", # Name of the repo. If omitted, the name "default" is assumed.
      },
      "storageSource": { # StorageSource describes the location of the source in an archive file in # If provided, get the source from this location in in Google Cloud
          # Storage.
          # Google Cloud Storage.
        "generation": "A String", # Google Cloud Storage generation for the object. If the generation is
            # omitted, the latest generation will be used.
        "object": "A String", # Google Cloud Storage object containing source.
            #
            # This object must be a gzipped archive file (.tar.gz) containing source to
            # build.
        "bucket": "A String", # Google Cloud Storage bucket containing source (see
            # [Bucket Name
            # Requirements](https://cloud.google.com/storage/docs/bucket-naming#requirements)).
      },
    },
    "buildTriggerId": "A String", # The ID of the BuildTrigger that triggered this build, if it was
        # triggered automatically.
        # @OutputOnly
    "options": { # Optional arguments to enable specific features of builds. # Special options for this build.
      "requestedVerifyOption": "A String", # Requested verifiability options.
      "sourceProvenanceHash": [ # Requested hash for SourceProvenance.
        "A String",
      ],
    },
    "steps": [ # Describes the operations to be performed on the workspace.
      { # BuildStep describes a step to perform in the build pipeline.
        "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
            # start when all previous build steps in the Build.Steps list have completed
            # successfully.
          "A String",
        ],
        "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](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",
        ],
        "entrypoint": "A String", # Optional entrypoint to be used instead of the build step image's default
            # If unset, the image's default will be used.
        "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
            # reference this build step as a dependency.
        "dir": "A String", # Working directory (relative to project source root) to use when running
            # this operation's container.
      },
    ],
    "sourceProvenance": { # Provenance of the source. Ways to find the original source, or verify that # A permanent fixed identifier for source.
        # @OutputOnly
        # some source was used for this build.
      "resolvedRepoSource": { # RepoSource describes the location of the source in a Google Cloud Source # A copy of the build's source.repo_source, if exists, with any
          # revisions resolved.
          # Repository.
        "projectId": "A String", # ID of the project that owns the repo. If omitted, the project ID requesting
            # the build is assumed.
        "branchName": "A String", # Name of the branch to build.
        "commitSha": "A String", # Explicit commit SHA to build.
        "tagName": "A String", # Name of the tag to build.
        "repoName": "A String", # Name of the repo. If omitted, the name "default" is assumed.
      },
      "fileHashes": { # 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.
          # @OutputOnly
        "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.
            },
          ],
        },
      },
      "resolvedStorageSource": { # StorageSource describes the location of the source in an archive file in # A copy of the build's source.storage_source, if exists, with any
          # generations resolved.
          # Google Cloud Storage.
        "generation": "A String", # Google Cloud Storage generation for the object. If the generation is
            # omitted, the latest generation will be used.
        "object": "A String", # Google Cloud Storage object containing source.
            #
            # This object must be a gzipped archive file (.tar.gz) containing source to
            # build.
        "bucket": "A String", # Google Cloud Storage bucket containing source (see
            # [Bucket Name
            # Requirements](https://cloud.google.com/storage/docs/bucket-naming#requirements)).
      },
    },
    "logsBucket": "A String", # Google Cloud Storage bucket where logs should be written (see
        # [Bucket Name
        # Requirements](https://cloud.google.com/storage/docs/bucket-naming#requirements)).
        # Logs file names will be of the format `${logs_bucket}/log-${build_id}.txt`.
    "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",
    ],
    "createTime": "A String", # Time at which the request to create the build was received.
        # @OutputOnly
    "logUrl": "A String", # URL to logs for this build in Google Cloud Logging.
        # @OutputOnly
  }</pre>
</div>

<div class="method">
    <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
successfully or unsuccessfully.

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
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # Response including listed builds.
    "nextPageToken": "A String", # Token to receive the next page of results.
    "builds": [ # Builds will be sorted by create_time, descending.
      { # A build resource in the Container Builder API.
          #
          # 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.
        "finishTime": "A String", # Time at which execution of the build was finished.
            #
            # The difference between finish_time and start_time is the duration of the
            # build's execution.
            # @OutputOnly
        "status": "A String", # Status of the build.
            # @OutputOnly
        "startTime": "A String", # Time at which execution of the build was started.
            # @OutputOnly
        "statusDetail": "A String", # Customer-readable message about the current status.
            # @OutputOnly
        "tags": [ # Tags for annotation of a Build. These are not docker tags.
          "A String",
        ],
        "projectId": "A String", # ID of the project.
            # @OutputOnly.
        "id": "A String", # Unique identifier of the build.
            # @OutputOnly
        "results": { # Results describes the artifacts created by the build pipeline. # Results of the build.
            # @OutputOnly
          "images": [ # Images that were built as a part of the build.
            { # BuiltImage describes an image built by the pipeline.
              "name": "A String", # Name used to push the container image to Google Container Registry, as
                  # presented to `docker push`.
              "digest": "A String", # Docker Registry 2.0 digest.
            },
          ],
          "buildStepImages": [ # List of build step digests, in order corresponding to build step indices.
            "A String",
          ],
        },
        "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.
            #
            # Default time is ten minutes.
        "substitutions": { # Substitutions data for Build resource.
          "a_key": "A String",
        },
        "source": { # Source describes the location of the source in a supported storage # Describes where to find the source files to build.
            # service.
          "repoSource": { # RepoSource describes the location of the source in a Google Cloud Source # If provided, get source from this location in a Cloud Repo.
              # Repository.
            "projectId": "A String", # ID of the project that owns the repo. If omitted, the project ID requesting
                # the build is assumed.
            "branchName": "A String", # Name of the branch to build.
            "commitSha": "A String", # Explicit commit SHA to build.
            "tagName": "A String", # Name of the tag to build.
            "repoName": "A String", # Name of the repo. If omitted, the name "default" is assumed.
          },
          "storageSource": { # StorageSource describes the location of the source in an archive file in # If provided, get the source from this location in in Google Cloud
              # Storage.
              # Google Cloud Storage.
            "generation": "A String", # Google Cloud Storage generation for the object. If the generation is
                # omitted, the latest generation will be used.
            "object": "A String", # Google Cloud Storage object containing source.
                #
                # This object must be a gzipped archive file (.tar.gz) containing source to
                # build.
            "bucket": "A String", # Google Cloud Storage bucket containing source (see
                # [Bucket Name
                # Requirements](https://cloud.google.com/storage/docs/bucket-naming#requirements)).
          },
        },
        "buildTriggerId": "A String", # The ID of the BuildTrigger that triggered this build, if it was
            # triggered automatically.
            # @OutputOnly
        "options": { # Optional arguments to enable specific features of builds. # Special options for this build.
          "requestedVerifyOption": "A String", # Requested verifiability options.
          "sourceProvenanceHash": [ # Requested hash for SourceProvenance.
            "A String",
          ],
        },
        "steps": [ # Describes the operations to be performed on the workspace.
          { # BuildStep describes a step to perform in the build pipeline.
            "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
                # start when all previous build steps in the Build.Steps list have completed
                # successfully.
              "A String",
            ],
            "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](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",
            ],
            "entrypoint": "A String", # Optional entrypoint to be used instead of the build step image's default
                # If unset, the image's default will be used.
            "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
                # reference this build step as a dependency.
            "dir": "A String", # Working directory (relative to project source root) to use when running
                # this operation's container.
          },
        ],
        "sourceProvenance": { # Provenance of the source. Ways to find the original source, or verify that # A permanent fixed identifier for source.
            # @OutputOnly
            # some source was used for this build.
          "resolvedRepoSource": { # RepoSource describes the location of the source in a Google Cloud Source # A copy of the build's source.repo_source, if exists, with any
              # revisions resolved.
              # Repository.
            "projectId": "A String", # ID of the project that owns the repo. If omitted, the project ID requesting
                # the build is assumed.
            "branchName": "A String", # Name of the branch to build.
            "commitSha": "A String", # Explicit commit SHA to build.
            "tagName": "A String", # Name of the tag to build.
            "repoName": "A String", # Name of the repo. If omitted, the name "default" is assumed.
          },
          "fileHashes": { # 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.
              # @OutputOnly
            "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.
                },
              ],
            },
          },
          "resolvedStorageSource": { # StorageSource describes the location of the source in an archive file in # A copy of the build's source.storage_source, if exists, with any
              # generations resolved.
              # Google Cloud Storage.
            "generation": "A String", # Google Cloud Storage generation for the object. If the generation is
                # omitted, the latest generation will be used.
            "object": "A String", # Google Cloud Storage object containing source.
                #
                # This object must be a gzipped archive file (.tar.gz) containing source to
                # build.
            "bucket": "A String", # Google Cloud Storage bucket containing source (see
                # [Bucket Name
                # Requirements](https://cloud.google.com/storage/docs/bucket-naming#requirements)).
          },
        },
        "logsBucket": "A String", # Google Cloud Storage bucket where logs should be written (see
            # [Bucket Name
            # Requirements](https://cloud.google.com/storage/docs/bucket-naming#requirements)).
            # Logs file names will be of the format `${logs_bucket}/log-${build_id}.txt`.
        "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",
        ],
        "createTime": "A String", # Time at which the request to create the build was received.
            # @OutputOnly
        "logUrl": "A String", # URL to logs for this build in Google Cloud Logging.
            # @OutputOnly
      },
    ],
  }</pre>
</div>

<div class="method">
    <code class="details" id="list_next">list_next(previous_request, previous_response)</code>
  <pre>Retrieves the next page of results.

Args:
  previous_request: The request for the previous page. (required)
  previous_response: The response from the request for the previous page. (required)

Returns:
  A request object that you can call 'execute()' on to request the next
  page. Returns None if there are no more items in the collection.
    </pre>
</div>

</body></html>