create(parent, body, x__xgafv=None)

Creates a domain mapping on the specified site.

Args:
  parent: string, Required. The parent to create the domain association for, in the format:
sites/site-name (required)
  body: object, The request body. (required)
    The object takes the form of:

{ # The intended behavior and status information of a domain.
    "status": "A String", # Output only. Additional status of the domain association.
    "domainRedirect": { # Defines the behavior of a domain-level redirect. Domain redirects preserve # If set, the domain should redirect with the provided parameters.
        # the path of the redirect but replace the requested domain with the one
        # specified in the redirect configuration.
      "type": "A String", # Required. The redirect status code.
      "domainName": "A String", # Required. The domain name to redirect to.
    },
    "domainName": "A String", # Required. The domain name of the association.
    "site": "A String", # Required. The site name of the association.
    "updateTime": "A String", # Output only. The time at which the domain was last updated.
    "provisioning": { # The current certificate provisioning status information for a domain. # Output only. Information about the provisioning of certificates and the
        # health of the DNS resolution for the domain.
      "certChallengeHttp": { # Represents an HTTP certificate challenge. # The HTTP challenge for generating a certificate.
        "path": "A String", # The URL path on which to serve the specified token to satisfy the
            # certificate challenge.
        "token": "A String", # The token to serve at the specified URL path to satisfy the certificate
            # challenge.
      },
      "expectedIps": [ # The list of IPs to which the domain is expected to resolve.
        "A String",
      ],
      "certChallengeDiscoveredTxt": [ # The TXT records (for the certificate challenge) that were found at the last
          # DNS fetch.
        "A String",
      ],
      "dnsFetchTime": "A String", # The time at which the last DNS fetch occurred.
      "discoveredIps": [ # The IPs found at the last DNS fetch.
        "A String",
      ],
      "certChallengeDns": { # Represents a DNS certificate challenge. # The DNS challenge for generating a certificate.
        "token": "A String", # The value that must be present as a TXT record on the domain name to
            # satisfy the challenge.
        "domainName": "A String", # The domain name upon which the DNS challenge must be satisfied.
      },
      "dnsStatus": "A String", # The DNS record match status as of the last DNS fetch.
      "certStatus": "A String", # The certificate provisioning status; updated when Firebase Hosting
          # provisions an SSL certificate for the domain.
    },
  }

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

Returns:
  An object of the form:

    { # The intended behavior and status information of a domain.
      "status": "A String", # Output only. Additional status of the domain association.
      "domainRedirect": { # Defines the behavior of a domain-level redirect. Domain redirects preserve # If set, the domain should redirect with the provided parameters.
          # the path of the redirect but replace the requested domain with the one
          # specified in the redirect configuration.
        "type": "A String", # Required. The redirect status code.
        "domainName": "A String", # Required. The domain name to redirect to.
      },
      "domainName": "A String", # Required. The domain name of the association.
      "site": "A String", # Required. The site name of the association.
      "updateTime": "A String", # Output only. The time at which the domain was last updated.
      "provisioning": { # The current certificate provisioning status information for a domain. # Output only. Information about the provisioning of certificates and the
          # health of the DNS resolution for the domain.
        "certChallengeHttp": { # Represents an HTTP certificate challenge. # The HTTP challenge for generating a certificate.
          "path": "A String", # The URL path on which to serve the specified token to satisfy the
              # certificate challenge.
          "token": "A String", # The token to serve at the specified URL path to satisfy the certificate
              # challenge.
        },
        "expectedIps": [ # The list of IPs to which the domain is expected to resolve.
          "A String",
        ],
        "certChallengeDiscoveredTxt": [ # The TXT records (for the certificate challenge) that were found at the last
            # DNS fetch.
          "A String",
        ],
        "dnsFetchTime": "A String", # The time at which the last DNS fetch occurred.
        "discoveredIps": [ # The IPs found at the last DNS fetch.
          "A String",
        ],
        "certChallengeDns": { # Represents a DNS certificate challenge. # The DNS challenge for generating a certificate.
          "token": "A String", # The value that must be present as a TXT record on the domain name to
              # satisfy the challenge.
          "domainName": "A String", # The domain name upon which the DNS challenge must be satisfied.
        },
        "dnsStatus": "A String", # The DNS record match status as of the last DNS fetch.
        "certStatus": "A String", # The certificate provisioning status; updated when Firebase Hosting
            # provisions an SSL certificate for the domain.
      },
    }

delete(name, x__xgafv=None)

Deletes the existing domain mapping on the specified site.

