Close httplib2 connections.
create(parent, body=None, certificateIssuanceConfigId=None, x__xgafv=None)
Creates a new CertificateIssuanceConfig in a given project and location.
Deletes a single CertificateIssuanceConfig.
Gets details of a single CertificateIssuanceConfig.
list(parent, filter=None, orderBy=None, pageSize=None, pageToken=None, x__xgafv=None)
Lists CertificateIssuanceConfigs in a given project and location.
Retrieves the next page of results.
patch(name, body=None, updateMask=None, x__xgafv=None)
Updates a CertificateIssuanceConfig.
close()
Close httplib2 connections.
create(parent, body=None, certificateIssuanceConfigId=None, x__xgafv=None)
Creates a new CertificateIssuanceConfig in a given project and location.
Args:
parent: string, Required. The parent resource of the certificate issuance config. Must be in the format `projects/*/locations/*`. (required)
body: object, The request body.
The object takes the form of:
{ # CertificateIssuanceConfig specifies how to issue and manage a certificate.
"certificateAuthorityConfig": { # The CA that issues the workload certificate. It includes CA address, type, authentication to CA service, etc. # Required. The CA that issues the workload certificate. It includes the CA address, type, authentication to CA service, etc.
"certificateAuthorityServiceConfig": { # Contains information required to contact CA service. # Defines a CertificateAuthorityServiceConfig.
"caPool": "A String", # Required. A CA pool resource used to issue a certificate. The CA pool string has a relative resource path following the form "projects/{project}/locations/{location}/caPools/{ca_pool}".
},
},
"createTime": "A String", # Output only. The creation timestamp of a CertificateIssuanceConfig.
"description": "A String", # Optional. One or more paragraphs of text description of a CertificateIssuanceConfig.
"keyAlgorithm": "A String", # Required. The key algorithm to use when generating the private key.
"labels": { # Optional. Set of labels associated with a CertificateIssuanceConfig.
"a_key": "A String",
},
"lifetime": "A String", # Required. Workload certificate lifetime requested.
"name": "A String", # Identifier. A user-defined name of the certificate issuance config. CertificateIssuanceConfig names must be unique globally and match pattern `projects/*/locations/*/certificateIssuanceConfigs/*`.
"rotationWindowPercentage": 42, # Required. Specifies the percentage of elapsed time of the certificate lifetime to wait before renewing the certificate. Must be a number between 1-99, inclusive.
"updateTime": "A String", # Output only. The last update timestamp of a CertificateIssuanceConfig.
}
certificateIssuanceConfigId: string, Required. A user-provided name of the certificate config.
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, x__xgafv=None)
Deletes a single CertificateIssuanceConfig.
Args:
name: string, Required. A name of the certificate issuance config to delete. Must be in the format `projects/*/locations/*/certificateIssuanceConfigs/*`. (required)
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 details of a single CertificateIssuanceConfig.
Args:
name: string, Required. A name of the certificate issuance config to describe. Must be in the format `projects/*/locations/*/certificateIssuanceConfigs/*`. (required)
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # CertificateIssuanceConfig specifies how to issue and manage a certificate.
"certificateAuthorityConfig": { # The CA that issues the workload certificate. It includes CA address, type, authentication to CA service, etc. # Required. The CA that issues the workload certificate. It includes the CA address, type, authentication to CA service, etc.
"certificateAuthorityServiceConfig": { # Contains information required to contact CA service. # Defines a CertificateAuthorityServiceConfig.
"caPool": "A String", # Required. A CA pool resource used to issue a certificate. The CA pool string has a relative resource path following the form "projects/{project}/locations/{location}/caPools/{ca_pool}".
},
},
"createTime": "A String", # Output only. The creation timestamp of a CertificateIssuanceConfig.
"description": "A String", # Optional. One or more paragraphs of text description of a CertificateIssuanceConfig.
"keyAlgorithm": "A String", # Required. The key algorithm to use when generating the private key.
"labels": { # Optional. Set of labels associated with a CertificateIssuanceConfig.
"a_key": "A String",
},
"lifetime": "A String", # Required. Workload certificate lifetime requested.
"name": "A String", # Identifier. A user-defined name of the certificate issuance config. CertificateIssuanceConfig names must be unique globally and match pattern `projects/*/locations/*/certificateIssuanceConfigs/*`.
"rotationWindowPercentage": 42, # Required. Specifies the percentage of elapsed time of the certificate lifetime to wait before renewing the certificate. Must be a number between 1-99, inclusive.
"updateTime": "A String", # Output only. The last update timestamp of a CertificateIssuanceConfig.
}
list(parent, filter=None, orderBy=None, pageSize=None, pageToken=None, x__xgafv=None)
Lists CertificateIssuanceConfigs in a given project and location.
Args:
parent: string, Required. The project and location from which the certificate should be listed, specified in the format `projects/*/locations/*`. (required)
filter: string, Optional. Filter expression to restrict the Certificates Configs returned.
orderBy: string, Optional. A list of Certificate Config field names used to specify the order of the returned results. The default sorting order is ascending. To specify descending order for a field, add a suffix `" desc"`.
pageSize: integer, Optional. Maximum number of certificate configs to return per call.
pageToken: string, Optional. The value returned by the last `ListCertificateIssuanceConfigsResponse`. Indicates that this is a continuation of a prior `ListCertificateIssuanceConfigs` call, and that the system should return the next page of data.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # Response for the `ListCertificateIssuanceConfigs` method.
"certificateIssuanceConfigs": [ # A list of certificate configs for the parent resource.
{ # CertificateIssuanceConfig specifies how to issue and manage a certificate.
"certificateAuthorityConfig": { # The CA that issues the workload certificate. It includes CA address, type, authentication to CA service, etc. # Required. The CA that issues the workload certificate. It includes the CA address, type, authentication to CA service, etc.
"certificateAuthorityServiceConfig": { # Contains information required to contact CA service. # Defines a CertificateAuthorityServiceConfig.
"caPool": "A String", # Required. A CA pool resource used to issue a certificate. The CA pool string has a relative resource path following the form "projects/{project}/locations/{location}/caPools/{ca_pool}".
},
},
"createTime": "A String", # Output only. The creation timestamp of a CertificateIssuanceConfig.
"description": "A String", # Optional. One or more paragraphs of text description of a CertificateIssuanceConfig.
"keyAlgorithm": "A String", # Required. The key algorithm to use when generating the private key.
"labels": { # Optional. Set of labels associated with a CertificateIssuanceConfig.
"a_key": "A String",
},
"lifetime": "A String", # Required. Workload certificate lifetime requested.
"name": "A String", # Identifier. A user-defined name of the certificate issuance config. CertificateIssuanceConfig names must be unique globally and match pattern `projects/*/locations/*/certificateIssuanceConfigs/*`.
"rotationWindowPercentage": 42, # Required. Specifies the percentage of elapsed time of the certificate lifetime to wait before renewing the certificate. Must be a number between 1-99, inclusive.
"updateTime": "A String", # Output only. The last update timestamp of a CertificateIssuanceConfig.
},
],
"nextPageToken": "A String", # If there might be more results than those appearing in this response, then `next_page_token` is included. To get the next set of results, call this method again using the value of `next_page_token` as `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, updateMask=None, x__xgafv=None)
Updates a CertificateIssuanceConfig.
Args:
name: string, Identifier. A user-defined name of the certificate issuance config. CertificateIssuanceConfig names must be unique globally and match pattern `projects/*/locations/*/certificateIssuanceConfigs/*`. (required)
body: object, The request body.
The object takes the form of:
{ # CertificateIssuanceConfig specifies how to issue and manage a certificate.
"certificateAuthorityConfig": { # The CA that issues the workload certificate. It includes CA address, type, authentication to CA service, etc. # Required. The CA that issues the workload certificate. It includes the CA address, type, authentication to CA service, etc.
"certificateAuthorityServiceConfig": { # Contains information required to contact CA service. # Defines a CertificateAuthorityServiceConfig.
"caPool": "A String", # Required. A CA pool resource used to issue a certificate. The CA pool string has a relative resource path following the form "projects/{project}/locations/{location}/caPools/{ca_pool}".
},
},
"createTime": "A String", # Output only. The creation timestamp of a CertificateIssuanceConfig.
"description": "A String", # Optional. One or more paragraphs of text description of a CertificateIssuanceConfig.
"keyAlgorithm": "A String", # Required. The key algorithm to use when generating the private key.
"labels": { # Optional. Set of labels associated with a CertificateIssuanceConfig.
"a_key": "A String",
},
"lifetime": "A String", # Required. Workload certificate lifetime requested.
"name": "A String", # Identifier. A user-defined name of the certificate issuance config. CertificateIssuanceConfig names must be unique globally and match pattern `projects/*/locations/*/certificateIssuanceConfigs/*`.
"rotationWindowPercentage": 42, # Required. Specifies the percentage of elapsed time of the certificate lifetime to wait before renewing the certificate. Must be a number between 1-99, inclusive.
"updateTime": "A String", # Output only. The last update timestamp of a CertificateIssuanceConfig.
}
updateMask: string, Required. The update mask applies to the resource. For the `FieldMask` definition, see https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#fieldmask.
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.
},
}