| <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="firebaseapphosting_v1.html">Firebase App Hosting API</a> . <a href="firebaseapphosting_v1.projects.html">projects</a> . <a href="firebaseapphosting_v1.projects.locations.html">locations</a> . <a href="firebaseapphosting_v1.projects.locations.backends.html">backends</a> . <a href="firebaseapphosting_v1.projects.locations.backends.builds.html">builds</a></h1> |
| <h2>Instance Methods</h2> |
| <p class="toc_element"> |
| <code><a href="#close">close()</a></code></p> |
| <p class="firstline">Close httplib2 connections.</p> |
| <p class="toc_element"> |
| <code><a href="#create">create(parent, body=None, buildId=None, requestId=None, validateOnly=None, x__xgafv=None)</a></code></p> |
| <p class="firstline">Creates a new build for a backend.</p> |
| <p class="toc_element"> |
| <code><a href="#delete">delete(name, etag=None, requestId=None, validateOnly=None, x__xgafv=None)</a></code></p> |
| <p class="firstline">Deletes a single build.</p> |
| <p class="toc_element"> |
| <code><a href="#get">get(name, x__xgafv=None)</a></code></p> |
| <p class="firstline">Gets information about a build.</p> |
| <p class="toc_element"> |
| <code><a href="#list">list(parent, filter=None, orderBy=None, pageSize=None, pageToken=None, showDeleted=None, x__xgafv=None)</a></code></p> |
| <p class="firstline">Lists builds in a given project, location, and backend.</p> |
| <p class="toc_element"> |
| <code><a href="#list_next">list_next()</a></code></p> |
| <p class="firstline">Retrieves the next page of results.</p> |
| <h3>Method Details</h3> |
| <div class="method"> |
| <code class="details" id="close">close()</code> |
| <pre>Close httplib2 connections.</pre> |
| </div> |
| |
| <div class="method"> |
| <code class="details" id="create">create(parent, body=None, buildId=None, requestId=None, validateOnly=None, x__xgafv=None)</code> |
| <pre>Creates a new build for a backend. |
| |
| Args: |
| parent: string, Required. The parent backend in the format: `projects/{project}/locations/{locationId}/backends/{backendId}`. (required) |
| body: object, The request body. |
| The object takes the form of: |
| |
| { # A single build for a backend, at a specific point codebase reference tag and point in time. Encapsulates several resources, including an Artifact Registry container image, a Cloud Build invocation that built the image, and the Cloud Run revision that uses that image. |
| "annotations": { # Optional. Unstructured key value map that may be set by external tools to store and arbitrary metadata. They are not queryable and should be preserved when modifying objects. |
| "a_key": "A String", |
| }, |
| "buildLogsUri": "A String", # Output only. The location of the [Cloud Build logs](https://cloud.google.com/build/docs/view-build-results) for the build process. |
| "config": { # Additional configuration of the backend for this build. # Optional. Additional configuration of the service. |
| "env": [ # Optional. Environment variables for this build. |
| { # Environment variables for this build. |
| "availability": [ # Optional. Where this variable should be made available. If left unspecified, will be available in both BUILD and BACKEND. |
| "A String", |
| ], |
| "secret": "A String", # A fully qualified secret version. The value of the secret will be accessed once while building the application and once per cold start of the container at runtime. The service account used by Cloud Build and by Cloud Run must each have the `secretmanager.versions.access` permission on the secret. |
| "value": "A String", # A plaintext value. This value is encrypted at rest, but all project readers can view the value when reading your backend configuration. |
| "variable": "A String", # Required. The name of the environment variable. - Must be a valid environment variable name (e.g. A-Z or underscores). - May not start with "FIREBASE" or "GOOGLE". - May not be a reserved environment variable for KNative/Cloud Run |
| }, |
| ], |
| "runConfig": { # Additional configuration to apply to the Cloud Run [`service`](https://cloud.google.com/run/docs/reference/rest/v2/projects.locations.services#resource:-service). # Optional. Additional configuration of the Cloud Run [`service`](https://cloud.google.com/run/docs/reference/rest/v2/projects.locations.services#resource:-service). |
| "concurrency": 42, # Optional. Maximum number of requests that each Cloud Run instance can receive. By default, each instance can receive Cloud Run's default of up to 80 requests at the same time. Concurrency can be set to any integer value up to 1000. |
| "cpu": 3.14, # Optional. Number of CPUs used for each serving instance. By default, cpu defaults to the Cloud Run's default of 1.0. CPU can be set to value 1, 2, 4, 6, or 8 CPUs, and for less than 1 CPU, a value from 0.08 to less than 1.00, in increments of 0.01. If you set a value of less than 1 CPU, you must set concurrency to 1, and CPU will only be allocated during request processing. Increasing CPUs limit may require increase in memory limits: - 4 CPUs: at least 2 GiB - 6 CPUs: at least 4 GiB - 8 CPUs: at least 4 GiB |
| "maxInstances": 42, # Optional. Number of Cloud Run instances to maintain at maximum for each revision. By default, each Cloud Run [`service`](https://cloud.google.com/run/docs/reference/rest/v2/projects.locations.services#resource:-service) scales out to Cloud Run's default of a maximum of 100 instances. The maximum max_instances limit is based on your quota. See https://cloud.google.com/run/docs/configuring/max-instances#limits. |
| "memoryMib": 42, # Optional. Amount of memory allocated for each serving instance in MiB. By default, memory defaults to the Cloud Run's default where each instance is allocated 512 MiB of memory. Memory can be set to any integer value between 128 to 32768. Increasing memory limit may require increase in CPUs limits: - Over 4 GiB: at least 2 CPUs - Over 8 GiB: at least 4 CPUs - Over 16 GiB: at least 6 CPUs - Over 24 GiB: at least 8 CPUs |
| "minInstances": 42, # Optional. Number of Cloud Run instances to maintain at minimum for each Cloud Run Service. By default, there are no minimum. Even if the service splits traffic across multiple revisions, the total number of instances for a service will be capped at this value. |
| }, |
| }, |
| "createTime": "A String", # Output only. Time at which the build was created. |
| "deleteTime": "A String", # Output only. Time at which the build was deleted. |
| "displayName": "A String", # Optional. Human-readable name. 63 character limit. |
| "environment": "A String", # Output only. The environment name of the backend when this build was created. |
| "errors": [ # Output only. A list of all errors that occurred during an App Hosting build. |
| { # The container for the rpc status and source for any errors found during the build process. |
| "cloudResource": "A String", # Output only. Resource link |
| "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](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). # Output only. A status and (human readable) error message for the build, if in a `FAILED` state. |
| "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 is a common set of message types for APIs to use. |
| { |
| "a_key": "", # Properties of the object. Contains field @type with type URL. |
| }, |
| ], |
| "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. |
| }, |
| "errorSource": "A String", # Output only. The source of the error for the build, if in a `FAILED` state. |
| }, |
| ], |
| "etag": "A String", # Output only. Server-computed checksum based on other values; may be sent on update or delete to ensure operation is done on expected resource. |
| "image": "A String", # Output only. The Artifact Registry [container image](https://cloud.google.com/artifact-registry/docs/reference/rest/v1/projects.locations.repositories.dockerImages) URI, used by the Cloud Run [`revision`](https://cloud.google.com/run/docs/reference/rest/v2/projects.locations.services.revisions) for this build. |
| "labels": { # Optional. Unstructured key value map that can be used to organize and categorize objects. |
| "a_key": "A String", |
| }, |
| "name": "A String", # Identifier. The resource name of the build. Format: `projects/{project}/locations/{locationId}/backends/{backendId}/builds/{buildId}`. |
| "reconciling": True or False, # Output only. A field that, if true, indicates that the build has an ongoing LRO. |
| "source": { # The source for the build. # Required. Immutable. The source for the build. |
| "codebase": { # A codebase source, representing the state of the codebase that the build will be created at. # A codebase source. |
| "author": { # Version control metadata for a user associated with a resolved codebase. Currently assumes a Git user. # Output only. The author contained in the metadata of a version control change. |
| "displayName": "A String", # Output only. The 'name' field in a Git user's git.config. Required by Git. |
| "email": "A String", # Output only. The 'email' field in a Git user's git.config, if available. |
| "imageUri": "A String", # Output only. The URI of an image file associated with the user's account in an external source control provider, if available. |
| }, |
| "branch": "A String", # The branch in the codebase to build from, using the latest commit. |
| "commit": "A String", # The commit in the codebase to build from. |
| "commitMessage": "A String", # Output only. The message of a codebase change. |
| "commitTime": "A String", # Output only. The time the change was made. |
| "displayName": "A String", # Output only. The human-friendly name to use for this Codebase when displaying a build. We use the first eight characters of the SHA-1 hash for GitHub.com. |
| "hash": "A String", # Output only. The full SHA-1 hash of a Git commit, if available. |
| "uri": "A String", # Output only. A URI linking to the codebase on an hosting provider's website. May not be valid if the commit has been rebased or force-pushed out of existence in the linked repository. |
| }, |
| "container": { # The URI of an Artifact Registry [container image](https://cloud.google.com/artifact-registry/docs/reference/rest/v1/projects.locations.repositories.dockerImages) to use as the build source. # An Artifact Registry container image source. |
| "image": "A String", # Required. A URI representing a container for the backend to use. |
| }, |
| }, |
| "state": "A String", # Output only. The state of the build. |
| "uid": "A String", # Output only. System-assigned, unique identifier. |
| "updateTime": "A String", # Output only. Time at which the build was last updated. |
| } |
| |
| buildId: string, Required. Desired ID of the build being created. |
| requestId: string, Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). |
| validateOnly: boolean, Optional. Indicates that the request should be validated and default values populated, without persisting the request or creating any resources. |
| 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. |
| "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. |
| "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](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). # The error result of the operation in case of failure or cancellation. |
| "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 is a common set of message types for APIs to use. |
| { |
| "a_key": "", # Properties of the object. Contains field @type with type URL. |
| }, |
| ], |
| "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. |
| }, |
| "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. |
| }, |
| "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}`. |
| "response": { # The normal, successful response of the operation. 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. |
| }, |
| }</pre> |
| </div> |
| |
| <div class="method"> |
| <code class="details" id="delete">delete(name, etag=None, requestId=None, validateOnly=None, x__xgafv=None)</code> |
| <pre>Deletes a single build. |
| |
| Args: |
| name: string, Required. Name of the resource in the format: `projects/{project}/locations/{locationId}/backends/{backendId}/builds/{buildId}`. (required) |
| etag: string, Optional. If the client provided etag is out of date, delete will be returned FAILED_PRECONDITION error. |
| requestId: string, Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes after the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). |
| validateOnly: boolean, Optional. Indicates that the request should be validated and default values populated, without persisting the request or deleting any resources. |
| 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. |
| "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. |
| "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](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). # The error result of the operation in case of failure or cancellation. |
| "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 is a common set of message types for APIs to use. |
| { |
| "a_key": "", # Properties of the object. Contains field @type with type URL. |
| }, |
| ], |
| "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. |
| }, |
| "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. |
| }, |
| "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}`. |
| "response": { # The normal, successful response of the operation. 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. |
| }, |
| }</pre> |
| </div> |
| |
| <div class="method"> |
| <code class="details" id="get">get(name, x__xgafv=None)</code> |
| <pre>Gets information about a build. |
| |
| Args: |
| name: string, Required. Name of the resource in the format: `projects/{project}/locations/{locationId}/backends/{backendId}/builds/{buildId}`. (required) |
| x__xgafv: string, V1 error format. |
| Allowed values |
| 1 - v1 error format |
| 2 - v2 error format |
| |
| Returns: |
| An object of the form: |
| |
| { # A single build for a backend, at a specific point codebase reference tag and point in time. Encapsulates several resources, including an Artifact Registry container image, a Cloud Build invocation that built the image, and the Cloud Run revision that uses that image. |
| "annotations": { # Optional. Unstructured key value map that may be set by external tools to store and arbitrary metadata. They are not queryable and should be preserved when modifying objects. |
| "a_key": "A String", |
| }, |
| "buildLogsUri": "A String", # Output only. The location of the [Cloud Build logs](https://cloud.google.com/build/docs/view-build-results) for the build process. |
| "config": { # Additional configuration of the backend for this build. # Optional. Additional configuration of the service. |
| "env": [ # Optional. Environment variables for this build. |
| { # Environment variables for this build. |
| "availability": [ # Optional. Where this variable should be made available. If left unspecified, will be available in both BUILD and BACKEND. |
| "A String", |
| ], |
| "secret": "A String", # A fully qualified secret version. The value of the secret will be accessed once while building the application and once per cold start of the container at runtime. The service account used by Cloud Build and by Cloud Run must each have the `secretmanager.versions.access` permission on the secret. |
| "value": "A String", # A plaintext value. This value is encrypted at rest, but all project readers can view the value when reading your backend configuration. |
| "variable": "A String", # Required. The name of the environment variable. - Must be a valid environment variable name (e.g. A-Z or underscores). - May not start with "FIREBASE" or "GOOGLE". - May not be a reserved environment variable for KNative/Cloud Run |
| }, |
| ], |
| "runConfig": { # Additional configuration to apply to the Cloud Run [`service`](https://cloud.google.com/run/docs/reference/rest/v2/projects.locations.services#resource:-service). # Optional. Additional configuration of the Cloud Run [`service`](https://cloud.google.com/run/docs/reference/rest/v2/projects.locations.services#resource:-service). |
| "concurrency": 42, # Optional. Maximum number of requests that each Cloud Run instance can receive. By default, each instance can receive Cloud Run's default of up to 80 requests at the same time. Concurrency can be set to any integer value up to 1000. |
| "cpu": 3.14, # Optional. Number of CPUs used for each serving instance. By default, cpu defaults to the Cloud Run's default of 1.0. CPU can be set to value 1, 2, 4, 6, or 8 CPUs, and for less than 1 CPU, a value from 0.08 to less than 1.00, in increments of 0.01. If you set a value of less than 1 CPU, you must set concurrency to 1, and CPU will only be allocated during request processing. Increasing CPUs limit may require increase in memory limits: - 4 CPUs: at least 2 GiB - 6 CPUs: at least 4 GiB - 8 CPUs: at least 4 GiB |
| "maxInstances": 42, # Optional. Number of Cloud Run instances to maintain at maximum for each revision. By default, each Cloud Run [`service`](https://cloud.google.com/run/docs/reference/rest/v2/projects.locations.services#resource:-service) scales out to Cloud Run's default of a maximum of 100 instances. The maximum max_instances limit is based on your quota. See https://cloud.google.com/run/docs/configuring/max-instances#limits. |
| "memoryMib": 42, # Optional. Amount of memory allocated for each serving instance in MiB. By default, memory defaults to the Cloud Run's default where each instance is allocated 512 MiB of memory. Memory can be set to any integer value between 128 to 32768. Increasing memory limit may require increase in CPUs limits: - Over 4 GiB: at least 2 CPUs - Over 8 GiB: at least 4 CPUs - Over 16 GiB: at least 6 CPUs - Over 24 GiB: at least 8 CPUs |
| "minInstances": 42, # Optional. Number of Cloud Run instances to maintain at minimum for each Cloud Run Service. By default, there are no minimum. Even if the service splits traffic across multiple revisions, the total number of instances for a service will be capped at this value. |
| }, |
| }, |
| "createTime": "A String", # Output only. Time at which the build was created. |
| "deleteTime": "A String", # Output only. Time at which the build was deleted. |
| "displayName": "A String", # Optional. Human-readable name. 63 character limit. |
| "environment": "A String", # Output only. The environment name of the backend when this build was created. |
| "errors": [ # Output only. A list of all errors that occurred during an App Hosting build. |
| { # The container for the rpc status and source for any errors found during the build process. |
| "cloudResource": "A String", # Output only. Resource link |
| "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](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). # Output only. A status and (human readable) error message for the build, if in a `FAILED` state. |
| "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 is a common set of message types for APIs to use. |
| { |
| "a_key": "", # Properties of the object. Contains field @type with type URL. |
| }, |
| ], |
| "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. |
| }, |
| "errorSource": "A String", # Output only. The source of the error for the build, if in a `FAILED` state. |
| }, |
| ], |
| "etag": "A String", # Output only. Server-computed checksum based on other values; may be sent on update or delete to ensure operation is done on expected resource. |
| "image": "A String", # Output only. The Artifact Registry [container image](https://cloud.google.com/artifact-registry/docs/reference/rest/v1/projects.locations.repositories.dockerImages) URI, used by the Cloud Run [`revision`](https://cloud.google.com/run/docs/reference/rest/v2/projects.locations.services.revisions) for this build. |
| "labels": { # Optional. Unstructured key value map that can be used to organize and categorize objects. |
| "a_key": "A String", |
| }, |
| "name": "A String", # Identifier. The resource name of the build. Format: `projects/{project}/locations/{locationId}/backends/{backendId}/builds/{buildId}`. |
| "reconciling": True or False, # Output only. A field that, if true, indicates that the build has an ongoing LRO. |
| "source": { # The source for the build. # Required. Immutable. The source for the build. |
| "codebase": { # A codebase source, representing the state of the codebase that the build will be created at. # A codebase source. |
| "author": { # Version control metadata for a user associated with a resolved codebase. Currently assumes a Git user. # Output only. The author contained in the metadata of a version control change. |
| "displayName": "A String", # Output only. The 'name' field in a Git user's git.config. Required by Git. |
| "email": "A String", # Output only. The 'email' field in a Git user's git.config, if available. |
| "imageUri": "A String", # Output only. The URI of an image file associated with the user's account in an external source control provider, if available. |
| }, |
| "branch": "A String", # The branch in the codebase to build from, using the latest commit. |
| "commit": "A String", # The commit in the codebase to build from. |
| "commitMessage": "A String", # Output only. The message of a codebase change. |
| "commitTime": "A String", # Output only. The time the change was made. |
| "displayName": "A String", # Output only. The human-friendly name to use for this Codebase when displaying a build. We use the first eight characters of the SHA-1 hash for GitHub.com. |
| "hash": "A String", # Output only. The full SHA-1 hash of a Git commit, if available. |
| "uri": "A String", # Output only. A URI linking to the codebase on an hosting provider's website. May not be valid if the commit has been rebased or force-pushed out of existence in the linked repository. |
| }, |
| "container": { # The URI of an Artifact Registry [container image](https://cloud.google.com/artifact-registry/docs/reference/rest/v1/projects.locations.repositories.dockerImages) to use as the build source. # An Artifact Registry container image source. |
| "image": "A String", # Required. A URI representing a container for the backend to use. |
| }, |
| }, |
| "state": "A String", # Output only. The state of the build. |
| "uid": "A String", # Output only. System-assigned, unique identifier. |
| "updateTime": "A String", # Output only. Time at which the build was last updated. |
| }</pre> |
| </div> |
| |
| <div class="method"> |
| <code class="details" id="list">list(parent, filter=None, orderBy=None, pageSize=None, pageToken=None, showDeleted=None, x__xgafv=None)</code> |
| <pre>Lists builds in a given project, location, and backend. |
| |
| Args: |
| parent: string, Required. The parent backend in the form `projects/{project}/locations/{locationId}/backends/{backendId}`. (required) |
| filter: string, Optional. A filter to narrow down results to a preferred subset. Learn more about filtering in Google's [AIP 160 standard](https://google.aip.dev/160). |
| orderBy: string, Optional. Hint for how to order the results. Supported fields are `name` and `createTime`. To specify descending order, append a `desc` suffix. |
| pageSize: integer, Optional. The maximum number of results to return. If not set, the service selects a default. |
| pageToken: string, Optional. A page token received from the nextPageToken field in the response. Send that page token to receive the subsequent page. |
| showDeleted: boolean, Optional. If true, the request returns soft-deleted resources that haven't been fully-deleted yet. |
| x__xgafv: string, V1 error format. |
| Allowed values |
| 1 - v1 error format |
| 2 - v2 error format |
| |
| Returns: |
| An object of the form: |
| |
| { # Message for response to list builds. |
| "builds": [ # The list of builds. |
| { # A single build for a backend, at a specific point codebase reference tag and point in time. Encapsulates several resources, including an Artifact Registry container image, a Cloud Build invocation that built the image, and the Cloud Run revision that uses that image. |
| "annotations": { # Optional. Unstructured key value map that may be set by external tools to store and arbitrary metadata. They are not queryable and should be preserved when modifying objects. |
| "a_key": "A String", |
| }, |
| "buildLogsUri": "A String", # Output only. The location of the [Cloud Build logs](https://cloud.google.com/build/docs/view-build-results) for the build process. |
| "config": { # Additional configuration of the backend for this build. # Optional. Additional configuration of the service. |
| "env": [ # Optional. Environment variables for this build. |
| { # Environment variables for this build. |
| "availability": [ # Optional. Where this variable should be made available. If left unspecified, will be available in both BUILD and BACKEND. |
| "A String", |
| ], |
| "secret": "A String", # A fully qualified secret version. The value of the secret will be accessed once while building the application and once per cold start of the container at runtime. The service account used by Cloud Build and by Cloud Run must each have the `secretmanager.versions.access` permission on the secret. |
| "value": "A String", # A plaintext value. This value is encrypted at rest, but all project readers can view the value when reading your backend configuration. |
| "variable": "A String", # Required. The name of the environment variable. - Must be a valid environment variable name (e.g. A-Z or underscores). - May not start with "FIREBASE" or "GOOGLE". - May not be a reserved environment variable for KNative/Cloud Run |
| }, |
| ], |
| "runConfig": { # Additional configuration to apply to the Cloud Run [`service`](https://cloud.google.com/run/docs/reference/rest/v2/projects.locations.services#resource:-service). # Optional. Additional configuration of the Cloud Run [`service`](https://cloud.google.com/run/docs/reference/rest/v2/projects.locations.services#resource:-service). |
| "concurrency": 42, # Optional. Maximum number of requests that each Cloud Run instance can receive. By default, each instance can receive Cloud Run's default of up to 80 requests at the same time. Concurrency can be set to any integer value up to 1000. |
| "cpu": 3.14, # Optional. Number of CPUs used for each serving instance. By default, cpu defaults to the Cloud Run's default of 1.0. CPU can be set to value 1, 2, 4, 6, or 8 CPUs, and for less than 1 CPU, a value from 0.08 to less than 1.00, in increments of 0.01. If you set a value of less than 1 CPU, you must set concurrency to 1, and CPU will only be allocated during request processing. Increasing CPUs limit may require increase in memory limits: - 4 CPUs: at least 2 GiB - 6 CPUs: at least 4 GiB - 8 CPUs: at least 4 GiB |
| "maxInstances": 42, # Optional. Number of Cloud Run instances to maintain at maximum for each revision. By default, each Cloud Run [`service`](https://cloud.google.com/run/docs/reference/rest/v2/projects.locations.services#resource:-service) scales out to Cloud Run's default of a maximum of 100 instances. The maximum max_instances limit is based on your quota. See https://cloud.google.com/run/docs/configuring/max-instances#limits. |
| "memoryMib": 42, # Optional. Amount of memory allocated for each serving instance in MiB. By default, memory defaults to the Cloud Run's default where each instance is allocated 512 MiB of memory. Memory can be set to any integer value between 128 to 32768. Increasing memory limit may require increase in CPUs limits: - Over 4 GiB: at least 2 CPUs - Over 8 GiB: at least 4 CPUs - Over 16 GiB: at least 6 CPUs - Over 24 GiB: at least 8 CPUs |
| "minInstances": 42, # Optional. Number of Cloud Run instances to maintain at minimum for each Cloud Run Service. By default, there are no minimum. Even if the service splits traffic across multiple revisions, the total number of instances for a service will be capped at this value. |
| }, |
| }, |
| "createTime": "A String", # Output only. Time at which the build was created. |
| "deleteTime": "A String", # Output only. Time at which the build was deleted. |
| "displayName": "A String", # Optional. Human-readable name. 63 character limit. |
| "environment": "A String", # Output only. The environment name of the backend when this build was created. |
| "errors": [ # Output only. A list of all errors that occurred during an App Hosting build. |
| { # The container for the rpc status and source for any errors found during the build process. |
| "cloudResource": "A String", # Output only. Resource link |
| "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](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). # Output only. A status and (human readable) error message for the build, if in a `FAILED` state. |
| "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 is a common set of message types for APIs to use. |
| { |
| "a_key": "", # Properties of the object. Contains field @type with type URL. |
| }, |
| ], |
| "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. |
| }, |
| "errorSource": "A String", # Output only. The source of the error for the build, if in a `FAILED` state. |
| }, |
| ], |
| "etag": "A String", # Output only. Server-computed checksum based on other values; may be sent on update or delete to ensure operation is done on expected resource. |
| "image": "A String", # Output only. The Artifact Registry [container image](https://cloud.google.com/artifact-registry/docs/reference/rest/v1/projects.locations.repositories.dockerImages) URI, used by the Cloud Run [`revision`](https://cloud.google.com/run/docs/reference/rest/v2/projects.locations.services.revisions) for this build. |
| "labels": { # Optional. Unstructured key value map that can be used to organize and categorize objects. |
| "a_key": "A String", |
| }, |
| "name": "A String", # Identifier. The resource name of the build. Format: `projects/{project}/locations/{locationId}/backends/{backendId}/builds/{buildId}`. |
| "reconciling": True or False, # Output only. A field that, if true, indicates that the build has an ongoing LRO. |
| "source": { # The source for the build. # Required. Immutable. The source for the build. |
| "codebase": { # A codebase source, representing the state of the codebase that the build will be created at. # A codebase source. |
| "author": { # Version control metadata for a user associated with a resolved codebase. Currently assumes a Git user. # Output only. The author contained in the metadata of a version control change. |
| "displayName": "A String", # Output only. The 'name' field in a Git user's git.config. Required by Git. |
| "email": "A String", # Output only. The 'email' field in a Git user's git.config, if available. |
| "imageUri": "A String", # Output only. The URI of an image file associated with the user's account in an external source control provider, if available. |
| }, |
| "branch": "A String", # The branch in the codebase to build from, using the latest commit. |
| "commit": "A String", # The commit in the codebase to build from. |
| "commitMessage": "A String", # Output only. The message of a codebase change. |
| "commitTime": "A String", # Output only. The time the change was made. |
| "displayName": "A String", # Output only. The human-friendly name to use for this Codebase when displaying a build. We use the first eight characters of the SHA-1 hash for GitHub.com. |
| "hash": "A String", # Output only. The full SHA-1 hash of a Git commit, if available. |
| "uri": "A String", # Output only. A URI linking to the codebase on an hosting provider's website. May not be valid if the commit has been rebased or force-pushed out of existence in the linked repository. |
| }, |
| "container": { # The URI of an Artifact Registry [container image](https://cloud.google.com/artifact-registry/docs/reference/rest/v1/projects.locations.repositories.dockerImages) to use as the build source. # An Artifact Registry container image source. |
| "image": "A String", # Required. A URI representing a container for the backend to use. |
| }, |
| }, |
| "state": "A String", # Output only. The state of the build. |
| "uid": "A String", # Output only. System-assigned, unique identifier. |
| "updateTime": "A String", # Output only. Time at which the build was last updated. |
| }, |
| ], |
| "nextPageToken": "A String", # A token identifying the next page of results the server should return. |
| "unreachable": [ # Locations that could not be reached. |
| "A String", |
| ], |
| }</pre> |
| </div> |
| |
| <div class="method"> |
| <code class="details" id="list_next">list_next()</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> |
