Google Cloud Telco Automation V1 Client - Class GetBlueprintRequest (1.0.1)

Reference documentation and code samples for the Google Cloud Telco Automation V1 Client class GetBlueprintRequest.

Request object for GetBlueprint.

Generated from protobuf message google.cloud.telcoautomation.v1.GetBlueprintRequest

Namespace

Google \ Cloud \ TelcoAutomation \ V1

Methods

__construct

Constructor.

Parameters
Name Description
data array

Optional. Data for populating the Message object.

↳ name string

Required. The name of the blueprint. Case 1: If the name provided in the request is {blueprint_id}@{revision_id}, then the revision with revision_id will be returned. Case 2: If the name provided in the request is {blueprint}, then the current state of the blueprint is returned.

↳ view int

Optional. Defines the type of view of the blueprint. When field is not present BLUEPRINT_VIEW_BASIC is considered as default.

getName

Required. The name of the blueprint.

Case 1: If the name provided in the request is {blueprint_id}@{revision_id}, then the revision with revision_id will be returned. Case 2: If the name provided in the request is {blueprint}, then the current state of the blueprint is returned.

Returns
Type Description
string

setName

Required. The name of the blueprint.

Case 1: If the name provided in the request is {blueprint_id}@{revision_id}, then the revision with revision_id will be returned. Case 2: If the name provided in the request is {blueprint}, then the current state of the blueprint is returned.

Parameter
Name Description
var string
Returns
Type Description
$this

getView

Optional. Defines the type of view of the blueprint.

When field is not present BLUEPRINT_VIEW_BASIC is considered as default.

Returns
Type Description
int

setView

Optional. Defines the type of view of the blueprint.

When field is not present BLUEPRINT_VIEW_BASIC is considered as default.

Parameter
Name Description
var int
Returns
Type Description
$this

static::build

Parameter
Name Description
name string

Required. The name of the blueprint. Case 1: If the name provided in the request is {blueprint_id}@{revision_id}, then the revision with revision_id will be returned. Case 2: If the name provided in the request is {blueprint}, then the current state of the blueprint is returned. Please see TelcoAutomationClient::blueprintName() for help formatting this field.

Returns
Type Description
GetBlueprintRequest