Google Cloud App Hub V1 Client - Class Service (0.1.3)

Reference documentation and code samples for the Google Cloud App Hub V1 Client class Service.

Service is an App Hub data model that contains a discovered service, which represents a network/api interface that exposes some functionality to clients for consumption over the network.

Generated from protobuf message google.cloud.apphub.v1.Service

Namespace

Google \ Cloud \ AppHub \ V1

Methods

__construct

Constructor.

Parameters
Name Description
data array

Optional. Data for populating the Message object.

↳ name string

Identifier. The resource name of a Service. Format: "projects/{host-project-id}/locations/{location}/applications/{application-id}/services/{service-id}"

↳ display_name string

Optional. User-defined name for the Service. Can have a maximum length of 63 characters.

↳ description string

Optional. User-defined description of a Service. Can have a maximum length of 2048 characters.

↳ service_reference Google\Cloud\AppHub\V1\ServiceReference

Output only. Reference to an underlying networking resource that can comprise a Service. These are immutable.

↳ service_properties Google\Cloud\AppHub\V1\ServiceProperties

Output only. Properties of an underlying compute resource that can comprise a Service. These are immutable.

↳ attributes Google\Cloud\AppHub\V1\Attributes

Optional. Consumer provided attributes.

↳ discovered_service string

Required. Immutable. The resource name of the original discovered service.

↳ create_time Google\Protobuf\Timestamp

Output only. Create time.

↳ update_time Google\Protobuf\Timestamp

Output only. Update time.

↳ uid string

Output only. A universally unique identifier (UUID) for the Service in the UUID4 format.

↳ state int

Output only. Service state.

getName

Identifier. The resource name of a Service. Format: "projects/{host-project-id}/locations/{location}/applications/{application-id}/services/{service-id}"

Returns
Type Description
string

setName

Identifier. The resource name of a Service. Format: "projects/{host-project-id}/locations/{location}/applications/{application-id}/services/{service-id}"

Parameter
Name Description
var string
Returns
Type Description
$this

getDisplayName

Optional. User-defined name for the Service.

Can have a maximum length of 63 characters.

Returns
Type Description
string

setDisplayName

Optional. User-defined name for the Service.

Can have a maximum length of 63 characters.

Parameter
Name Description
var string
Returns
Type Description
$this

getDescription

Optional. User-defined description of a Service.

Can have a maximum length of 2048 characters.

Returns
Type Description
string

setDescription

Optional. User-defined description of a Service.

Can have a maximum length of 2048 characters.

Parameter
Name Description
var string
Returns
Type Description
$this

getServiceReference

Output only. Reference to an underlying networking resource that can comprise a Service. These are immutable.

Returns
Type Description
Google\Cloud\AppHub\V1\ServiceReference|null

hasServiceReference

clearServiceReference

setServiceReference

Output only. Reference to an underlying networking resource that can comprise a Service. These are immutable.

Parameter
Name Description
var Google\Cloud\AppHub\V1\ServiceReference
Returns
Type Description
$this

getServiceProperties

Output only. Properties of an underlying compute resource that can comprise a Service. These are immutable.

Returns
Type Description
Google\Cloud\AppHub\V1\ServiceProperties|null

hasServiceProperties

clearServiceProperties

setServiceProperties

Output only. Properties of an underlying compute resource that can comprise a Service. These are immutable.

Parameter
Name Description
var Google\Cloud\AppHub\V1\ServiceProperties
Returns
Type Description
$this

getAttributes

Optional. Consumer provided attributes.

Returns
Type Description
Google\Cloud\AppHub\V1\Attributes|null

hasAttributes

clearAttributes

setAttributes

Optional. Consumer provided attributes.

Parameter
Name Description
var Google\Cloud\AppHub\V1\Attributes
Returns
Type Description
$this

getDiscoveredService

Required. Immutable. The resource name of the original discovered service.

Returns
Type Description
string

setDiscoveredService

Required. Immutable. The resource name of the original discovered service.

Parameter
Name Description
var string
Returns
Type Description
$this

getCreateTime

Output only. Create time.

Returns
Type Description
Google\Protobuf\Timestamp|null

hasCreateTime

clearCreateTime

setCreateTime

Output only. Create time.

Parameter
Name Description
var Google\Protobuf\Timestamp
Returns
Type Description
$this

getUpdateTime

Output only. Update time.

Returns
Type Description
Google\Protobuf\Timestamp|null

hasUpdateTime

clearUpdateTime

setUpdateTime

Output only. Update time.

Parameter
Name Description
var Google\Protobuf\Timestamp
Returns
Type Description
$this

getUid

Output only. A universally unique identifier (UUID) for the Service in the UUID4 format.

Returns
Type Description
string

setUid

Output only. A universally unique identifier (UUID) for the Service in the UUID4 format.

Parameter
Name Description
var string
Returns
Type Description
$this

getState

Output only. Service state.

Returns
Type Description
int

setState

Output only. Service state.

Parameter
Name Description
var int
Returns
Type Description
$this