| <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.domains.html">domains</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, domainId=None, requestId=None, validateOnly=None, x__xgafv=None)</a></code></p> |
| <p class="firstline">Links a new domain to 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 domain.</p> |
| <p class="toc_element"> |
| <code><a href="#get">get(name, x__xgafv=None)</a></code></p> |
| <p class="firstline">Gets information about a domain.</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 domains of a 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> |
| <p class="toc_element"> |
| <code><a href="#patch">patch(name, allowMissing=None, body=None, requestId=None, updateMask=None, validateOnly=None, x__xgafv=None)</a></code></p> |
| <p class="firstline">Updates the information for a single domain.</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, domainId=None, requestId=None, validateOnly=None, x__xgafv=None)</code> |
| <pre>Links a new domain to 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 domain name that is associated with a backend. |
| "annotations": { # Optional. Annotations as key value pairs. |
| "a_key": "A String", |
| }, |
| "createTime": "A String", # Output only. Time at which the domain was created. |
| "customDomainStatus": { # The status of a custom domain's linkage to a backend. # Output only. Represents the state and configuration of a `CUSTOM` type domain. It is only present on Domains of that type. |
| "certState": "A String", # Output only. Tracks SSL certificate status for the domain. |
| "hostState": "A String", # Output only. Tracks whether a custom domain is detected as appropriately directing traffic to App Hosting. |
| "issues": [ # Output only. A list of issues with domain configuration. Allows users to self-correct problems with DNS records. |
| { # 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). |
| "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. |
| }, |
| ], |
| "ownershipState": "A String", # Output only. Tracks whether the backend is permitted to serve content on the domain, based off the domain's DNS records. |
| "requiredDnsUpdates": [ # Output only. Lists the records that must added or removed to a custom domain's DNS in order to finish setup and start serving content. Field is present during onboarding. Also present after onboarding if one or more of the above states is not *_ACTIVE, indicating the domain's DNS records are in a bad state. |
| { # A set of DNS record updates that you should make to allow App Hosting to serve secure content in response to requests against your domain. These updates present the current state of your domain's and related subdomains' DNS records when App Hosting last queried them, and the desired set of records that App Hosting needs to see before your custom domain can be fully active. |
| "checkTime": "A String", # Output only. The last time App Hosting checked your custom domain's DNS records. |
| "desired": [ # Output only. The set of DNS records App Hosting needs in order to be able to serve secure content on the domain. |
| { # A set of DNS records relevant to the setup and maintenance of a custom domain in App Hosting. |
| "checkError": { # 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. An error App Hosting services encountered when querying your domain's DNS records. Note: App Hosting ignores `NXDOMAIN` errors, as those generally just mean that a domain name hasn't been set up yet. |
| "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. |
| }, |
| "domainName": "A String", # Output only. The domain name the record set pertains to. |
| "records": [ # Output only. Records on the domain. |
| { # A representation of a DNS records for a domain. DNS records are resource records that define how systems and services should behave when handling requests for a domain. For example, when you add `A` records to your domain's DNS records, you're informing other systems (such as your users' web browsers) to contact those IPv4 addresses to retrieve resources relevant to your domain (such as your App Hosting files). |
| "domainName": "A String", # Output only. The domain the record pertains to, e.g. `foo.bar.com.`. |
| "rdata": "A String", # Output only. The data of the record. The meaning of the value depends on record type: - A and AAAA: IP addresses for the domain. - CNAME: Another domain to check for records. - TXT: Arbitrary text strings associated with the domain. App Hosting uses TXT records to determine which Firebase projects have permission to act on the domain's behalf. - CAA: The record's flags, tag, and value, e.g. `0 issue "pki.goog"`. |
| "relevantState": [ # Output only. An enum that indicates which state(s) this DNS record applies to. Populated for all records with an `ADD` or `REMOVE` required action. |
| "A String", |
| ], |
| "requiredAction": "A String", # Output only. An enum that indicates the a required action for this record. Populated when the record is part of a required change in a `DnsUpdates` `discovered` or `desired` record set. |
| "type": "A String", # Output only. The record's type, which determines what data the record contains. |
| }, |
| ], |
| }, |
| ], |
| "discovered": [ # Output only. The set of DNS records App Hosting discovered when inspecting a domain. |
| { # A set of DNS records relevant to the setup and maintenance of a custom domain in App Hosting. |
| "checkError": { # 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. An error App Hosting services encountered when querying your domain's DNS records. Note: App Hosting ignores `NXDOMAIN` errors, as those generally just mean that a domain name hasn't been set up yet. |
| "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. |
| }, |
| "domainName": "A String", # Output only. The domain name the record set pertains to. |
| "records": [ # Output only. Records on the domain. |
| { # A representation of a DNS records for a domain. DNS records are resource records that define how systems and services should behave when handling requests for a domain. For example, when you add `A` records to your domain's DNS records, you're informing other systems (such as your users' web browsers) to contact those IPv4 addresses to retrieve resources relevant to your domain (such as your App Hosting files). |
| "domainName": "A String", # Output only. The domain the record pertains to, e.g. `foo.bar.com.`. |
| "rdata": "A String", # Output only. The data of the record. The meaning of the value depends on record type: - A and AAAA: IP addresses for the domain. - CNAME: Another domain to check for records. - TXT: Arbitrary text strings associated with the domain. App Hosting uses TXT records to determine which Firebase projects have permission to act on the domain's behalf. - CAA: The record's flags, tag, and value, e.g. `0 issue "pki.goog"`. |
| "relevantState": [ # Output only. An enum that indicates which state(s) this DNS record applies to. Populated for all records with an `ADD` or `REMOVE` required action. |
| "A String", |
| ], |
| "requiredAction": "A String", # Output only. An enum that indicates the a required action for this record. Populated when the record is part of a required change in a `DnsUpdates` `discovered` or `desired` record set. |
| "type": "A String", # Output only. The record's type, which determines what data the record contains. |
| }, |
| ], |
| }, |
| ], |
| "domainName": "A String", # Output only. The domain name the DNS updates pertain to. |
| }, |
| ], |
| }, |
| "deleteTime": "A String", # Output only. Time at which the domain was deleted. |
| "disabled": True or False, # Optional. Whether the domain is disabled. Defaults to false. |
| "displayName": "A String", # Optional. Mutable human-readable name for the domain. 63 character limit. e.g. `prod domain`. |
| "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. |
| "labels": { # Optional. Labels as key value pairs. |
| "a_key": "A String", |
| }, |
| "name": "A String", # Identifier. The resource name of the domain, e.g. `/projects/p/locations/l/backends/b/domains/foo.com` |
| "reconciling": True or False, # Output only. A field that, if true, indicates that the build has an ongoing LRO. |
| "serve": { # Indicates whether App Hosting will serve content on the domain. # Optional. The serving behavior of the domain. If specified, the domain will serve content other than its backend's live content. |
| "redirect": { # Specifies redirect behavior for a domain. # Optional. Redirect behavior for a domain, if provided. |
| "status": "A String", # Optional. The status code to use in a redirect response. Must be a valid HTTP 3XX status code. Defaults to 302 if not present. |
| "uri": "A String", # Required. The URI of the redirect's intended destination. This URI will be prepended to the original request path. URI without a scheme are assumed to be HTTPS. |
| }, |
| }, |
| "type": "A String", # Output only. The type of the domain. |
| "uid": "A String", # Output only. System-assigned, unique identifier. |
| "updateTime": "A String", # Output only. Time at which the domain was last updated. |
| } |
| |
| domainId: string, Required. Id of the domain to create. Must be a valid domain name. |
| 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 domain. |
| |
| Args: |
| name: string, Required. Name of the resource in the format: `projects/{project}/locations/{locationId}/backends/{backendId}/domains/{domainId}`. (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 domain. |
| |
| Args: |
| name: string, Required. Name of the resource in the format: `projects/{project}/locations/{locationId}/backends/{backendId}/domains/{domainId}`. (required) |
| x__xgafv: string, V1 error format. |
| Allowed values |
| 1 - v1 error format |
| 2 - v2 error format |
| |
| Returns: |
| An object of the form: |
| |
| { # A domain name that is associated with a backend. |
| "annotations": { # Optional. Annotations as key value pairs. |
| "a_key": "A String", |
| }, |
| "createTime": "A String", # Output only. Time at which the domain was created. |
| "customDomainStatus": { # The status of a custom domain's linkage to a backend. # Output only. Represents the state and configuration of a `CUSTOM` type domain. It is only present on Domains of that type. |
| "certState": "A String", # Output only. Tracks SSL certificate status for the domain. |
| "hostState": "A String", # Output only. Tracks whether a custom domain is detected as appropriately directing traffic to App Hosting. |
| "issues": [ # Output only. A list of issues with domain configuration. Allows users to self-correct problems with DNS records. |
| { # 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). |
| "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. |
| }, |
| ], |
| "ownershipState": "A String", # Output only. Tracks whether the backend is permitted to serve content on the domain, based off the domain's DNS records. |
| "requiredDnsUpdates": [ # Output only. Lists the records that must added or removed to a custom domain's DNS in order to finish setup and start serving content. Field is present during onboarding. Also present after onboarding if one or more of the above states is not *_ACTIVE, indicating the domain's DNS records are in a bad state. |
| { # A set of DNS record updates that you should make to allow App Hosting to serve secure content in response to requests against your domain. These updates present the current state of your domain's and related subdomains' DNS records when App Hosting last queried them, and the desired set of records that App Hosting needs to see before your custom domain can be fully active. |
| "checkTime": "A String", # Output only. The last time App Hosting checked your custom domain's DNS records. |
| "desired": [ # Output only. The set of DNS records App Hosting needs in order to be able to serve secure content on the domain. |
| { # A set of DNS records relevant to the setup and maintenance of a custom domain in App Hosting. |
| "checkError": { # 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. An error App Hosting services encountered when querying your domain's DNS records. Note: App Hosting ignores `NXDOMAIN` errors, as those generally just mean that a domain name hasn't been set up yet. |
| "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. |
| }, |
| "domainName": "A String", # Output only. The domain name the record set pertains to. |
| "records": [ # Output only. Records on the domain. |
| { # A representation of a DNS records for a domain. DNS records are resource records that define how systems and services should behave when handling requests for a domain. For example, when you add `A` records to your domain's DNS records, you're informing other systems (such as your users' web browsers) to contact those IPv4 addresses to retrieve resources relevant to your domain (such as your App Hosting files). |
| "domainName": "A String", # Output only. The domain the record pertains to, e.g. `foo.bar.com.`. |
| "rdata": "A String", # Output only. The data of the record. The meaning of the value depends on record type: - A and AAAA: IP addresses for the domain. - CNAME: Another domain to check for records. - TXT: Arbitrary text strings associated with the domain. App Hosting uses TXT records to determine which Firebase projects have permission to act on the domain's behalf. - CAA: The record's flags, tag, and value, e.g. `0 issue "pki.goog"`. |
| "relevantState": [ # Output only. An enum that indicates which state(s) this DNS record applies to. Populated for all records with an `ADD` or `REMOVE` required action. |
| "A String", |
| ], |
| "requiredAction": "A String", # Output only. An enum that indicates the a required action for this record. Populated when the record is part of a required change in a `DnsUpdates` `discovered` or `desired` record set. |
| "type": "A String", # Output only. The record's type, which determines what data the record contains. |
| }, |
| ], |
| }, |
| ], |
| "discovered": [ # Output only. The set of DNS records App Hosting discovered when inspecting a domain. |
| { # A set of DNS records relevant to the setup and maintenance of a custom domain in App Hosting. |
| "checkError": { # 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. An error App Hosting services encountered when querying your domain's DNS records. Note: App Hosting ignores `NXDOMAIN` errors, as those generally just mean that a domain name hasn't been set up yet. |
| "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. |
| }, |
| "domainName": "A String", # Output only. The domain name the record set pertains to. |
| "records": [ # Output only. Records on the domain. |
| { # A representation of a DNS records for a domain. DNS records are resource records that define how systems and services should behave when handling requests for a domain. For example, when you add `A` records to your domain's DNS records, you're informing other systems (such as your users' web browsers) to contact those IPv4 addresses to retrieve resources relevant to your domain (such as your App Hosting files). |
| "domainName": "A String", # Output only. The domain the record pertains to, e.g. `foo.bar.com.`. |
| "rdata": "A String", # Output only. The data of the record. The meaning of the value depends on record type: - A and AAAA: IP addresses for the domain. - CNAME: Another domain to check for records. - TXT: Arbitrary text strings associated with the domain. App Hosting uses TXT records to determine which Firebase projects have permission to act on the domain's behalf. - CAA: The record's flags, tag, and value, e.g. `0 issue "pki.goog"`. |
| "relevantState": [ # Output only. An enum that indicates which state(s) this DNS record applies to. Populated for all records with an `ADD` or `REMOVE` required action. |
| "A String", |
| ], |
| "requiredAction": "A String", # Output only. An enum that indicates the a required action for this record. Populated when the record is part of a required change in a `DnsUpdates` `discovered` or `desired` record set. |
| "type": "A String", # Output only. The record's type, which determines what data the record contains. |
| }, |
| ], |
| }, |
| ], |
| "domainName": "A String", # Output only. The domain name the DNS updates pertain to. |
| }, |
| ], |
| }, |
| "deleteTime": "A String", # Output only. Time at which the domain was deleted. |
| "disabled": True or False, # Optional. Whether the domain is disabled. Defaults to false. |
| "displayName": "A String", # Optional. Mutable human-readable name for the domain. 63 character limit. e.g. `prod domain`. |
| "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. |
| "labels": { # Optional. Labels as key value pairs. |
| "a_key": "A String", |
| }, |
| "name": "A String", # Identifier. The resource name of the domain, e.g. `/projects/p/locations/l/backends/b/domains/foo.com` |
| "reconciling": True or False, # Output only. A field that, if true, indicates that the build has an ongoing LRO. |
| "serve": { # Indicates whether App Hosting will serve content on the domain. # Optional. The serving behavior of the domain. If specified, the domain will serve content other than its backend's live content. |
| "redirect": { # Specifies redirect behavior for a domain. # Optional. Redirect behavior for a domain, if provided. |
| "status": "A String", # Optional. The status code to use in a redirect response. Must be a valid HTTP 3XX status code. Defaults to 302 if not present. |
| "uri": "A String", # Required. The URI of the redirect's intended destination. This URI will be prepended to the original request path. URI without a scheme are assumed to be HTTPS. |
| }, |
| }, |
| "type": "A String", # Output only. The type of the domain. |
| "uid": "A String", # Output only. System-assigned, unique identifier. |
| "updateTime": "A String", # Output only. Time at which the domain 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 domains of a backend. |
| |
| Args: |
| parent: string, Required. The parent backend in the format: `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 domains. |
| "domains": [ # Output only. The list of domains. |
| { # A domain name that is associated with a backend. |
| "annotations": { # Optional. Annotations as key value pairs. |
| "a_key": "A String", |
| }, |
| "createTime": "A String", # Output only. Time at which the domain was created. |
| "customDomainStatus": { # The status of a custom domain's linkage to a backend. # Output only. Represents the state and configuration of a `CUSTOM` type domain. It is only present on Domains of that type. |
| "certState": "A String", # Output only. Tracks SSL certificate status for the domain. |
| "hostState": "A String", # Output only. Tracks whether a custom domain is detected as appropriately directing traffic to App Hosting. |
| "issues": [ # Output only. A list of issues with domain configuration. Allows users to self-correct problems with DNS records. |
| { # 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). |
| "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. |
| }, |
| ], |
| "ownershipState": "A String", # Output only. Tracks whether the backend is permitted to serve content on the domain, based off the domain's DNS records. |
| "requiredDnsUpdates": [ # Output only. Lists the records that must added or removed to a custom domain's DNS in order to finish setup and start serving content. Field is present during onboarding. Also present after onboarding if one or more of the above states is not *_ACTIVE, indicating the domain's DNS records are in a bad state. |
| { # A set of DNS record updates that you should make to allow App Hosting to serve secure content in response to requests against your domain. These updates present the current state of your domain's and related subdomains' DNS records when App Hosting last queried them, and the desired set of records that App Hosting needs to see before your custom domain can be fully active. |
| "checkTime": "A String", # Output only. The last time App Hosting checked your custom domain's DNS records. |
| "desired": [ # Output only. The set of DNS records App Hosting needs in order to be able to serve secure content on the domain. |
| { # A set of DNS records relevant to the setup and maintenance of a custom domain in App Hosting. |
| "checkError": { # 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. An error App Hosting services encountered when querying your domain's DNS records. Note: App Hosting ignores `NXDOMAIN` errors, as those generally just mean that a domain name hasn't been set up yet. |
| "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. |
| }, |
| "domainName": "A String", # Output only. The domain name the record set pertains to. |
| "records": [ # Output only. Records on the domain. |
| { # A representation of a DNS records for a domain. DNS records are resource records that define how systems and services should behave when handling requests for a domain. For example, when you add `A` records to your domain's DNS records, you're informing other systems (such as your users' web browsers) to contact those IPv4 addresses to retrieve resources relevant to your domain (such as your App Hosting files). |
| "domainName": "A String", # Output only. The domain the record pertains to, e.g. `foo.bar.com.`. |
| "rdata": "A String", # Output only. The data of the record. The meaning of the value depends on record type: - A and AAAA: IP addresses for the domain. - CNAME: Another domain to check for records. - TXT: Arbitrary text strings associated with the domain. App Hosting uses TXT records to determine which Firebase projects have permission to act on the domain's behalf. - CAA: The record's flags, tag, and value, e.g. `0 issue "pki.goog"`. |
| "relevantState": [ # Output only. An enum that indicates which state(s) this DNS record applies to. Populated for all records with an `ADD` or `REMOVE` required action. |
| "A String", |
| ], |
| "requiredAction": "A String", # Output only. An enum that indicates the a required action for this record. Populated when the record is part of a required change in a `DnsUpdates` `discovered` or `desired` record set. |
| "type": "A String", # Output only. The record's type, which determines what data the record contains. |
| }, |
| ], |
| }, |
| ], |
| "discovered": [ # Output only. The set of DNS records App Hosting discovered when inspecting a domain. |
| { # A set of DNS records relevant to the setup and maintenance of a custom domain in App Hosting. |
| "checkError": { # 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. An error App Hosting services encountered when querying your domain's DNS records. Note: App Hosting ignores `NXDOMAIN` errors, as those generally just mean that a domain name hasn't been set up yet. |
| "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. |
| }, |
| "domainName": "A String", # Output only. The domain name the record set pertains to. |
| "records": [ # Output only. Records on the domain. |
| { # A representation of a DNS records for a domain. DNS records are resource records that define how systems and services should behave when handling requests for a domain. For example, when you add `A` records to your domain's DNS records, you're informing other systems (such as your users' web browsers) to contact those IPv4 addresses to retrieve resources relevant to your domain (such as your App Hosting files). |
| "domainName": "A String", # Output only. The domain the record pertains to, e.g. `foo.bar.com.`. |
| "rdata": "A String", # Output only. The data of the record. The meaning of the value depends on record type: - A and AAAA: IP addresses for the domain. - CNAME: Another domain to check for records. - TXT: Arbitrary text strings associated with the domain. App Hosting uses TXT records to determine which Firebase projects have permission to act on the domain's behalf. - CAA: The record's flags, tag, and value, e.g. `0 issue "pki.goog"`. |
| "relevantState": [ # Output only. An enum that indicates which state(s) this DNS record applies to. Populated for all records with an `ADD` or `REMOVE` required action. |
| "A String", |
| ], |
| "requiredAction": "A String", # Output only. An enum that indicates the a required action for this record. Populated when the record is part of a required change in a `DnsUpdates` `discovered` or `desired` record set. |
| "type": "A String", # Output only. The record's type, which determines what data the record contains. |
| }, |
| ], |
| }, |
| ], |
| "domainName": "A String", # Output only. The domain name the DNS updates pertain to. |
| }, |
| ], |
| }, |
| "deleteTime": "A String", # Output only. Time at which the domain was deleted. |
| "disabled": True or False, # Optional. Whether the domain is disabled. Defaults to false. |
| "displayName": "A String", # Optional. Mutable human-readable name for the domain. 63 character limit. e.g. `prod domain`. |
| "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. |
| "labels": { # Optional. Labels as key value pairs. |
| "a_key": "A String", |
| }, |
| "name": "A String", # Identifier. The resource name of the domain, e.g. `/projects/p/locations/l/backends/b/domains/foo.com` |
| "reconciling": True or False, # Output only. A field that, if true, indicates that the build has an ongoing LRO. |
| "serve": { # Indicates whether App Hosting will serve content on the domain. # Optional. The serving behavior of the domain. If specified, the domain will serve content other than its backend's live content. |
| "redirect": { # Specifies redirect behavior for a domain. # Optional. Redirect behavior for a domain, if provided. |
| "status": "A String", # Optional. The status code to use in a redirect response. Must be a valid HTTP 3XX status code. Defaults to 302 if not present. |
| "uri": "A String", # Required. The URI of the redirect's intended destination. This URI will be prepended to the original request path. URI without a scheme are assumed to be HTTPS. |
| }, |
| }, |
| "type": "A String", # Output only. The type of the domain. |
| "uid": "A String", # Output only. System-assigned, unique identifier. |
| "updateTime": "A String", # Output only. Time at which the domain was last updated. |
| }, |
| ], |
| "nextPageToken": "A String", # Output only. A token identifying the next page of results the server should return. |
| "unreachable": [ # Output only. 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> |
| |
| <div class="method"> |
| <code class="details" id="patch">patch(name, allowMissing=None, body=None, requestId=None, updateMask=None, validateOnly=None, x__xgafv=None)</code> |
| <pre>Updates the information for a single domain. |
| |
| Args: |
| name: string, Identifier. The resource name of the domain, e.g. `/projects/p/locations/l/backends/b/domains/foo.com` (required) |
| body: object, The request body. |
| The object takes the form of: |
| |
| { # A domain name that is associated with a backend. |
| "annotations": { # Optional. Annotations as key value pairs. |
| "a_key": "A String", |
| }, |
| "createTime": "A String", # Output only. Time at which the domain was created. |
| "customDomainStatus": { # The status of a custom domain's linkage to a backend. # Output only. Represents the state and configuration of a `CUSTOM` type domain. It is only present on Domains of that type. |
| "certState": "A String", # Output only. Tracks SSL certificate status for the domain. |
| "hostState": "A String", # Output only. Tracks whether a custom domain is detected as appropriately directing traffic to App Hosting. |
| "issues": [ # Output only. A list of issues with domain configuration. Allows users to self-correct problems with DNS records. |
| { # 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). |
| "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. |
| }, |
| ], |
| "ownershipState": "A String", # Output only. Tracks whether the backend is permitted to serve content on the domain, based off the domain's DNS records. |
| "requiredDnsUpdates": [ # Output only. Lists the records that must added or removed to a custom domain's DNS in order to finish setup and start serving content. Field is present during onboarding. Also present after onboarding if one or more of the above states is not *_ACTIVE, indicating the domain's DNS records are in a bad state. |
| { # A set of DNS record updates that you should make to allow App Hosting to serve secure content in response to requests against your domain. These updates present the current state of your domain's and related subdomains' DNS records when App Hosting last queried them, and the desired set of records that App Hosting needs to see before your custom domain can be fully active. |
| "checkTime": "A String", # Output only. The last time App Hosting checked your custom domain's DNS records. |
| "desired": [ # Output only. The set of DNS records App Hosting needs in order to be able to serve secure content on the domain. |
| { # A set of DNS records relevant to the setup and maintenance of a custom domain in App Hosting. |
| "checkError": { # 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. An error App Hosting services encountered when querying your domain's DNS records. Note: App Hosting ignores `NXDOMAIN` errors, as those generally just mean that a domain name hasn't been set up yet. |
| "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. |
| }, |
| "domainName": "A String", # Output only. The domain name the record set pertains to. |
| "records": [ # Output only. Records on the domain. |
| { # A representation of a DNS records for a domain. DNS records are resource records that define how systems and services should behave when handling requests for a domain. For example, when you add `A` records to your domain's DNS records, you're informing other systems (such as your users' web browsers) to contact those IPv4 addresses to retrieve resources relevant to your domain (such as your App Hosting files). |
| "domainName": "A String", # Output only. The domain the record pertains to, e.g. `foo.bar.com.`. |
| "rdata": "A String", # Output only. The data of the record. The meaning of the value depends on record type: - A and AAAA: IP addresses for the domain. - CNAME: Another domain to check for records. - TXT: Arbitrary text strings associated with the domain. App Hosting uses TXT records to determine which Firebase projects have permission to act on the domain's behalf. - CAA: The record's flags, tag, and value, e.g. `0 issue "pki.goog"`. |
| "relevantState": [ # Output only. An enum that indicates which state(s) this DNS record applies to. Populated for all records with an `ADD` or `REMOVE` required action. |
| "A String", |
| ], |
| "requiredAction": "A String", # Output only. An enum that indicates the a required action for this record. Populated when the record is part of a required change in a `DnsUpdates` `discovered` or `desired` record set. |
| "type": "A String", # Output only. The record's type, which determines what data the record contains. |
| }, |
| ], |
| }, |
| ], |
| "discovered": [ # Output only. The set of DNS records App Hosting discovered when inspecting a domain. |
| { # A set of DNS records relevant to the setup and maintenance of a custom domain in App Hosting. |
| "checkError": { # 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. An error App Hosting services encountered when querying your domain's DNS records. Note: App Hosting ignores `NXDOMAIN` errors, as those generally just mean that a domain name hasn't been set up yet. |
| "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. |
| }, |
| "domainName": "A String", # Output only. The domain name the record set pertains to. |
| "records": [ # Output only. Records on the domain. |
| { # A representation of a DNS records for a domain. DNS records are resource records that define how systems and services should behave when handling requests for a domain. For example, when you add `A` records to your domain's DNS records, you're informing other systems (such as your users' web browsers) to contact those IPv4 addresses to retrieve resources relevant to your domain (such as your App Hosting files). |
| "domainName": "A String", # Output only. The domain the record pertains to, e.g. `foo.bar.com.`. |
| "rdata": "A String", # Output only. The data of the record. The meaning of the value depends on record type: - A and AAAA: IP addresses for the domain. - CNAME: Another domain to check for records. - TXT: Arbitrary text strings associated with the domain. App Hosting uses TXT records to determine which Firebase projects have permission to act on the domain's behalf. - CAA: The record's flags, tag, and value, e.g. `0 issue "pki.goog"`. |
| "relevantState": [ # Output only. An enum that indicates which state(s) this DNS record applies to. Populated for all records with an `ADD` or `REMOVE` required action. |
| "A String", |
| ], |
| "requiredAction": "A String", # Output only. An enum that indicates the a required action for this record. Populated when the record is part of a required change in a `DnsUpdates` `discovered` or `desired` record set. |
| "type": "A String", # Output only. The record's type, which determines what data the record contains. |
| }, |
| ], |
| }, |
| ], |
| "domainName": "A String", # Output only. The domain name the DNS updates pertain to. |
| }, |
| ], |
| }, |
| "deleteTime": "A String", # Output only. Time at which the domain was deleted. |
| "disabled": True or False, # Optional. Whether the domain is disabled. Defaults to false. |
| "displayName": "A String", # Optional. Mutable human-readable name for the domain. 63 character limit. e.g. `prod domain`. |
| "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. |
| "labels": { # Optional. Labels as key value pairs. |
| "a_key": "A String", |
| }, |
| "name": "A String", # Identifier. The resource name of the domain, e.g. `/projects/p/locations/l/backends/b/domains/foo.com` |
| "reconciling": True or False, # Output only. A field that, if true, indicates that the build has an ongoing LRO. |
| "serve": { # Indicates whether App Hosting will serve content on the domain. # Optional. The serving behavior of the domain. If specified, the domain will serve content other than its backend's live content. |
| "redirect": { # Specifies redirect behavior for a domain. # Optional. Redirect behavior for a domain, if provided. |
| "status": "A String", # Optional. The status code to use in a redirect response. Must be a valid HTTP 3XX status code. Defaults to 302 if not present. |
| "uri": "A String", # Required. The URI of the redirect's intended destination. This URI will be prepended to the original request path. URI without a scheme are assumed to be HTTPS. |
| }, |
| }, |
| "type": "A String", # Output only. The type of the domain. |
| "uid": "A String", # Output only. System-assigned, unique identifier. |
| "updateTime": "A String", # Output only. Time at which the domain was last updated. |
| } |
| |
| allowMissing: boolean, Optional. If set to true, and the domain is not found, a new domain will be 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). |
| updateMask: string, Optional. Field mask is used to specify the fields to be overwritten in the Domain resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it is in the mask. If the user does not provide a mask then all fields will be overwritten. |
| validateOnly: boolean, Optional. Indicates that the request should be validated and default values populated, without persisting the request or modifying 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> |
| |
| </body></html> |
