Reference documentation and code samples for the Google Cloud Appengine Admin V1 Client class AuthorizedCertificate.
An SSL certificate that a user has been authorized to administer. A user is authorized to administer any certificate that applies to one of their authorized domains.
Generated from protobuf message google.appengine.v1.AuthorizedCertificate
Namespace
Google \ Cloud \ AppEngine \ V1Methods
__construct
Constructor.
| Parameters | |
|---|---|
| Name | Description |
data |
array
Optional. Data for populating the Message object. |
↳ name |
string
Full path to the |
↳ id |
string
Relative name of the certificate. This is a unique value autogenerated on |
↳ display_name |
string
The user-specified display name of the certificate. This is not guaranteed to be unique. Example: |
↳ domain_names |
array
Topmost applicable domains of this certificate. This certificate applies to these domains and their subdomains. Example: |
↳ expire_time |
Google\Protobuf\Timestamp
The time when this certificate expires. To update the renewal time on this certificate, upload an SSL certificate with a different expiration time using |
↳ certificate_raw_data |
CertificateRawData
The SSL certificate serving the |
↳ managed_certificate |
ManagedCertificate
Only applicable if this certificate is managed by App Engine. Managed certificates are tied to the lifecycle of a |
↳ visible_domain_mappings |
array
The full paths to user visible Domain Mapping resources that have this certificate mapped. Example: |
↳ domain_mappings_count |
int
Aggregate count of the ___domain mappings with this certificate mapped. This count includes ___domain mappings on applications for which the user does not have |
getName
Full path to the AuthorizedCertificate resource in the API. Example:
apps/myapp/authorizedCertificates/12345.
@OutputOnly
| Returns | |
|---|---|
| Type | Description |
string |
|
setName
Full path to the AuthorizedCertificate resource in the API. Example:
apps/myapp/authorizedCertificates/12345.
@OutputOnly
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getId
Relative name of the certificate. This is a unique value autogenerated
on AuthorizedCertificate resource creation. Example: 12345.
@OutputOnly
| Returns | |
|---|---|
| Type | Description |
string |
|
setId
Relative name of the certificate. This is a unique value autogenerated
on AuthorizedCertificate resource creation. Example: 12345.
@OutputOnly
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getDisplayName
The user-specified display name of the certificate. This is not
guaranteed to be unique. Example: My Certificate.
| Returns | |
|---|---|
| Type | Description |
string |
|
setDisplayName
The user-specified display name of the certificate. This is not
guaranteed to be unique. Example: My Certificate.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getDomainNames
Topmost applicable domains of this certificate. This certificate
applies to these domains and their subdomains. Example: example.com.
@OutputOnly
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Internal\RepeatedField |
|
setDomainNames
Topmost applicable domains of this certificate. This certificate
applies to these domains and their subdomains. Example: example.com.
@OutputOnly
| Parameter | |
|---|---|
| Name | Description |
var |
string[]
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getExpireTime
The time when this certificate expires. To update the renewal time on this
certificate, upload an SSL certificate with a different expiration time
using AuthorizedCertificates.UpdateAuthorizedCertificate.
@OutputOnly
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Timestamp|null |
|
hasExpireTime
clearExpireTime
setExpireTime
The time when this certificate expires. To update the renewal time on this
certificate, upload an SSL certificate with a different expiration time
using AuthorizedCertificates.UpdateAuthorizedCertificate.
@OutputOnly
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Protobuf\Timestamp
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getCertificateRawData
The SSL certificate serving the AuthorizedCertificate resource. This
must be obtained independently from a certificate authority.
| Returns | |
|---|---|
| Type | Description |
CertificateRawData|null |
|
hasCertificateRawData
clearCertificateRawData
setCertificateRawData
The SSL certificate serving the AuthorizedCertificate resource. This
must be obtained independently from a certificate authority.
| Parameter | |
|---|---|
| Name | Description |
var |
CertificateRawData
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getManagedCertificate
Only applicable if this certificate is managed by App Engine. Managed
certificates are tied to the lifecycle of a DomainMapping and cannot be
updated or deleted via the AuthorizedCertificates API. If this
certificate is manually administered by the user, this field will be empty.
@OutputOnly
| Returns | |
|---|---|
| Type | Description |
ManagedCertificate|null |
|
hasManagedCertificate
clearManagedCertificate
setManagedCertificate
Only applicable if this certificate is managed by App Engine. Managed
certificates are tied to the lifecycle of a DomainMapping and cannot be
updated or deleted via the AuthorizedCertificates API. If this
certificate is manually administered by the user, this field will be empty.
@OutputOnly
| Parameter | |
|---|---|
| Name | Description |
var |
ManagedCertificate
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getVisibleDomainMappings
The full paths to user visible Domain Mapping resources that have this
certificate mapped. Example: apps/myapp/domainMappings/example.com.
This may not represent the full list of mapped ___domain mappings if the user
does not have VIEWER permissions on all of the applications that have
this certificate mapped. See domain_mappings_count for a complete count.
Only returned by GET or LIST requests when specifically requested by
the view=FULL_CERTIFICATE option.
@OutputOnly
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Internal\RepeatedField |
|
setVisibleDomainMappings
The full paths to user visible Domain Mapping resources that have this
certificate mapped. Example: apps/myapp/domainMappings/example.com.
This may not represent the full list of mapped ___domain mappings if the user
does not have VIEWER permissions on all of the applications that have
this certificate mapped. See domain_mappings_count for a complete count.
Only returned by GET or LIST requests when specifically requested by
the view=FULL_CERTIFICATE option.
@OutputOnly
| Parameter | |
|---|---|
| Name | Description |
var |
string[]
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getDomainMappingsCount
Aggregate count of the ___domain mappings with this certificate mapped. This
count includes ___domain mappings on applications for which the user does not
have VIEWER permissions.
Only returned by GET or LIST requests when specifically requested by
the view=FULL_CERTIFICATE option.
@OutputOnly
| Returns | |
|---|---|
| Type | Description |
int |
|
setDomainMappingsCount
Aggregate count of the ___domain mappings with this certificate mapped. This
count includes ___domain mappings on applications for which the user does not
have VIEWER permissions.
Only returned by GET or LIST requests when specifically requested by
the view=FULL_CERTIFICATE option.
@OutputOnly
| Parameter | |
|---|---|
| Name | Description |
var |
int
|
| Returns | |
|---|---|
| Type | Description |
$this |
|