mirror of
https://github.com/ansible-collections/google.cloud.git
synced 2025-06-05 08:29:10 -07:00
Return values should be camelcase instead of underscored (#95)
This commit is contained in:
The Magician
Alex Stephen
parent
2a6c1e408e
commit
b3c1afe126
71 changed files with 6574 additions and 6906 deletions
|
|
@ -210,214 +210,202 @@ EXAMPLES = '''
|
|||
'''
|
||||
|
||||
RETURN = '''
|
||||
archiveSizeBytes:
|
||||
description:
|
||||
- Size of the image tar.gz archive stored in Google Cloud Storage (in bytes).
|
||||
returned: success
|
||||
type: int
|
||||
creationTimestamp:
|
||||
description:
|
||||
- Creation timestamp in RFC3339 text format.
|
||||
returned: success
|
||||
type: str
|
||||
deprecated:
|
||||
description:
|
||||
- The deprecation status associated with this image.
|
||||
returned: success
|
||||
type: complex
|
||||
contains:
|
||||
deleted:
|
||||
description:
|
||||
- An optional RFC3339 timestamp on or after which the state of this resource
|
||||
is intended to change to DELETED. This is only informational and the status
|
||||
will not change unless the client explicitly changes it.
|
||||
returned: success
|
||||
type: str
|
||||
archiveSizeBytes:
|
||||
description:
|
||||
- Size of the image tar.gz archive stored in Google Cloud Storage (in bytes).
|
||||
returned: success
|
||||
type: int
|
||||
creationTimestamp:
|
||||
description:
|
||||
- Creation timestamp in RFC3339 text format.
|
||||
returned: success
|
||||
type: str
|
||||
deprecated:
|
||||
description:
|
||||
- An optional RFC3339 timestamp on or after which the state of this resource
|
||||
is intended to change to DEPRECATED. This is only informational and the status
|
||||
will not change unless the client explicitly changes it.
|
||||
returned: success
|
||||
type: str
|
||||
obsolete:
|
||||
description:
|
||||
- An optional RFC3339 timestamp on or after which the state of this resource
|
||||
is intended to change to OBSOLETE. This is only informational and the status
|
||||
will not change unless the client explicitly changes it.
|
||||
returned: success
|
||||
type: str
|
||||
replacement:
|
||||
description:
|
||||
- The URL of the suggested replacement for a deprecated resource.
|
||||
- The suggested replacement resource must be the same kind of resource as the
|
||||
deprecated resource.
|
||||
returned: success
|
||||
type: str
|
||||
state:
|
||||
description:
|
||||
- The deprecation state of this resource. This can be DEPRECATED, OBSOLETE,
|
||||
or DELETED. Operations which create a new resource using a DEPRECATED resource
|
||||
will return successfully, but with a warning indicating the deprecated resource
|
||||
and recommending its replacement. Operations which use OBSOLETE or DELETED
|
||||
resources will be rejected and result in an error.
|
||||
returned: success
|
||||
type: str
|
||||
description:
|
||||
description:
|
||||
- An optional description of this resource. Provide this property when you create
|
||||
the resource.
|
||||
returned: success
|
||||
type: str
|
||||
diskSizeGb:
|
||||
description:
|
||||
- Size of the image when restored onto a persistent disk (in GB).
|
||||
returned: success
|
||||
type: int
|
||||
family:
|
||||
description:
|
||||
- The name of the image family to which this image belongs. You can create disks
|
||||
by specifying an image family instead of a specific image name. The image family
|
||||
always returns its latest image that is not deprecated. The name of the image
|
||||
family must comply with RFC1035.
|
||||
returned: success
|
||||
type: str
|
||||
guestOsFeatures:
|
||||
description:
|
||||
- A list of features to enable on the guest OS. Applicable for bootable images only.
|
||||
Currently, only one feature can be enabled, VIRTIO_SCSI_MULTIQUEUE, which allows
|
||||
each virtual CPU to have its own queue. For Windows images, you can only enable
|
||||
VIRTIO_SCSI_MULTIQUEUE on images with driver version 1.2.0.1621 or higher. Linux
|
||||
images with kernel versions 3.17 and higher will support VIRTIO_SCSI_MULTIQUEUE.
|
||||
- For new Windows images, the server might also populate this field with the value
|
||||
WINDOWS, to indicate that this is a Windows image.
|
||||
- This value is purely informational and does not enable or disable any features.
|
||||
returned: success
|
||||
type: complex
|
||||
contains:
|
||||
type:
|
||||
description:
|
||||
- The type of supported feature. Currenty only VIRTIO_SCSI_MULTIQUEUE is supported.
|
||||
For newer Windows images, the server might also populate this property with
|
||||
the value WINDOWS to indicate that this is a Windows image. This value is
|
||||
purely informational and does not enable or disable any features.
|
||||
returned: success
|
||||
type: str
|
||||
id:
|
||||
description:
|
||||
- The unique identifier for the resource. This identifier is defined by the server.
|
||||
returned: success
|
||||
type: int
|
||||
imageEncryptionKey:
|
||||
description:
|
||||
- Encrypts the image using a customer-supplied encryption key.
|
||||
- After you encrypt an image with a customer-supplied key, you must provide the
|
||||
same key if you use the image later (e.g. to create a disk from the image) .
|
||||
returned: success
|
||||
type: complex
|
||||
contains:
|
||||
rawKey:
|
||||
description:
|
||||
- Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648
|
||||
base64 to either encrypt or decrypt this resource.
|
||||
returned: success
|
||||
type: str
|
||||
sha256:
|
||||
description:
|
||||
- The RFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption
|
||||
key that protects this resource.
|
||||
returned: success
|
||||
type: str
|
||||
labels:
|
||||
description:
|
||||
- Labels to apply to this Image.
|
||||
returned: success
|
||||
type: dict
|
||||
labelFingerprint:
|
||||
description:
|
||||
- The fingerprint used for optimistic locking of this resource. Used internally
|
||||
during updates.
|
||||
returned: success
|
||||
type: str
|
||||
licenses:
|
||||
description:
|
||||
- Any applicable license URI.
|
||||
returned: success
|
||||
type: list
|
||||
name:
|
||||
description:
|
||||
- Name of the resource; provided by the client when the resource is created. The
|
||||
name must be 1-63 characters long, and comply with RFC1035. Specifically, the
|
||||
name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?`
|
||||
which means the first character must be a lowercase letter, and all following
|
||||
characters must be a dash, lowercase letter, or digit, except the last character,
|
||||
which cannot be a dash.
|
||||
returned: success
|
||||
type: str
|
||||
rawDisk:
|
||||
description:
|
||||
- The parameters of the raw disk image.
|
||||
returned: success
|
||||
type: complex
|
||||
contains:
|
||||
containerType:
|
||||
description:
|
||||
- The format used to encode and transmit the block device, which should be TAR.
|
||||
This is just a container and transmission format and not a runtime format.
|
||||
Provided by the client when the disk image is created.
|
||||
returned: success
|
||||
type: str
|
||||
sha1Checksum:
|
||||
description:
|
||||
- An optional SHA1 checksum of the disk image before unpackaging.
|
||||
- This is provided by the client when the disk image is created.
|
||||
returned: success
|
||||
type: str
|
||||
source:
|
||||
description:
|
||||
- The full Google Cloud Storage URL where disk storage is stored You must provide
|
||||
either this property or the sourceDisk property but not both.
|
||||
returned: success
|
||||
type: str
|
||||
sourceDisk:
|
||||
description:
|
||||
- The source disk to create this image based on.
|
||||
- You must provide either this property or the rawDisk.source property but not both
|
||||
to create an image.
|
||||
returned: success
|
||||
type: dict
|
||||
sourceDiskEncryptionKey:
|
||||
description:
|
||||
- The customer-supplied encryption key of the source disk. Required if the source
|
||||
disk is protected by a customer-supplied encryption key.
|
||||
returned: success
|
||||
type: complex
|
||||
contains:
|
||||
rawKey:
|
||||
description:
|
||||
- Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648
|
||||
base64 to either encrypt or decrypt this resource.
|
||||
returned: success
|
||||
type: str
|
||||
sha256:
|
||||
description:
|
||||
- The RFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption
|
||||
key that protects this resource.
|
||||
returned: success
|
||||
type: str
|
||||
sourceDiskId:
|
||||
description:
|
||||
- The ID value of the disk used to create this image. This value may be used to
|
||||
determine whether the image was taken from the current or a previous instance
|
||||
of a given disk name.
|
||||
returned: success
|
||||
type: str
|
||||
sourceType:
|
||||
description:
|
||||
- The type of the image used to create this disk. The default and only value is
|
||||
RAW .
|
||||
returned: success
|
||||
type: str
|
||||
description:
|
||||
- The deprecation status associated with this image.
|
||||
returned: success
|
||||
type: complex
|
||||
contains:
|
||||
deleted:
|
||||
description:
|
||||
- An optional RFC3339 timestamp on or after which the state of this resource is intended
|
||||
to change to DELETED. This is only informational and the status will not change
|
||||
unless the client explicitly changes it.
|
||||
returned: success
|
||||
type: str
|
||||
deprecated:
|
||||
description:
|
||||
- An optional RFC3339 timestamp on or after which the state of this resource is intended
|
||||
to change to DEPRECATED. This is only informational and the status will not change
|
||||
unless the client explicitly changes it.
|
||||
returned: success
|
||||
type: str
|
||||
obsolete:
|
||||
description:
|
||||
- An optional RFC3339 timestamp on or after which the state of this resource is intended
|
||||
to change to OBSOLETE. This is only informational and the status will not change
|
||||
unless the client explicitly changes it.
|
||||
returned: success
|
||||
type: str
|
||||
replacement:
|
||||
description:
|
||||
- The URL of the suggested replacement for a deprecated resource.
|
||||
- The suggested replacement resource must be the same kind of resource as the deprecated
|
||||
resource.
|
||||
returned: success
|
||||
type: str
|
||||
state:
|
||||
description:
|
||||
- The deprecation state of this resource. This can be DEPRECATED, OBSOLETE, or DELETED.
|
||||
Operations which create a new resource using a DEPRECATED resource will return successfully,
|
||||
but with a warning indicating the deprecated resource and recommending its replacement.
|
||||
Operations which use OBSOLETE or DELETED resources will be rejected and result in
|
||||
an error.
|
||||
returned: success
|
||||
type: str
|
||||
description:
|
||||
description:
|
||||
- An optional description of this resource. Provide this property when you create
|
||||
the resource.
|
||||
returned: success
|
||||
type: str
|
||||
diskSizeGb:
|
||||
description:
|
||||
- Size of the image when restored onto a persistent disk (in GB).
|
||||
returned: success
|
||||
type: int
|
||||
family:
|
||||
description:
|
||||
- The name of the image family to which this image belongs. You can create disks by
|
||||
specifying an image family instead of a specific image name. The image family always
|
||||
returns its latest image that is not deprecated. The name of the image family must
|
||||
comply with RFC1035.
|
||||
returned: success
|
||||
type: str
|
||||
guestOsFeatures:
|
||||
description:
|
||||
- A list of features to enable on the guest OS. Applicable for bootable images only.
|
||||
Currently, only one feature can be enabled, VIRTIO_SCSI_MULTIQUEUE, which allows
|
||||
each virtual CPU to have its own queue. For Windows images, you can only enable
|
||||
VIRTIO_SCSI_MULTIQUEUE on images with driver version 1.2.0.1621 or higher. Linux
|
||||
images with kernel versions 3.17 and higher will support VIRTIO_SCSI_MULTIQUEUE.
|
||||
- For new Windows images, the server might also populate this field with the value
|
||||
WINDOWS, to indicate that this is a Windows image.
|
||||
- This value is purely informational and does not enable or disable any features.
|
||||
returned: success
|
||||
type: complex
|
||||
contains:
|
||||
type:
|
||||
description:
|
||||
- The type of supported feature. Currenty only VIRTIO_SCSI_MULTIQUEUE is supported.
|
||||
For newer Windows images, the server might also populate this property with the
|
||||
value WINDOWS to indicate that this is a Windows image. This value is purely informational
|
||||
and does not enable or disable any features.
|
||||
returned: success
|
||||
type: str
|
||||
id:
|
||||
description:
|
||||
- The unique identifier for the resource. This identifier is defined by the server.
|
||||
returned: success
|
||||
type: int
|
||||
imageEncryptionKey:
|
||||
description:
|
||||
- Encrypts the image using a customer-supplied encryption key.
|
||||
- After you encrypt an image with a customer-supplied key, you must provide the same
|
||||
key if you use the image later (e.g. to create a disk from the image) .
|
||||
returned: success
|
||||
type: complex
|
||||
contains:
|
||||
rawKey:
|
||||
description:
|
||||
- Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64
|
||||
to either encrypt or decrypt this resource.
|
||||
returned: success
|
||||
type: str
|
||||
sha256:
|
||||
description:
|
||||
- The RFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption key
|
||||
that protects this resource.
|
||||
returned: success
|
||||
type: str
|
||||
licenses:
|
||||
description:
|
||||
- Any applicable license URI.
|
||||
returned: success
|
||||
type: list
|
||||
name:
|
||||
description:
|
||||
- Name of the resource; provided by the client when the resource is created. The name
|
||||
must be 1-63 characters long, and comply with RFC1035. Specifically, the name must
|
||||
be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?`
|
||||
which means the first character must be a lowercase letter, and all following characters
|
||||
must be a dash, lowercase letter, or digit, except the last character, which cannot
|
||||
be a dash.
|
||||
returned: success
|
||||
type: str
|
||||
rawDisk:
|
||||
description:
|
||||
- The parameters of the raw disk image.
|
||||
returned: success
|
||||
type: complex
|
||||
contains:
|
||||
containerType:
|
||||
description:
|
||||
- The format used to encode and transmit the block device, which should be TAR. This
|
||||
is just a container and transmission format and not a runtime format. Provided by
|
||||
the client when the disk image is created.
|
||||
returned: success
|
||||
type: str
|
||||
sha1Checksum:
|
||||
description:
|
||||
- An optional SHA1 checksum of the disk image before unpackaging.
|
||||
- This is provided by the client when the disk image is created.
|
||||
returned: success
|
||||
type: str
|
||||
source:
|
||||
description:
|
||||
- The full Google Cloud Storage URL where disk storage is stored You must provide
|
||||
either this property or the sourceDisk property but not both.
|
||||
returned: success
|
||||
type: str
|
||||
sourceDisk:
|
||||
description:
|
||||
- Refers to a gcompute_disk object You must provide either this property or the rawDisk.source
|
||||
property but not both to create an image.
|
||||
returned: success
|
||||
type: dict
|
||||
sourceDiskEncryptionKey:
|
||||
description:
|
||||
- The customer-supplied encryption key of the source disk. Required if the source
|
||||
disk is protected by a customer-supplied encryption key.
|
||||
returned: success
|
||||
type: complex
|
||||
contains:
|
||||
rawKey:
|
||||
description:
|
||||
- Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64
|
||||
to either encrypt or decrypt this resource.
|
||||
returned: success
|
||||
type: str
|
||||
sha256:
|
||||
description:
|
||||
- The RFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption key
|
||||
that protects this resource.
|
||||
returned: success
|
||||
type: str
|
||||
sourceDiskId:
|
||||
description:
|
||||
- The ID value of the disk used to create this image. This value may be used to determine
|
||||
whether the image was taken from the current or a previous instance of a given disk
|
||||
name.
|
||||
returned: success
|
||||
type: str
|
||||
sourceType:
|
||||
description:
|
||||
- The type of the image used to create this disk. The default and only value is RAW
|
||||
.
|
||||
returned: success
|
||||
type: str
|
||||
'''
|
||||
|
||||
################################################################################
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue