Google Cloud Game Servers V1 Client - Class Realm (1.0.5)

Reference documentation and code samples for the Google Cloud Game Servers V1 Client class Realm.

A realm resource.

Generated from protobuf message google.cloud.gaming.v1.Realm

Methods

__construct

Constructor.

Parameters
NameDescription
data array

Optional. Data for populating the Message object.

↳ name string

The resource name of the realm, in the following form: projects/{project}/locations/{location}/realms/{realm}. For example, projects/my-project/locations/{location}/realms/my-realm.

↳ create_time Google\Protobuf\Timestamp

Output only. The creation time.

↳ update_time Google\Protobuf\Timestamp

Output only. The last-modified time.

↳ labels array|Google\Protobuf\Internal\MapField

The labels associated with this realm. Each label is a key-value pair.

↳ time_zone string

Required. Time zone where all policies targeting this realm are evaluated. The value of this field must be from the IANA time zone database: https://www.iana.org/time-zones.

↳ etag string

ETag of the resource.

↳ description string

Human readable description of the realm.

getName

The resource name of the realm, in the following form: projects/{project}/locations/{location}/realms/{realm}. For example, projects/my-project/locations/{location}/realms/my-realm.

Returns
TypeDescription
string

setName

The resource name of the realm, in the following form: projects/{project}/locations/{location}/realms/{realm}. For example, projects/my-project/locations/{location}/realms/my-realm.

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getCreateTime

Output only. The creation time.

Returns
TypeDescription
Google\Protobuf\Timestamp|null

hasCreateTime

clearCreateTime

setCreateTime

Output only. The creation time.

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

getUpdateTime

Output only. The last-modified time.

Returns
TypeDescription
Google\Protobuf\Timestamp|null

hasUpdateTime

clearUpdateTime

setUpdateTime

Output only. The last-modified time.

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

getLabels

The labels associated with this realm. Each label is a key-value pair.

Returns
TypeDescription
Google\Protobuf\Internal\MapField

setLabels

The labels associated with this realm. Each label is a key-value pair.

Parameter
NameDescription
var array|Google\Protobuf\Internal\MapField
Returns
TypeDescription
$this

getTimeZone

Required. Time zone where all policies targeting this realm are evaluated. The value of this field must be from the IANA time zone database: https://www.iana.org/time-zones.

Returns
TypeDescription
string

setTimeZone

Required. Time zone where all policies targeting this realm are evaluated. The value of this field must be from the IANA time zone database: https://www.iana.org/time-zones.

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getEtag

ETag of the resource.

Returns
TypeDescription
string

setEtag

ETag of the resource.

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getDescription

Human readable description of the realm.

Returns
TypeDescription
string

setDescription

Human readable description of the realm.

Parameter
NameDescription
var string
Returns
TypeDescription
$this