Reference documentation and code samples for the Google Cloud Saas Platform Saas Service Mgmt V1 Client class CreateTenantRequest.
The request structure for the CreateTenant method.
Generated from protobuf message google.cloud.saasplatform.saasservicemgmt.v1.CreateTenantRequest
Namespace
Google \ Cloud \ SaasPlatform \ SaasServiceMgmt \ V1Methods
__construct
Constructor.
| Parameters | |
|---|---|
| Name | Description |
data |
array
Optional. Data for populating the Message object. |
↳ parent |
string
Required. The parent of the tenant. |
↳ tenant_id |
string
Required. The ID value for the new tenant. |
↳ tenant |
Tenant
Required. The desired state for the tenant. |
↳ validate_only |
bool
If "validate_only" is set to true, the service will try to validate that this request would succeed, but will not actually make changes. |
↳ request_id |
string
An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). |
getParent
Required. The parent of the tenant.
| Returns | |
|---|---|
| Type | Description |
string |
|
setParent
Required. The parent of the tenant.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getTenantId
Required. The ID value for the new tenant.
| Returns | |
|---|---|
| Type | Description |
string |
|
setTenantId
Required. The ID value for the new tenant.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getTenant
Required. The desired state for the tenant.
| Returns | |
|---|---|
| Type | Description |
Tenant|null |
|
hasTenant
clearTenant
setTenant
Required. The desired state for the tenant.
| Parameter | |
|---|---|
| Name | Description |
var |
Tenant
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getValidateOnly
If "validate_only" is set to true, the service will try to validate that this request would succeed, but will not actually make changes.
| Returns | |
|---|---|
| Type | Description |
bool |
|
setValidateOnly
If "validate_only" is set to true, the service will try to validate that this request would succeed, but will not actually make changes.
| Parameter | |
|---|---|
| Name | Description |
var |
bool
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getRequestId
An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request.
For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).
| Returns | |
|---|---|
| Type | Description |
string |
|
setRequestId
An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request.
For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
static::build
| Parameters | |
|---|---|
| Name | Description |
parent |
string
Required. The parent of the tenant. Please see SaasDeploymentsClient::locationName() for help formatting this field. |
tenant |
Tenant
Required. The desired state for the tenant. |
tenantId |
string
Required. The ID value for the new tenant. |
| Returns | |
|---|---|
| Type | Description |
CreateTenantRequest |
|