Interface CreateHcxActivationKeyRequestOrBuilder (0.10.0)

public interface CreateHcxActivationKeyRequestOrBuilder extends MessageOrBuilder

Implements

MessageOrBuilder

Methods

getHcxActivationKey()

public abstract HcxActivationKey getHcxActivationKey()

Required. The initial description of a new HCX activation key. When creating a new key, this field must be an empty object.

.google.cloud.vmwareengine.v1.HcxActivationKey hcx_activation_key = 2 [(.google.api.field_behavior) = REQUIRED];

Returns
TypeDescription
HcxActivationKey

The hcxActivationKey.

getHcxActivationKeyId()

public abstract String getHcxActivationKeyId()

Required. The user-provided identifier of the HcxActivationKey to be created. This identifier must be unique among HcxActivationKey resources within the parent and becomes the final token in the name URI. The identifier must meet the following requirements:

  • Only contains 1-63 alphanumeric characters and hyphens
  • Begins with an alphabetical character
  • Ends with a non-hyphen character
  • Not formatted as a UUID
  • Complies with RFC 1034 (section 3.5)

string hcx_activation_key_id = 3 [(.google.api.field_behavior) = REQUIRED];

Returns
TypeDescription
String

The hcxActivationKeyId.

getHcxActivationKeyIdBytes()

public abstract ByteString getHcxActivationKeyIdBytes()

Required. The user-provided identifier of the HcxActivationKey to be created. This identifier must be unique among HcxActivationKey resources within the parent and becomes the final token in the name URI. The identifier must meet the following requirements:

  • Only contains 1-63 alphanumeric characters and hyphens
  • Begins with an alphabetical character
  • Ends with a non-hyphen character
  • Not formatted as a UUID
  • Complies with RFC 1034 (section 3.5)

string hcx_activation_key_id = 3 [(.google.api.field_behavior) = REQUIRED];

Returns
TypeDescription
ByteString

The bytes for hcxActivationKeyId.

getHcxActivationKeyOrBuilder()

public abstract HcxActivationKeyOrBuilder getHcxActivationKeyOrBuilder()

Required. The initial description of a new HCX activation key. When creating a new key, this field must be an empty object.

.google.cloud.vmwareengine.v1.HcxActivationKey hcx_activation_key = 2 [(.google.api.field_behavior) = REQUIRED];

Returns
TypeDescription
HcxActivationKeyOrBuilder

getParent()

public abstract String getParent()

Required. The resource name of the private cloud to create the key for. Resource names are schemeless URIs that follow the conventions in https://cloud.google.com/apis/design/resource_names. For example: projects/my-project/locations/us-central1/privateClouds/my-cloud

string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }

Returns
TypeDescription
String

The parent.

getParentBytes()

public abstract ByteString getParentBytes()

Required. The resource name of the private cloud to create the key for. Resource names are schemeless URIs that follow the conventions in https://cloud.google.com/apis/design/resource_names. For example: projects/my-project/locations/us-central1/privateClouds/my-cloud

string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }

Returns
TypeDescription
ByteString

The bytes for parent.

getRequestId()

public abstract String getRequestId()

A 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 guarantees that a request doesn't result in creation of duplicate commitments for at least 60 minutes. 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).

string request_id = 4;

Returns
TypeDescription
String

The requestId.

getRequestIdBytes()

public abstract ByteString getRequestIdBytes()

A 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 guarantees that a request doesn't result in creation of duplicate commitments for at least 60 minutes. 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).

string request_id = 4;

Returns
TypeDescription
ByteString

The bytes for requestId.

hasHcxActivationKey()

public abstract boolean hasHcxActivationKey()

Required. The initial description of a new HCX activation key. When creating a new key, this field must be an empty object.

.google.cloud.vmwareengine.v1.HcxActivationKey hcx_activation_key = 2 [(.google.api.field_behavior) = REQUIRED];

Returns
TypeDescription
boolean

Whether the hcxActivationKey field is set.