Google Cloud Managed Identities V1 Client - Class Trust (1.0.5)

Reference documentation and code samples for the Google Cloud Managed Identities V1 Client class Trust.

Represents a relationship between two domains. This allows a controller in one domain to authenticate a user in another domain.

Generated from protobuf message google.cloud.managedidentities.v1.Trust

Methods

__construct

Constructor.

Parameters
NameDescription
data array

Optional. Data for populating the Message object.

↳ target_domain_name string

Required. The fully qualified target domain name which will be in trust with the current domain.

↳ trust_type int

Required. The type of trust represented by the trust resource.

↳ trust_direction int

Required. The trust direction, which decides if the current domain is trusted, trusting, or both.

↳ selective_authentication bool

Optional. The trust authentication type, which decides whether the trusted side has forest/domain wide access or selective access to an approved set of resources.

↳ target_dns_ip_addresses array

Required. The target DNS server IP addresses which can resolve the remote domain involved in the trust.

↳ trust_handshake_secret string

Required. The trust secret used for the handshake with the target domain. This will not be stored.

↳ create_time Google\Protobuf\Timestamp

Output only. The time the instance was created.

↳ update_time Google\Protobuf\Timestamp

Output only. The last update time.

↳ state int

Output only. The current state of the trust.

↳ state_description string

Output only. Additional information about the current state of the trust, if available.

↳ last_trust_heartbeat_time Google\Protobuf\Timestamp

Output only. The last heartbeat time when the trust was known to be connected.

getTargetDomainName

Required. The fully qualified target domain name which will be in trust with the current domain.

Returns
TypeDescription
string

setTargetDomainName

Required. The fully qualified target domain name which will be in trust with the current domain.

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getTrustType

Required. The type of trust represented by the trust resource.

Returns
TypeDescription
int

setTrustType

Required. The type of trust represented by the trust resource.

Parameter
NameDescription
var int
Returns
TypeDescription
$this

getTrustDirection

Required. The trust direction, which decides if the current domain is trusted, trusting, or both.

Returns
TypeDescription
int

setTrustDirection

Required. The trust direction, which decides if the current domain is trusted, trusting, or both.

Parameter
NameDescription
var int
Returns
TypeDescription
$this

getSelectiveAuthentication

Optional. The trust authentication type, which decides whether the trusted side has forest/domain wide access or selective access to an approved set of resources.

Returns
TypeDescription
bool

setSelectiveAuthentication

Optional. The trust authentication type, which decides whether the trusted side has forest/domain wide access or selective access to an approved set of resources.

Parameter
NameDescription
var bool
Returns
TypeDescription
$this

getTargetDnsIpAddresses

Required. The target DNS server IP addresses which can resolve the remote domain involved in the trust.

Returns
TypeDescription
Google\Protobuf\Internal\RepeatedField

setTargetDnsIpAddresses

Required. The target DNS server IP addresses which can resolve the remote domain involved in the trust.

Parameter
NameDescription
var string[]
Returns
TypeDescription
$this

getTrustHandshakeSecret

Required. The trust secret used for the handshake with the target domain. This will not be stored.

Returns
TypeDescription
string

setTrustHandshakeSecret

Required. The trust secret used for the handshake with the target domain. This will not be stored.

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getCreateTime

Output only. The time the instance was created.

Returns
TypeDescription
Google\Protobuf\Timestamp|null

hasCreateTime

clearCreateTime

setCreateTime

Output only. The time the instance was created.

Parameter
NameDescription
var Google\Protobuf\Timestamp
Returns
TypeDescription
$this

getUpdateTime

Output only. The last update time.

Returns
TypeDescription
Google\Protobuf\Timestamp|null

hasUpdateTime

clearUpdateTime

setUpdateTime

Output only. The last update time.

Parameter
NameDescription
var Google\Protobuf\Timestamp
Returns
TypeDescription
$this

getState

Output only. The current state of the trust.

Returns
TypeDescription
int

setState

Output only. The current state of the trust.

Parameter
NameDescription
var int
Returns
TypeDescription
$this

getStateDescription

Output only. Additional information about the current state of the trust, if available.

Returns
TypeDescription
string

setStateDescription

Output only. Additional information about the current state of the trust, if available.

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getLastTrustHeartbeatTime

Output only. The last heartbeat time when the trust was known to be connected.

Returns
TypeDescription
Google\Protobuf\Timestamp|null

hasLastTrustHeartbeatTime

clearLastTrustHeartbeatTime

setLastTrustHeartbeatTime

Output only. The last heartbeat time when the trust was known to be connected.

Parameter
NameDescription
var Google\Protobuf\Timestamp
Returns
TypeDescription
$this