google-cloud-php-bigquery-analyticshub/src/V1/RevokeSubscriptionRequest.php at main · googleapis/google-cloud-php-bigquery-analyticshub · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
<?php
# Generated by the protocol buffer compiler.  DO NOT EDIT!
# source: google/cloud/bigquery/analyticshub/v1/analyticshub.proto

namespace Google\Cloud\BigQuery\AnalyticsHub\V1;

use Google\Protobuf\Internal\GPBType;
use Google\Protobuf\Internal\GPBUtil;
use Google\Protobuf\RepeatedField;

/**
 * Message for revoking a subscription.
 *
 * Generated from protobuf message <code>google.cloud.bigquery.analyticshub.v1.RevokeSubscriptionRequest</code>
 */
class RevokeSubscriptionRequest extends \Google\Protobuf\Internal\Message
{
    /**
     * Required. Resource name of the subscription to revoke.
     * e.g. projects/123/locations/us/subscriptions/456
     *
     * Generated from protobuf field <code>string name = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = {</code>
     */
    protected $name = '';
    /**
     * Optional. If the subscription is commercial then this field must be set to
     * true, otherwise a failure is thrown. This acts as a safety guard to avoid
     * revoking commercial subscriptions accidentally.
     *
     * Generated from protobuf field <code>bool revoke_commercial = 2 [(.google.api.field_behavior) = OPTIONAL];</code>
     */
    protected $revoke_commercial = false;

    /**
     * @param string $name Required. Resource name of the subscription to revoke.
     *                     e.g. projects/123/locations/us/subscriptions/456
     *                     Please see {@see AnalyticsHubServiceClient::subscriptionName()} for help formatting this field.
     *
     * @return \Google\Cloud\BigQuery\AnalyticsHub\V1\RevokeSubscriptionRequest
     *
     * @experimental
     */
    public static function build(string $name): self
    {
        return (new self())
            ->setName($name);
    }

    /**
     * Constructor.
     *
     * @param array $data {
     *     Optional. Data for populating the Message object.
     *
     *     @type string $name
     *           Required. Resource name of the subscription to revoke.
     *           e.g. projects/123/locations/us/subscriptions/456
     *     @type bool $revoke_commercial
     *           Optional. If the subscription is commercial then this field must be set to
     *           true, otherwise a failure is thrown. This acts as a safety guard to avoid
     *           revoking commercial subscriptions accidentally.
     * }
     */
    public function __construct($data = NULL) {
        \GPBMetadata\Google\Cloud\Bigquery\Analyticshub\V1\Analyticshub::initOnce();
        parent::__construct($data);
    }

    /**
     * Required. Resource name of the subscription to revoke.
     * e.g. projects/123/locations/us/subscriptions/456
     *
     * Generated from protobuf field <code>string name = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = {</code>
     * @return string
     */
    public function getName()
    {
        return $this->name;
    }

    /**
     * Required. Resource name of the subscription to revoke.
     * e.g. projects/123/locations/us/subscriptions/456
     *
     * Generated from protobuf field <code>string name = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = {</code>
     * @param string $var
     * @return $this
     */
    public function setName($var)
    {
        GPBUtil::checkString($var, True);
        $this->name = $var;

        return $this;
    }

    /**
     * Optional. If the subscription is commercial then this field must be set to
     * true, otherwise a failure is thrown. This acts as a safety guard to avoid
     * revoking commercial subscriptions accidentally.
     *
     * Generated from protobuf field <code>bool revoke_commercial = 2 [(.google.api.field_behavior) = OPTIONAL];</code>
     * @return bool
     */
    public function getRevokeCommercial()
    {
        return $this->revoke_commercial;
    }

    /**
     * Optional. If the subscription is commercial then this field must be set to
     * true, otherwise a failure is thrown. This acts as a safety guard to avoid
     * revoking commercial subscriptions accidentally.
     *
     * Generated from protobuf field <code>bool revoke_commercial = 2 [(.google.api.field_behavior) = OPTIONAL];</code>
     * @param bool $var
     * @return $this
     */
    public function setRevokeCommercial($var)
    {
        GPBUtil::checkBool($var);
        $this->revoke_commercial = $var;

        return $this;
    }

}