Args:
  name: string, Required. The name of the domain association to delete. (required)
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # A generic empty message that you can re-use to avoid defining duplicated
      # empty messages in your APIs. A typical example is to use it as the request
      # or the response type of an API method. For instance:
      #
      #     service Foo {
      #       rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty);
      #     }
      #
      # The JSON representation for `Empty` is empty JSON object `{}`.
  }

get(name, x__xgafv=None)

Gets a domain mapping on the specified site.

Args:
name: string, Required. The name of the domain configuration to get. (required)
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format

Returns:
An object of the form:

{ # The intended behavior and status information of a domain.
"status": "A String", # Output only. Additional status of the domain association.
"domainRedirect": { # Defines the behavior of a domain-level redirect. Domain redirects preserve # If set, the domain should redirect with the provided parameters.
# the path of the redirect but replace the requested domain with the one
# specified in the redirect configuration.
"type": "A String", # Required. The redirect status code.
"domainName": "A String", # Required. The domain name to redirect to.
},
"domainName": "A String", # Required. The domain name of the association.
"site": "A String", # Required. The site name of the association.
"updateTime": "A String", # Output only. The time at which the domain was last updated.
"provisioning": { # The current certificate provisioning status information for a domain. # Output only. Information about the provisioning of certificates and the
# health of the DNS resolution for the domain.
"certChallengeHttp": { # Represents an HTTP certificate challenge. # The HTTP challenge for generating a certificate.
"path": "A String", # The URL path on which to serve the specified token to satisfy the
# certificate challenge.
"token": "A String", # The token to serve at the specified URL path to satisfy the certificate
# challenge.
},
"expectedIps": [ # The list of IPs to which the domain is expected to resolve.
"A String",
],
"certChallengeDiscoveredTxt": [ # The TXT records (for the certificate challenge) that were found at the last
# DNS fetch.
"A String",
],
"dnsFetchTime": "A String", # The time at which the last DNS fetch occurred.
"discoveredIps": [ # The IPs found at the last DNS fetch.
"A String",
],
"certChallengeDns": { # Represents a DNS certificate challenge. # The DNS challenge for generating a certificate.
"token": "A String", # The value that must be present as a TXT record on the domain name to
# satisfy the challenge.
"domainName": "A String", # The domain name upon which the DNS challenge must be satisfied.
},
"dnsStatus": "A String", # The DNS record match status as of the last DNS fetch.
"certStatus": "A String", # The certificate provisioning status; updated when Firebase Hosting
# provisions an SSL certificate for the domain.
},
}

list(parent, pageToken=None, x__xgafv=None, pageSize=None)

Lists the domains for the specified site.

Args:
  parent: string, Required. The parent for which to list domains, in the format:
sites/site-name (required)
  pageToken: string, The next_page_token from a previous request, if provided.
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format
  pageSize: integer, The page size to return. Defaults to 50.

Returns:
  An object of the form:

    {
    "nextPageToken": "A String", # The pagination token, if more results exist.
    "domains": [ # The list of domains, if any exist.
      { # The intended behavior and status information of a domain.
          "status": "A String", # Output only. Additional status of the domain association.
          "domainRedirect": { # Defines the behavior of a domain-level redirect. Domain redirects preserve # If set, the domain should redirect with the provided parameters.
              # the path of the redirect but replace the requested domain with the one
              # specified in the redirect configuration.
            "type": "A String", # Required. The redirect status code.
            "domainName": "A String", # Required. The domain name to redirect to.
          },
          "domainName": "A String", # Required. The domain name of the association.
          "site": "A String", # Required. The site name of the association.
          "updateTime": "A String", # Output only. The time at which the domain was last updated.
          "provisioning": { # The current certificate provisioning status information for a domain. # Output only. Information about the provisioning of certificates and the
              # health of the DNS resolution for the domain.
            "certChallengeHttp": { # Represents an HTTP certificate challenge. # The HTTP challenge for generating a certificate.
              "path": "A String", # The URL path on which to serve the specified token to satisfy the
                  # certificate challenge.
              "token": "A String", # The token to serve at the specified URL path to satisfy the certificate
                  # challenge.
            },
            "expectedIps": [ # The list of IPs to which the domain is expected to resolve.
              "A String",
            ],
            "certChallengeDiscoveredTxt": [ # The TXT records (for the certificate challenge) that were found at the last
                # DNS fetch.
              "A String",
            ],
            "dnsFetchTime": "A String", # The time at which the last DNS fetch occurred.
            "discoveredIps": [ # The IPs found at the last DNS fetch.
              "A String",
            ],
            "certChallengeDns": { # Represents a DNS certificate challenge. # The DNS challenge for generating a certificate.
              "token": "A String", # The value that must be present as a TXT record on the domain name to
                  # satisfy the challenge.
              "domainName": "A String", # The domain name upon which the DNS challenge must be satisfied.
            },
            "dnsStatus": "A String", # The DNS record match status as of the last DNS fetch.
            "certStatus": "A String", # The certificate provisioning status; updated when Firebase Hosting
                # provisions an SSL certificate for the domain.
          },
        },
    ],
  }

