| <html><body> |
| <style> |
| |
| body, h1, h2, h3, div, span, p, pre, a { |
| margin: 0; |
| padding: 0; |
| border: 0; |
| font-weight: inherit; |
| font-style: inherit; |
| font-size: 100%; |
| font-family: inherit; |
| vertical-align: baseline; |
| } |
| |
| body { |
| font-size: 13px; |
| padding: 1em; |
| } |
| |
| h1 { |
| font-size: 26px; |
| margin-bottom: 1em; |
| } |
| |
| h2 { |
| font-size: 24px; |
| margin-bottom: 1em; |
| } |
| |
| h3 { |
| font-size: 20px; |
| margin-bottom: 1em; |
| margin-top: 1em; |
| } |
| |
| pre, code { |
| line-height: 1.5; |
| font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace; |
| } |
| |
| pre { |
| margin-top: 0.5em; |
| } |
| |
| h1, h2, h3, p { |
| font-family: Arial, sans serif; |
| } |
| |
| h1, h2, h3 { |
| border-bottom: solid #CCC 1px; |
| } |
| |
| .toc_element { |
| margin-top: 0.5em; |
| } |
| |
| .firstline { |
| margin-left: 2 em; |
| } |
| |
| .method { |
| margin-top: 1em; |
| border: solid 1px #CCC; |
| padding: 1em; |
| background: #EEE; |
| } |
| |
| .details { |
| font-weight: bold; |
| font-size: 14px; |
| } |
| |
| </style> |
| |
| <h1><a href="chromepolicy_v1.html">Chrome Policy API</a> . <a href="chromepolicy_v1.customers.html">customers</a> . <a href="chromepolicy_v1.customers.policySchemas.html">policySchemas</a></h1> |
| <h2>Instance Methods</h2> |
| <p class="toc_element"> |
| <code><a href="#close">close()</a></code></p> |
| <p class="firstline">Close httplib2 connections.</p> |
| <p class="toc_element"> |
| <code><a href="#get">get(name, x__xgafv=None)</a></code></p> |
| <p class="firstline">Get a specific policy schema for a customer by its resource name.</p> |
| <p class="toc_element"> |
| <code><a href="#list">list(parent, filter=None, pageSize=None, pageToken=None, x__xgafv=None)</a></code></p> |
| <p class="firstline">Gets a list of policy schemas that match a specified filter value for a given customer.</p> |
| <p class="toc_element"> |
| <code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p> |
| <p class="firstline">Retrieves the next page of results.</p> |
| <h3>Method Details</h3> |
| <div class="method"> |
| <code class="details" id="close">close()</code> |
| <pre>Close httplib2 connections.</pre> |
| </div> |
| |
| <div class="method"> |
| <code class="details" id="get">get(name, x__xgafv=None)</code> |
| <pre>Get a specific policy schema for a customer by its resource name. |
| |
| Args: |
| name: string, Required. The policy schema resource name to query. (required) |
| x__xgafv: string, V1 error format. |
| Allowed values |
| 1 - v1 error format |
| 2 - v2 error format |
| |
| Returns: |
| An object of the form: |
| |
| { # Resource representing a policy schema. Next ID: 11 |
| "accessRestrictions": [ # Output only. Specific access restrictions related to this policy. |
| "A String", |
| ], |
| "additionalTargetKeyNames": [ # Output only. Additional key names that will be used to identify the target of the policy value. When specifying a `policyTargetKey`, each of the additional keys specified here will have to be included in the `additionalTargetKeys` map. |
| { # Additional key names that will be used to identify the target of the policy value. |
| "key": "A String", # Key name. |
| "keyDescription": "A String", # Key description. |
| }, |
| ], |
| "definition": { # Describes a complete .proto file. # Schema definition using proto descriptor. |
| "enumType": [ |
| { # Describes an enum type. |
| "name": "A String", |
| "value": [ |
| { # Describes a value within an enum. |
| "name": "A String", |
| "number": 42, |
| }, |
| ], |
| }, |
| ], |
| "messageType": [ # All top-level definitions in this file. |
| { # Describes a message type. |
| "enumType": [ |
| { # Describes an enum type. |
| "name": "A String", |
| "value": [ |
| { # Describes a value within an enum. |
| "name": "A String", |
| "number": 42, |
| }, |
| ], |
| }, |
| ], |
| "field": [ |
| { # Describes a field within a message. |
| "defaultValue": "A String", # For numeric types, contains the original text representation of the value. For booleans, "true" or "false". For strings, contains the default text contents (not escaped in any way). For bytes, contains the C escaped value. All bytes >= 128 are escaped. |
| "jsonName": "A String", # JSON name of this field. The value is set by protocol compiler. If the user has set a "json_name" option on this field, that option's value will be used. Otherwise, it's deduced from the field's name by converting it to camelCase. |
| "label": "A String", |
| "name": "A String", |
| "number": 42, |
| "oneofIndex": 42, # If set, gives the index of a oneof in the containing type's oneof_decl list. This field is a member of that oneof. |
| "proto3Optional": True or False, # If true, this is a proto3 "optional". When a proto3 field is optional, it tracks presence regardless of field type. When proto3_optional is true, this field must be belong to a oneof to signal to old proto3 clients that presence is tracked for this field. This oneof is known as a "synthetic" oneof, and this field must be its sole member (each proto3 optional field gets its own synthetic oneof). Synthetic oneofs exist in the descriptor only, and do not generate any API. Synthetic oneofs must be ordered after all "real" oneofs. For message fields, proto3_optional doesn't create any semantic change, since non-repeated message fields always track presence. However it still indicates the semantic detail of whether the user wrote "optional" or not. This can be useful for round-tripping the .proto file. For consistency we give message fields a synthetic oneof also, even though it is not required to track presence. This is especially important because the parser can't tell if a field is a message or an enum, so it must always create a synthetic oneof. Proto2 optional fields do not set this flag, because they already indicate optional with `LABEL_OPTIONAL`. |
| "type": "A String", # If type_name is set, this need not be set. If both this and type_name are set, this must be one of TYPE_ENUM, TYPE_MESSAGE or TYPE_GROUP. |
| "typeName": "A String", # For message and enum types, this is the name of the type. If the name starts with a '.', it is fully-qualified. Otherwise, C++-like scoping rules are used to find the type (i.e. first the nested types within this message are searched, then within the parent, on up to the root namespace). |
| }, |
| ], |
| "name": "A String", |
| "nestedType": [ |
| # Object with schema name: Proto2DescriptorProto |
| ], |
| "oneofDecl": [ |
| { # Describes a oneof. |
| "name": "A String", |
| }, |
| ], |
| }, |
| ], |
| "name": "A String", # file name, relative to root of source tree |
| "package": "A String", # e.g. "foo", "foo.bar", etc. |
| "syntax": "A String", # The syntax of the proto file. The supported values are "proto2" and "proto3". |
| }, |
| "fieldDescriptions": [ # Output only. Detailed description of each field that is part of the schema. |
| { # Provides detailed information for a particular field that is part of a PolicySchema. |
| "description": "A String", # Output only. The description for the field. |
| "field": "A String", # Output only. The name of the field for associated with this description. |
| "fieldDependencies": [ # Output only. Provides a list of fields and the values they must have for this field to be allowed to be set. |
| { # The field and the value it must have for another field to be allowed to be set. |
| "sourceField": "A String", # The source field which this field depends on. |
| "sourceFieldValue": "A String", # The value which the source field must have for this field to be allowed to be set. |
| }, |
| ], |
| "inputConstraint": "A String", # Output only. Any input constraints associated on the values for the field. |
| "knownValueDescriptions": [ # Output only. If the field has a set of known values, this field will provide a description for these values. |
| { # Provides detailed information about a known value that is allowed for a particular field in a PolicySchema. |
| "description": "A String", # Output only. Additional description for this value. |
| "value": "A String", # Output only. The string represenstation of the value that can be set for the field. |
| }, |
| ], |
| "nestedFieldDescriptions": [ # Output only. Provides the description of the fields nested in this field, if the field is a message type that defines multiple fields. |
| # Object with schema name: GoogleChromePolicyV1PolicySchemaFieldDescription |
| ], |
| }, |
| ], |
| "name": "A String", # Format: name=customers/{customer}/policySchemas/{schema_namespace} |
| "notices": [ # Output only. Special notice messages related to setting certain values in certain fields in the schema. |
| { # Provides special notice messages related to a particular value in a field that is part of a PolicySchema. |
| "acknowledgementRequired": True or False, # Output only. Whether the user needs to acknowledge the notice message before the value can be set. |
| "field": "A String", # Output only. The field name associated with the notice. |
| "noticeMessage": "A String", # Output only. The notice message associate with the value of the field. |
| "noticeValue": "A String", # Output only. The value of the field that has a notice. When setting the field to this value, the user may be required to acknowledge the notice message in order for the value to be set. |
| }, |
| ], |
| "policyDescription": "A String", # Output only. Description about the policy schema for user consumption. |
| "schemaName": "A String", # Output only. The fully qualified name of the policy schema. This value is used to fill the field `policy_schema` in PolicyValue when calling BatchInheritOrgUnitPolicies or BatchModifyOrgUnitPolicies |
| "supportUri": "A String", # Output only. URI to related support article for this schema. |
| "validTargetResources": [ # Output only. Information about applicable target resources for the policy. |
| "A String", |
| ], |
| }</pre> |
| </div> |
| |
| <div class="method"> |
| <code class="details" id="list">list(parent, filter=None, pageSize=None, pageToken=None, x__xgafv=None)</code> |
| <pre>Gets a list of policy schemas that match a specified filter value for a given customer. |
| |
| Args: |
| parent: string, Required. The customer for which the listing request will apply. (required) |
| filter: string, The schema filter used to find a particular schema based on fields like its resource name, description and `additionalTargetKeyNames`. |
| pageSize: integer, The maximum number of policy schemas to return. |
| pageToken: string, The page token used to retrieve a specific page of the listing request. |
| x__xgafv: string, V1 error format. |
| Allowed values |
| 1 - v1 error format |
| 2 - v2 error format |
| |
| Returns: |
| An object of the form: |
| |
| { # Response message for listing policy schemas that match a filter. |
| "nextPageToken": "A String", # The page token used to get the next page of policy schemas. |
| "policySchemas": [ # The list of policy schemas that match the query. |
| { # Resource representing a policy schema. Next ID: 11 |
| "accessRestrictions": [ # Output only. Specific access restrictions related to this policy. |
| "A String", |
| ], |
| "additionalTargetKeyNames": [ # Output only. Additional key names that will be used to identify the target of the policy value. When specifying a `policyTargetKey`, each of the additional keys specified here will have to be included in the `additionalTargetKeys` map. |
| { # Additional key names that will be used to identify the target of the policy value. |
| "key": "A String", # Key name. |
| "keyDescription": "A String", # Key description. |
| }, |
| ], |
| "definition": { # Describes a complete .proto file. # Schema definition using proto descriptor. |
| "enumType": [ |
| { # Describes an enum type. |
| "name": "A String", |
| "value": [ |
| { # Describes a value within an enum. |
| "name": "A String", |
| "number": 42, |
| }, |
| ], |
| }, |
| ], |
| "messageType": [ # All top-level definitions in this file. |
| { # Describes a message type. |
| "enumType": [ |
| { # Describes an enum type. |
| "name": "A String", |
| "value": [ |
| { # Describes a value within an enum. |
| "name": "A String", |
| "number": 42, |
| }, |
| ], |
| }, |
| ], |
| "field": [ |
| { # Describes a field within a message. |
| "defaultValue": "A String", # For numeric types, contains the original text representation of the value. For booleans, "true" or "false". For strings, contains the default text contents (not escaped in any way). For bytes, contains the C escaped value. All bytes >= 128 are escaped. |
| "jsonName": "A String", # JSON name of this field. The value is set by protocol compiler. If the user has set a "json_name" option on this field, that option's value will be used. Otherwise, it's deduced from the field's name by converting it to camelCase. |
| "label": "A String", |
| "name": "A String", |
| "number": 42, |
| "oneofIndex": 42, # If set, gives the index of a oneof in the containing type's oneof_decl list. This field is a member of that oneof. |
| "proto3Optional": True or False, # If true, this is a proto3 "optional". When a proto3 field is optional, it tracks presence regardless of field type. When proto3_optional is true, this field must be belong to a oneof to signal to old proto3 clients that presence is tracked for this field. This oneof is known as a "synthetic" oneof, and this field must be its sole member (each proto3 optional field gets its own synthetic oneof). Synthetic oneofs exist in the descriptor only, and do not generate any API. Synthetic oneofs must be ordered after all "real" oneofs. For message fields, proto3_optional doesn't create any semantic change, since non-repeated message fields always track presence. However it still indicates the semantic detail of whether the user wrote "optional" or not. This can be useful for round-tripping the .proto file. For consistency we give message fields a synthetic oneof also, even though it is not required to track presence. This is especially important because the parser can't tell if a field is a message or an enum, so it must always create a synthetic oneof. Proto2 optional fields do not set this flag, because they already indicate optional with `LABEL_OPTIONAL`. |
| "type": "A String", # If type_name is set, this need not be set. If both this and type_name are set, this must be one of TYPE_ENUM, TYPE_MESSAGE or TYPE_GROUP. |
| "typeName": "A String", # For message and enum types, this is the name of the type. If the name starts with a '.', it is fully-qualified. Otherwise, C++-like scoping rules are used to find the type (i.e. first the nested types within this message are searched, then within the parent, on up to the root namespace). |
| }, |
| ], |
| "name": "A String", |
| "nestedType": [ |
| # Object with schema name: Proto2DescriptorProto |
| ], |
| "oneofDecl": [ |
| { # Describes a oneof. |
| "name": "A String", |
| }, |
| ], |
| }, |
| ], |
| "name": "A String", # file name, relative to root of source tree |
| "package": "A String", # e.g. "foo", "foo.bar", etc. |
| "syntax": "A String", # The syntax of the proto file. The supported values are "proto2" and "proto3". |
| }, |
| "fieldDescriptions": [ # Output only. Detailed description of each field that is part of the schema. |
| { # Provides detailed information for a particular field that is part of a PolicySchema. |
| "description": "A String", # Output only. The description for the field. |
| "field": "A String", # Output only. The name of the field for associated with this description. |
| "fieldDependencies": [ # Output only. Provides a list of fields and the values they must have for this field to be allowed to be set. |
| { # The field and the value it must have for another field to be allowed to be set. |
| "sourceField": "A String", # The source field which this field depends on. |
| "sourceFieldValue": "A String", # The value which the source field must have for this field to be allowed to be set. |
| }, |
| ], |
| "inputConstraint": "A String", # Output only. Any input constraints associated on the values for the field. |
| "knownValueDescriptions": [ # Output only. If the field has a set of known values, this field will provide a description for these values. |
| { # Provides detailed information about a known value that is allowed for a particular field in a PolicySchema. |
| "description": "A String", # Output only. Additional description for this value. |
| "value": "A String", # Output only. The string represenstation of the value that can be set for the field. |
| }, |
| ], |
| "nestedFieldDescriptions": [ # Output only. Provides the description of the fields nested in this field, if the field is a message type that defines multiple fields. |
| # Object with schema name: GoogleChromePolicyV1PolicySchemaFieldDescription |
| ], |
| }, |
| ], |
| "name": "A String", # Format: name=customers/{customer}/policySchemas/{schema_namespace} |
| "notices": [ # Output only. Special notice messages related to setting certain values in certain fields in the schema. |
| { # Provides special notice messages related to a particular value in a field that is part of a PolicySchema. |
| "acknowledgementRequired": True or False, # Output only. Whether the user needs to acknowledge the notice message before the value can be set. |
| "field": "A String", # Output only. The field name associated with the notice. |
| "noticeMessage": "A String", # Output only. The notice message associate with the value of the field. |
| "noticeValue": "A String", # Output only. The value of the field that has a notice. When setting the field to this value, the user may be required to acknowledge the notice message in order for the value to be set. |
| }, |
| ], |
| "policyDescription": "A String", # Output only. Description about the policy schema for user consumption. |
| "schemaName": "A String", # Output only. The fully qualified name of the policy schema. This value is used to fill the field `policy_schema` in PolicyValue when calling BatchInheritOrgUnitPolicies or BatchModifyOrgUnitPolicies |
| "supportUri": "A String", # Output only. URI to related support article for this schema. |
| "validTargetResources": [ # Output only. Information about applicable target resources for the policy. |
| "A String", |
| ], |
| }, |
| ], |
| }</pre> |
| </div> |
| |
| <div class="method"> |
| <code class="details" id="list_next">list_next(previous_request, previous_response)</code> |
| <pre>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. |
| </pre> |
| </div> |
| |
| </body></html> |
