Returns the destinations Resource.
Close httplib2 connections.
create(parent, body=None, multicloudDataTransferConfigId=None, requestId=None, x__xgafv=None)
Creates a `MulticloudDataTransferConfig` resource in a specified project and location.
delete(name, etag=None, requestId=None, x__xgafv=None)
Deletes a `MulticloudDataTransferConfig` resource.
Gets the details of a `MulticloudDataTransferConfig` resource.
Lists the `MulticloudDataTransferConfig` resources in a specified project and location.
Retrieves the next page of results.
patch(name, body=None, requestId=None, updateMask=None, x__xgafv=None)
Updates a `MulticloudDataTransferConfig` resource in a specified project and location.
close()
Close httplib2 connections.
create(parent, body=None, multicloudDataTransferConfigId=None, requestId=None, x__xgafv=None)
Creates a `MulticloudDataTransferConfig` resource in a specified project and location.
Args:
parent: string, Required. The name of the parent resource. (required)
body: object, The request body.
The object takes the form of:
{ # The `MulticloudDataTransferConfig` resource. It lists the services that you configure for Data Transfer Essentials billing and metering.
"createTime": "A String", # Output only. Time when the `MulticloudDataTransferConfig` resource was created.
"description": "A String", # Optional. A description of this resource.
"destinationsActiveCount": 42, # Output only. The number of `Destination` resources in use with the `MulticloudDataTransferConfig` resource.
"destinationsCount": 42, # Output only. The number of `Destination` resources configured for the `MulticloudDataTransferConfig` resource.
"etag": "A String", # The etag is computed by the server, and might be sent with update and delete requests so that the client has an up-to-date value before proceeding.
"labels": { # Optional. User-defined labels.
"a_key": "A String",
},
"name": "A String", # Identifier. The name of the `MulticloudDataTransferConfig` resource. Format: `projects/{project}/locations/{location}/multicloudDataTransferConfigs/{multicloud_data_transfer_config}`.
"services": { # Optional. Maps services to their current or planned states. Service names are keys, and the associated values describe the state of the service. If a state change is expected, the value is either `ADDING` or `DELETING`, depending on the actions taken. Sample output: "services": { "big-query": { "states": [ { "effectiveTime": "2024-12-12T08:00:00Z" "state": "ADDING", }, ] }, "cloud-storage": { "states": [ { "state": "ACTIVE", } ] } }
"a_key": { # The timeline of the pending states for a resource.
"states": [ # Output only. The state and activation time details of the resource state.
{ # The state and activation time details of the resource state.
"effectiveTime": "A String", # Output only. Accompanies only the transient states, which include `ADDING`, `DELETING`, and `SUSPENDING`, to denote the time until which the transient state of the resource will be effective. For instance, if the state is `ADDING`, this field shows the time when the resource state transitions to `ACTIVE`.
"state": "A String", # Output only. The state of the resource.
},
],
},
},
"uid": "A String", # Output only. The Google-generated unique ID for the `MulticloudDataTransferConfig` resource. This value is unique across all `MulticloudDataTransferConfig` resources. If a resource is deleted and another with the same name is created, the new resource is assigned a different and unique ID.
"updateTime": "A String", # Output only. Time when the `MulticloudDataTransferConfig` resource was updated.
}
multicloudDataTransferConfigId: string, Required. The ID to use for the `MulticloudDataTransferConfig` resource, which becomes the final component of the `MulticloudDataTransferConfig` resource name.
requestId: string, Optional. A request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server can ignore the request if it has already been completed. The server waits 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, can ignore the second request. This prevents clients from accidentally creating duplicate `MulticloudDataTransferConfig` resources. The request ID must be a valid UUID with the exception that zero UUID (00000000-0000-0000-0000-000000000000) isn't supported.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # This resource represents a long-running operation that is the result of a network API call.
"done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
"error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
"code": 42, # The status code, which should be an enum value of google.rpc.Code.
"details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
{
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
],
"message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
},
"metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
"name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
"response": { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
}
delete(name, etag=None, requestId=None, x__xgafv=None)
Deletes a `MulticloudDataTransferConfig` resource.
Args:
name: string, Required. The name of the `MulticloudDataTransferConfig` resource to delete. (required)
etag: string, Optional. The etag is computed by the server, and might be sent with update and delete requests so that the client has an up-to-date value before proceeding.
requestId: string, Optional. A request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server can ignore the request if it has already been completed. The server waits 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, can ignore the second request. This prevents clients from accidentally creating duplicate `MulticloudDataTransferConfig` resources. The request ID must be a valid UUID with the exception that zero UUID (00000000-0000-0000-0000-000000000000) isn't supported.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # This resource represents a long-running operation that is the result of a network API call.
"done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
"error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
"code": 42, # The status code, which should be an enum value of google.rpc.Code.
"details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
{
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
],
"message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
},
"metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
"name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
"response": { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
}
get(name, x__xgafv=None)
Gets the details of a `MulticloudDataTransferConfig` resource.
Args:
name: string, Required. The name of the `MulticloudDataTransferConfig` resource to get. (required)
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # The `MulticloudDataTransferConfig` resource. It lists the services that you configure for Data Transfer Essentials billing and metering.
"createTime": "A String", # Output only. Time when the `MulticloudDataTransferConfig` resource was created.
"description": "A String", # Optional. A description of this resource.
"destinationsActiveCount": 42, # Output only. The number of `Destination` resources in use with the `MulticloudDataTransferConfig` resource.
"destinationsCount": 42, # Output only. The number of `Destination` resources configured for the `MulticloudDataTransferConfig` resource.
"etag": "A String", # The etag is computed by the server, and might be sent with update and delete requests so that the client has an up-to-date value before proceeding.
"labels": { # Optional. User-defined labels.
"a_key": "A String",
},
"name": "A String", # Identifier. The name of the `MulticloudDataTransferConfig` resource. Format: `projects/{project}/locations/{location}/multicloudDataTransferConfigs/{multicloud_data_transfer_config}`.
"services": { # Optional. Maps services to their current or planned states. Service names are keys, and the associated values describe the state of the service. If a state change is expected, the value is either `ADDING` or `DELETING`, depending on the actions taken. Sample output: "services": { "big-query": { "states": [ { "effectiveTime": "2024-12-12T08:00:00Z" "state": "ADDING", }, ] }, "cloud-storage": { "states": [ { "state": "ACTIVE", } ] } }
"a_key": { # The timeline of the pending states for a resource.
"states": [ # Output only. The state and activation time details of the resource state.
{ # The state and activation time details of the resource state.
"effectiveTime": "A String", # Output only. Accompanies only the transient states, which include `ADDING`, `DELETING`, and `SUSPENDING`, to denote the time until which the transient state of the resource will be effective. For instance, if the state is `ADDING`, this field shows the time when the resource state transitions to `ACTIVE`.
"state": "A String", # Output only. The state of the resource.
},
],
},
},
"uid": "A String", # Output only. The Google-generated unique ID for the `MulticloudDataTransferConfig` resource. This value is unique across all `MulticloudDataTransferConfig` resources. If a resource is deleted and another with the same name is created, the new resource is assigned a different and unique ID.
"updateTime": "A String", # Output only. Time when the `MulticloudDataTransferConfig` resource was updated.
}
list(parent, filter=None, orderBy=None, pageSize=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None)
Lists the `MulticloudDataTransferConfig` resources in a specified project and location.
Args:
parent: string, Required. The name of the parent resource. (required)
filter: string, Optional. An expression that filters the results listed in the response.
orderBy: string, Optional. The sort order of the results.
pageSize: integer, Optional. The maximum number of results listed per page.
pageToken: string, Optional. The page token.
returnPartialSuccess: boolean, Optional. If `true`, allows partial responses for multi-regional aggregated list requests.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # Response message to list `MulticloudDataTransferConfig` resources.
"multicloudDataTransferConfigs": [ # The list of `MulticloudDataTransferConfig` resources to be listed.
{ # The `MulticloudDataTransferConfig` resource. It lists the services that you configure for Data Transfer Essentials billing and metering.
"createTime": "A String", # Output only. Time when the `MulticloudDataTransferConfig` resource was created.
"description": "A String", # Optional. A description of this resource.
"destinationsActiveCount": 42, # Output only. The number of `Destination` resources in use with the `MulticloudDataTransferConfig` resource.
"destinationsCount": 42, # Output only. The number of `Destination` resources configured for the `MulticloudDataTransferConfig` resource.
"etag": "A String", # The etag is computed by the server, and might be sent with update and delete requests so that the client has an up-to-date value before proceeding.
"labels": { # Optional. User-defined labels.
"a_key": "A String",
},
"name": "A String", # Identifier. The name of the `MulticloudDataTransferConfig` resource. Format: `projects/{project}/locations/{location}/multicloudDataTransferConfigs/{multicloud_data_transfer_config}`.
"services": { # Optional. Maps services to their current or planned states. Service names are keys, and the associated values describe the state of the service. If a state change is expected, the value is either `ADDING` or `DELETING`, depending on the actions taken. Sample output: "services": { "big-query": { "states": [ { "effectiveTime": "2024-12-12T08:00:00Z" "state": "ADDING", }, ] }, "cloud-storage": { "states": [ { "state": "ACTIVE", } ] } }
"a_key": { # The timeline of the pending states for a resource.
"states": [ # Output only. The state and activation time details of the resource state.
{ # The state and activation time details of the resource state.
"effectiveTime": "A String", # Output only. Accompanies only the transient states, which include `ADDING`, `DELETING`, and `SUSPENDING`, to denote the time until which the transient state of the resource will be effective. For instance, if the state is `ADDING`, this field shows the time when the resource state transitions to `ACTIVE`.
"state": "A String", # Output only. The state of the resource.
},
],
},
},
"uid": "A String", # Output only. The Google-generated unique ID for the `MulticloudDataTransferConfig` resource. This value is unique across all `MulticloudDataTransferConfig` resources. If a resource is deleted and another with the same name is created, the new resource is assigned a different and unique ID.
"updateTime": "A String", # Output only. Time when the `MulticloudDataTransferConfig` resource was updated.
},
],
"nextPageToken": "A String", # The next page token.
"unreachable": [ # Locations that could not be reached.
"A String",
],
}
list_next()
Retrieves the next page of results.
Args:
previous_request: The request for the previous page. (required)
previous_response: The response from the request for the previous page. (required)
Returns:
A request object that you can call 'execute()' on to request the next
page. Returns None if there are no more items in the collection.
patch(name, body=None, requestId=None, updateMask=None, x__xgafv=None)
Updates a `MulticloudDataTransferConfig` resource in a specified project and location.
Args:
name: string, Identifier. The name of the `MulticloudDataTransferConfig` resource. Format: `projects/{project}/locations/{location}/multicloudDataTransferConfigs/{multicloud_data_transfer_config}`. (required)
body: object, The request body.
The object takes the form of:
{ # The `MulticloudDataTransferConfig` resource. It lists the services that you configure for Data Transfer Essentials billing and metering.
"createTime": "A String", # Output only. Time when the `MulticloudDataTransferConfig` resource was created.
"description": "A String", # Optional. A description of this resource.
"destinationsActiveCount": 42, # Output only. The number of `Destination` resources in use with the `MulticloudDataTransferConfig` resource.
"destinationsCount": 42, # Output only. The number of `Destination` resources configured for the `MulticloudDataTransferConfig` resource.
"etag": "A String", # The etag is computed by the server, and might be sent with update and delete requests so that the client has an up-to-date value before proceeding.
"labels": { # Optional. User-defined labels.
"a_key": "A String",
},
"name": "A String", # Identifier. The name of the `MulticloudDataTransferConfig` resource. Format: `projects/{project}/locations/{location}/multicloudDataTransferConfigs/{multicloud_data_transfer_config}`.
"services": { # Optional. Maps services to their current or planned states. Service names are keys, and the associated values describe the state of the service. If a state change is expected, the value is either `ADDING` or `DELETING`, depending on the actions taken. Sample output: "services": { "big-query": { "states": [ { "effectiveTime": "2024-12-12T08:00:00Z" "state": "ADDING", }, ] }, "cloud-storage": { "states": [ { "state": "ACTIVE", } ] } }
"a_key": { # The timeline of the pending states for a resource.
"states": [ # Output only. The state and activation time details of the resource state.
{ # The state and activation time details of the resource state.
"effectiveTime": "A String", # Output only. Accompanies only the transient states, which include `ADDING`, `DELETING`, and `SUSPENDING`, to denote the time until which the transient state of the resource will be effective. For instance, if the state is `ADDING`, this field shows the time when the resource state transitions to `ACTIVE`.
"state": "A String", # Output only. The state of the resource.
},
],
},
},
"uid": "A String", # Output only. The Google-generated unique ID for the `MulticloudDataTransferConfig` resource. This value is unique across all `MulticloudDataTransferConfig` resources. If a resource is deleted and another with the same name is created, the new resource is assigned a different and unique ID.
"updateTime": "A String", # Output only. Time when the `MulticloudDataTransferConfig` resource was updated.
}
requestId: string, Optional. A request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server can ignore the request if it has already been completed. The server waits 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, can ignore the second request. This prevents clients from accidentally creating duplicate `MulticloudDataTransferConfig` resources. The request ID must be a valid UUID with the exception that zero UUID (00000000-0000-0000-0000-000000000000) isn't supported.
updateMask: string, Optional. `FieldMask` is used to specify the fields in the `MulticloudDataTransferConfig` resource to be overwritten by the update. The fields specified in `update_mask` are relative to the resource, not the full request. A field is overwritten if it is in the mask. If you don't specify a mask, all fields are overwritten.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # This resource represents a long-running operation that is the result of a network API call.
"done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
"error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
"code": 42, # The status code, which should be an enum value of google.rpc.Code.
"details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
{
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
],
"message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
},
"metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
"name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
"response": { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
}