list_next(previous_request, previous_response)

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.

update(name, body, x__xgafv=None)

Updates the specified domain mapping, creating the mapping as if it does
not exist.

Args:
name: string, Required. The name of the domain association to update or create, if an
association doesn't already exist. (required)
body: object, The request body. (required)
The object takes the form of:

{ # The intended behavior and status information of a domain.
"status": "A String", # Output only. Additional status of the domain association.
"domainRedirect": { # Defines the behavior of a domain-level redirect. Domain redirects preserve # If set, the domain should redirect with the provided parameters.
# the path of the redirect but replace the requested domain with the one
# specified in the redirect configuration.
"type": "A String", # Required. The redirect status code.
"domainName": "A String", # Required. The domain name to redirect to.
},
"domainName": "A String", # Required. The domain name of the association.
"site": "A String", # Required. The site name of the association.
"updateTime": "A String", # Output only. The time at which the domain was last updated.
"provisioning": { # The current certificate provisioning status information for a domain. # Output only. Information about the provisioning of certificates and the
# health of the DNS resolution for the domain.
"certChallengeHttp": { # Represents an HTTP certificate challenge. # The HTTP challenge for generating a certificate.
"path": "A String", # The URL path on which to serve the specified token to satisfy the
# certificate challenge.
"token": "A String", # The token to serve at the specified URL path to satisfy the certificate
# challenge.
},
"expectedIps": [ # The list of IPs to which the domain is expected to resolve.
"A String",
],
"certChallengeDiscoveredTxt": [ # The TXT records (for the certificate challenge) that were found at the last
# DNS fetch.
"A String",
],
"dnsFetchTime": "A String", # The time at which the last DNS fetch occurred.
"discoveredIps": [ # The IPs found at the last DNS fetch.
"A String",
],
"certChallengeDns": { # Represents a DNS certificate challenge. # The DNS challenge for generating a certificate.
"token": "A String", # The value that must be present as a TXT record on the domain name to
# satisfy the challenge.
"domainName": "A String", # The domain name upon which the DNS challenge must be satisfied.
},
"dnsStatus": "A String", # The DNS record match status as of the last DNS fetch.
"certStatus": "A String", # The certificate provisioning status; updated when Firebase Hosting
# provisions an SSL certificate for the domain.
},
}

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

Returns:
An object of the form:

{ # The intended behavior and status information of a domain.
"status": "A String", # Output only. Additional status of the domain association.
"domainRedirect": { # Defines the behavior of a domain-level redirect. Domain redirects preserve # If set, the domain should redirect with the provided parameters.
# the path of the redirect but replace the requested domain with the one
# specified in the redirect configuration.
"type": "A String", # Required. The redirect status code.
"domainName": "A String", # Required. The domain name to redirect to.
},
"domainName": "A String", # Required. The domain name of the association.
"site": "A String", # Required. The site name of the association.
"updateTime": "A String", # Output only. The time at which the domain was last updated.
"provisioning": { # The current certificate provisioning status information for a domain. # Output only. Information about the provisioning of certificates and the
# health of the DNS resolution for the domain.
"certChallengeHttp": { # Represents an HTTP certificate challenge. # The HTTP challenge for generating a certificate.
"path": "A String", # The URL path on which to serve the specified token to satisfy the
# certificate challenge.
"token": "A String", # The token to serve at the specified URL path to satisfy the certificate
# challenge.
},
"expectedIps": [ # The list of IPs to which the domain is expected to resolve.
"A String",
],
"certChallengeDiscoveredTxt": [ # The TXT records (for the certificate challenge) that were found at the last
# DNS fetch.
"A String",
],
"dnsFetchTime": "A String", # The time at which the last DNS fetch occurred.
"discoveredIps": [ # The IPs found at the last DNS fetch.
"A String",
],
"certChallengeDns": { # Represents a DNS certificate challenge. # The DNS challenge for generating a certificate.
"token": "A String", # The value that must be present as a TXT record on the domain name to
# satisfy the challenge.
"domainName": "A String", # The domain name upon which the DNS challenge must be satisfied.
},
"dnsStatus": "A String", # The DNS record match status as of the last DNS fetch.
"certStatus": "A String", # The certificate provisioning status; updated when Firebase Hosting
# provisions an SSL certificate for the domain.
},
}

Firebase Hosting API . sites . domains

Instance Methods

Method Details