Compute V1 Client - Class BackendServiceIAP (1.6.1)

Reference documentation and code samples for the Compute V1 Client class BackendServiceIAP.

Identity-Aware Proxy

Generated from protobuf message google.cloud.compute.v1.BackendServiceIAP

Methods

__construct

Constructor.

Parameters
NameDescription
data array

Optional. Data for populating the Message object.

↳ enabled bool

Whether the serving infrastructure will authenticate and authorize all incoming requests. If true, the oauth2ClientId and oauth2ClientSecret fields must be non-empty.

↳ oauth2_client_id string

OAuth2 client ID to use for the authentication flow.

↳ oauth2_client_secret string

OAuth2 client secret to use for the authentication flow. For security reasons, this value cannot be retrieved via the API. Instead, the SHA-256 hash of the value is returned in the oauth2ClientSecretSha256 field. @InputOnly

↳ oauth2_client_secret_sha256 string

[Output Only] SHA256 hash value for the field oauth2_client_secret above.

getEnabled

Whether the serving infrastructure will authenticate and authorize all incoming requests. If true, the oauth2ClientId and oauth2ClientSecret fields must be non-empty.

Returns
TypeDescription
bool

hasEnabled

clearEnabled

setEnabled

Whether the serving infrastructure will authenticate and authorize all incoming requests. If true, the oauth2ClientId and oauth2ClientSecret fields must be non-empty.

Parameter
NameDescription
var bool
Returns
TypeDescription
$this

getOauth2ClientId

OAuth2 client ID to use for the authentication flow.

Returns
TypeDescription
string

hasOauth2ClientId

clearOauth2ClientId

setOauth2ClientId

OAuth2 client ID to use for the authentication flow.

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getOauth2ClientSecret

OAuth2 client secret to use for the authentication flow. For security reasons, this value cannot be retrieved via the API. Instead, the SHA-256 hash of the value is returned in the oauth2ClientSecretSha256 field. @InputOnly

Returns
TypeDescription
string

hasOauth2ClientSecret

clearOauth2ClientSecret

setOauth2ClientSecret

OAuth2 client secret to use for the authentication flow. For security reasons, this value cannot be retrieved via the API. Instead, the SHA-256 hash of the value is returned in the oauth2ClientSecretSha256 field. @InputOnly

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getOauth2ClientSecretSha256

[Output Only] SHA256 hash value for the field oauth2_client_secret above.

Returns
TypeDescription
string

hasOauth2ClientSecretSha256

clearOauth2ClientSecretSha256

setOauth2ClientSecretSha256

[Output Only] SHA256 hash value for the field oauth2_client_secret above.

Parameter
NameDescription
var string
Returns
TypeDescription
$this