replications_internal

Creates, updates, deletes, gets or lists a replications_internal resource.

Overview

Name	replications_internal
Type	Resource
Id	google.saasservicemgmt.replications_internal

Fields

The following fields are returned by SELECT queries:

get

Name	Datatype	Description
name	string	Identifier. The resource name (full URI of the resource) following the standard naming scheme: "projects/{project}/locations/{location}/replicationInternal/{replication_internal_id}"
annotations	object	Optional. Annotations is an unstructured key-value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. More info: https://kubernetes.io/docs/user-guide/annotations
createTime	string (google-datetime)	Output only. The timestamp when the resource was created.
etag	string	Output only. An opaque value that uniquely identifies a version or generation of a resource. It can be used to confirm that the client and server agree on the ordering of a resource being written.
labels	object	Optional. The labels on the resource, which can be used for categorization. similar to Kubernetes resource labels.
maxRetryCount	integer (int32)	Optional. The maximum number of retries for the replication. If the replication fails from a retryable error, it will be retried for this number of times.
payload	object	Required. The payload of the request for replication. It could be any request type that is supported by the replication service. e.g. CreateUnitKindRequest, UpdateUnitKindRequest, DeleteReleaseRequest, etc.
state	string	Output only. The state of the replication.
stats	object	Output only. The stats of the replication. One key for each location in target_locations
targetLocations	array	Optional. The target locations to replicate the resource to.
uid	string	Output only. The unique identifier of the resource. UID is unique in the time and space for this resource within the scope of the service. It is typically generated by the server on successful creation of a resource and must not be changed. UID is used to uniquely identify resources with resource name reuses. This should be a UUID4.
updateTime	string (google-datetime)	Output only. The timestamp when the resource was last updated. Any change to the resource made by users must refresh this value. Changes to a resource made by the service should refresh this value.

list

Name	Datatype	Description

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	projectsId, locationsId, replicationsInternalId		Retrieve a single replication internal.
list	select	projectsId, locationsId	pageToken, orderBy, filter, pageSize	Retrieve a collection of replication internals.
create	insert	projectsId, locationsId	validateOnly, replicationInternalId, requestId	Create a new replication internal.
patch	update	projectsId, locationsId, replicationsInternalId	etag, updateMask, validateOnly, requestId	Update a single replication internal.
delete	delete	projectsId, locationsId, replicationsInternalId	requestId, etag, validateOnly	Delete a single replication internal.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
locationsId	string
projectsId	string
replicationsInternalId	string
etag	string
filter	string
orderBy	string
pageSize	integer (int32)
pageToken	string
replicationInternalId	string
requestId	string
updateMask	string (google-fieldmask)
validateOnly	boolean

SELECT examples

get

Retrieve a single replication internal.

SELECT
name,
annotations,
createTime,
etag,
labels,
maxRetryCount,
payload,
state,
stats,
targetLocations,
uid,
updateTime
FROM google.saasservicemgmt.replications_internal
WHERE projectsId = '{{ projectsId }}' -- required
AND locationsId = '{{ locationsId }}' -- required
AND replicationsInternalId = '{{ replicationsInternalId }}' -- required
;

list

Retrieve a collection of replication internals.

SELECT
*
FROM google.saasservicemgmt.replications_internal
WHERE projectsId = '{{ projectsId }}' -- required
AND locationsId = '{{ locationsId }}' -- required
AND pageToken = '{{ pageToken }}'
AND orderBy = '{{ orderBy }}'
AND filter = '{{ filter }}'
AND pageSize = '{{ pageSize }}'
;

INSERT examples

create

Create a new replication internal.

INSERT INTO google.saasservicemgmt.replications_internal (
data__name,
data__labels,
data__annotations,
data__payload,
data__targetLocations,
data__maxRetryCount,
projectsId,
locationsId,
validateOnly,
replicationInternalId,
requestId
)
SELECT 
'{{ name }}',
'{{ labels }}',
'{{ annotations }}',
'{{ payload }}',
'{{ targetLocations }}',
{{ maxRetryCount }},
'{{ projectsId }}',
'{{ locationsId }}',
'{{ validateOnly }}',
'{{ replicationInternalId }}',
'{{ requestId }}'
RETURNING
name,
annotations,
createTime,
etag,
labels,
maxRetryCount,
payload,
state,
stats,
targetLocations,
uid,
updateTime
;

Manifest

# Description fields are for documentation purposes
- name: replications_internal
  props:
    - name: projectsId
      value: string
      description: Required parameter for the replications_internal resource.
    - name: locationsId
      value: string
      description: Required parameter for the replications_internal resource.
    - name: name
      value: string
      description: >
        Identifier. The resource name (full URI of the resource) following the standard naming scheme: "projects/{project}/locations/{location}/replicationInternal/{replication_internal_id}"
        
    - name: labels
      value: object
      description: >
        Optional. The labels on the resource, which can be used for categorization. similar to Kubernetes resource labels.
        
    - name: annotations
      value: object
      description: >
        Optional. Annotations is an unstructured key-value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. More info: https://kubernetes.io/docs/user-guide/annotations
        
    - name: payload
      value: object
      description: >
        Required. The payload of the request for replication. It could be any request type that is supported by the replication service. e.g. CreateUnitKindRequest, UpdateUnitKindRequest, DeleteReleaseRequest, etc.
        
    - name: targetLocations
      value: array
      description: >
        Optional. The target locations to replicate the resource to.
        
    - name: maxRetryCount
      value: integer
      description: >
        Optional. The maximum number of retries for the replication. If the replication fails from a retryable error, it will be retried for this number of times.
        
    - name: validateOnly
      value: boolean
    - name: replicationInternalId
      value: string
    - name: requestId
      value: string

UPDATE examples

patch

Update a single replication internal.

UPDATE google.saasservicemgmt.replications_internal
SET 
data__name = '{{ name }}',
data__labels = '{{ labels }}',
data__annotations = '{{ annotations }}',
data__payload = '{{ payload }}',
data__targetLocations = '{{ targetLocations }}',
data__maxRetryCount = {{ maxRetryCount }}
WHERE 
projectsId = '{{ projectsId }}' --required
AND locationsId = '{{ locationsId }}' --required
AND replicationsInternalId = '{{ replicationsInternalId }}' --required
AND etag = '{{ etag}}'
AND updateMask = '{{ updateMask}}'
AND validateOnly = {{ validateOnly}}
AND requestId = '{{ requestId}}'
RETURNING
name,
annotations,
createTime,
etag,
labels,
maxRetryCount,
payload,
state,
stats,
targetLocations,
uid,
updateTime;

DELETE examples

delete

Delete a single replication internal.

DELETE FROM google.saasservicemgmt.replications_internal
WHERE projectsId = '{{ projectsId }}' --required
AND locationsId = '{{ locationsId }}' --required
AND replicationsInternalId = '{{ replicationsInternalId }}' --required
AND requestId = '{{ requestId }}'
AND etag = '{{ etag }}'
AND validateOnly = '{{ validateOnly }}'
;