Blame - docs/dyn/servicemanagement_v1.services.html - platform/external/python/google-api-python-client

"sourceContext": { # `SourceContext` represents information about the source of a # Source context for the protocol buffer service represented by this

1397

# message.

1398

# protobuf element, like the file in which it is defined.

1399

"fileName": "A String", # The path-qualified name of the .proto file that contained the associated

1400

# protobuf element. For example: `"google/protobuf/source_context.proto"`.

1401

},

1402

"mixins": [ # Included APIs. See Mixin.

1403

{ # Declares an API to be included in this API. The including API must

1404

# redeclare all the methods from the included API, but documentation

1405

# and options are inherited as follows:

1406

#

1407

# - If after comment and whitespace stripping, the documentation

1408

# string of the redeclared method is empty, it will be inherited

1409

# from the original method.

1410

#

1411

# - Each annotation belonging to the service config (http,

1412

# visibility) which is not set in the redeclared method will be

1413

# inherited.

1414

#

1415

# - If an http annotation is inherited, the path pattern will be

1416

# modified as follows. Any version prefix will be replaced by the

1417

# version of the including API plus the root path if specified.

1418

#

1419

# Example of a simple mixin:

1420

#

1421

# package google.acl.v1;

1422

# service AccessControl {

1423

# // Get the underlying ACL object.

1424

# rpc GetAcl(GetAclRequest) returns (Acl) {

1425

# option (google.api.http).get = "/v1/{resource=**}:getAcl";

# }

# }

#

# package google.storage.v2;

1430

# service Storage {

1431

# // rpc GetAcl(GetAclRequest) returns (Acl);

1432

#

1433

# // Get a data record.

1434

# rpc GetData(GetDataRequest) returns (Data) {

1435

# option (google.api.http).get = "/v2/{resource=**}";

# }

# }

#

# Example of a mixin configuration:

1440

#

1441

# apis:

1442

# - name: google.storage.v2.Storage

1443

# mixins:

1444

# - name: google.acl.v1.AccessControl

1445

#

1446

# The mixin construct implies that all methods in `AccessControl` are

1447

# also declared with same name and request/response types in

1448

# `Storage`. A documentation generator or annotation processor will

1449

# see the effective `Storage.GetAcl` method after inherting

1450

# documentation and annotations as follows:

1451

#

1452

# service Storage {

1453

# // Get the underlying ACL object.

1454

# rpc GetAcl(GetAclRequest) returns (Acl) {

1455

# option (google.api.http).get = "/v2/{resource=**}:getAcl";

# }

# ...

# }

#

# Note how the version in the path pattern changed from `v1` to `v2`.

1461

#

1462

# If the `root` field in the mixin is specified, it should be a

1463

# relative path under which inherited HTTP paths are placed. Example:

1464

#

1465

# apis:

1466

# - name: google.storage.v2.Storage

1467

# mixins:

1468

# - name: google.acl.v1.AccessControl

1469

# root: acls

1470

#

1471

# This implies the following inherited HTTP annotation:

1472

#

1473

# service Storage {

1474

# // Get the underlying ACL object.

1475

# rpc GetAcl(GetAclRequest) returns (Acl) {

1476

# option (google.api.http).get = "/v2/acls/{resource=**}:getAcl";

# }

# ...

# }

"root": "A String", # If non-empty specifies a path under which inherited HTTP paths

1481

# are rooted.

1482

"name": "A String", # The fully qualified name of the API which is included.

1483

},

1484

],

1485

"syntax": "A String", # The source syntax of the service.

1486

"version": "A String", # A version string for this api. If specified, must have the form

1487

# `major-version.minor-version`, as in `1.10`. If the minor version

1488

# is omitted, it defaults to zero. If the entire version field is

1489

# empty, the major version is derived from the package name, as

1490

# outlined below. If the field is not empty, the version in the

1491

# package name will be verified to be consistent with what is

1492

# provided here.

1493

#

1494

# The versioning schema uses [semantic

1495

# versioning](http://semver.org) where the major version number

1496

# indicates a breaking change and the minor version an additive,

1497

# non-breaking change. Both version numbers are signals to users

1498

# what to expect from different versions, and should be carefully

1499

# chosen based on the product plan.

1500

#

1501

# The major version is also reflected in the package name of the

1502

# API, which must end in `v<major-version>`, as in

1503

# `google.feature.v1`. For major versions 0 and 1, the suffix can

1504

# be omitted. Zero major versions must only be used for

1505

# experimental, none-GA apis.

1506

"options": [ # Any metadata attached to the API.

1507

{ # A protocol buffer option, which can be attached to a message, field,

1508

# enumeration, etc.

1509

"name": "A String", # The option's name. For example, `"java_package"`.

1510

"value": { # The option's value. For example, `"com.google.protobuf"`.

1511

"a_key": "", # Properties of the object. Contains field @type with type URL.

},

},

],

"name": "A String", # The fully qualified name of this api, including package name

1516

# followed by the api's simple name.

1517

},

1518

],

1519

"customError": { # Customize service error responses. For example, list any service # Custom error configuration.

1520

# specific protobuf types that can appear in error detail lists of

# error responses.

#

# Example:

#

# custom_error:

# types:

# - google.foo.v1.CustomError

1528

# - google.foo.v1.AnotherError

1529

"rules": [ # The list of custom error rules that apply to individual API messages.

1530

#

1531

# **NOTE:** All service configuration rules follow "last one wins" order.

1532

{ # A custom error rule.

1533

"isErrorType": True or False, # Mark this message as possible payload in error response. Otherwise,

1534

# objects of this type will be filtered when they appear in error payload.

1535

"selector": "A String", # Selects messages to which this rule applies.

1536

#

1537

# Refer to selector for syntax details.

1538

},

1539

],

1540

"types": [ # The list of custom error detail types, e.g. 'google.foo.v1.CustomError'.

"A String",

],

},

"visibility": { # `Visibility` defines restrictions for the visibility of service # API visibility configuration.

1545

# elements. Restrictions are specified using visibility labels

1546

# (e.g., TRUSTED_TESTER) that are elsewhere linked to users and projects.

1547

#

1548

# Users and projects can have access to more than one visibility label. The

1549

# effective visibility for multiple labels is the union of each label's

1550

# elements, plus any unrestricted elements.

1551

#

1552

# If an element and its parents have no restrictions, visibility is

1553

# unconditionally granted.

#

# Example:

#

# visibility:

# rules:

# - selector: google.calendar.Calendar.EnhancedSearch

1560

# restriction: TRUSTED_TESTER

1561

# - selector: google.calendar.Calendar.Delegate

1562

# restriction: GOOGLE_INTERNAL

1563

#

1564

# Here, all methods are publicly visible except for the restricted methods

1565

# EnhancedSearch and Delegate.

1566

"rules": [ # A list of visibility rules that apply to individual API elements.

1567

#

1568

# **NOTE:** All service configuration rules follow "last one wins" order.

1569

{ # A visibility rule provides visibility configuration for an individual API

1570

# element.

1571

"restriction": "A String", # Lists the visibility labels for this rule. Any of the listed labels grants

1572

# visibility to the element.

1573

#

1574

# If a rule has multiple labels, removing one of the labels but not all of

1575

# them can break clients.

#

# Example:

#

# visibility:

# rules:

# - selector: google.calendar.Calendar.EnhancedSearch

1582

# restriction: GOOGLE_INTERNAL, TRUSTED_TESTER

1583

#

1584

# Removing GOOGLE_INTERNAL from this restriction will break clients that

1585

# rely on this method and only had access to it through GOOGLE_INTERNAL.

1586

"selector": "A String", # Selects methods, messages, fields, enums, etc. to which this rule applies.

1587

#

1588

# Refer to selector for syntax details.

},

],

},

"metrics": [ # Defines the metrics used by this service.

1593

{ # Defines a metric type and its schema.

1594

"displayName": "A String", # A concise name for the metric, which can be displayed in user interfaces.

1595

# Use sentence case without an ending period, for example "Request count".

1596

"description": "A String", # A detailed description of the metric, which can be used in documentation.

1597

"metricKind": "A String", # Whether the metric records instantaneous values, changes to a value, etc.

1598

"valueType": "A String", # Whether the measurement is an integer, a floating-point number, etc.

1599

"labels": [ # The set of labels that can be used to describe a specific instance of this

1600

# metric type. For example, the

1601

# `compute.googleapis.com/instance/network/received_bytes_count` metric type

1602

# has a label, `loadbalanced`, that specifies whether the traffic was

1603

# received through a load balanced IP address.

1604

{ # A description of a label.

1605

"valueType": "A String", # The type of data that can be assigned to the label.

1606

"description": "A String", # A human-readable description for the label.

1607

"key": "A String", # The label key.

1608

},

1609

],

1610

"type": "A String", # The metric type including a DNS name prefix, for example

1611

# `"compute.googleapis.com/instance/cpu/utilization"`. Metric types

1612

# should use a natural hierarchical grouping such as the following:

1613

#

1614

# compute.googleapis.com/instance/cpu/utilization

1615

# compute.googleapis.com/instance/disk/read_ops_count

1616

# compute.googleapis.com/instance/network/received_bytes_count

1617

#

1618

# Note that if the metric type changes, the monitoring data will be

1619

# discontinued, and anything depends on it will break, such as monitoring

1620

# dashboards, alerting rules and quota limits. Therefore, once a metric has

1621

# been published, its type should be immutable.

1622

"unit": "A String", # The unit in which the metric value is reported. It is only applicable

1623

# if the `value_type` is `INT64`, `DOUBLE`, or `DISTRIBUTION`. The

1624

# supported units are a subset of [The Unified Code for Units of

1625

# Measure](http://unitsofmeasure.org/ucum.html) standard:

1626

#

1627

# **Basic units (UNIT)**

#

# * `bit` bit

# * `By` byte

# * `s` second

# * `min` minute

# * `h` hour

# * `d` day

#

# **Prefixes (PREFIX)**

#

# * `k` kilo (10**3)

# * `M` mega (10**6)

# * `G` giga (10**9)

# * `T` tera (10**12)

1642

# * `P` peta (10**15)

1643

# * `E` exa (10**18)

1644

# * `Z` zetta (10**21)

1645

# * `Y` yotta (10**24)

1646

# * `m` milli (10**-3)

1647

# * `u` micro (10**-6)

1648

# * `n` nano (10**-9)

1649

# * `p` pico (10**-12)

1650

# * `f` femto (10**-15)

1651

# * `a` atto (10**-18)

1652

# * `z` zepto (10**-21)

1653

# * `y` yocto (10**-24)

1654

# * `Ki` kibi (2**10)

1655

# * `Mi` mebi (2**20)

1656

# * `Gi` gibi (2**30)

1657

# * `Ti` tebi (2**40)

#

# **Grammar**

#

# The grammar includes the dimensionless unit `1`, such as `1/s`.

1662

#

1663

# The grammar also includes these connectors:

1664

#

1665

# * `/` division (as an infix operator, e.g. `1/s`).

1666

# * `.` multiplication (as an infix operator, e.g. `GBy.d`)

1667

#

1668

# The grammar for a unit is as follows:

1669

#

1670

# Expression = Component { "." Component } { "/" Component } ;

1671

#

1672

# Component = [ PREFIX ] UNIT [ Annotation ]

# | Annotation

# | "1"

# ;

#

# Annotation = "{" NAME "}" ;

#

# Notes:

#

# * `Annotation` is just a comment if it follows a `UNIT` and is

1682

# equivalent to `1` if it is used alone. For examples,

1683

# `{requests}/s == 1/s`, `By{transmitted}/s == By/s`.

1684

# * `NAME` is a sequence of non-blank printable ASCII characters not

1685

# containing '{' or '}'.

1686

"name": "A String", # Resource name. The format of the name may vary between different

1687

# implementations. For examples:

1688

#

1689

# projects/{project_id}/metricDescriptors/{type=**}

1690

# metricDescriptors/{type=**}

1691

},

1692

],

1693

"enums": [ # A list of all enum types included in this API service. Enums

1694

# referenced directly or indirectly by the `apis` are automatically

1695

# included. Enums which are not referenced but shall be included

1696

# should be listed here by name. Example:

1697

#

1698

# enums:

1699

# - name: google.someapi.v1.SomeEnum

1700

{ # Enum type definition.

1701

"sourceContext": { # `SourceContext` represents information about the source of a # The source context.

1702

# protobuf element, like the file in which it is defined.

1703

"fileName": "A String", # The path-qualified name of the .proto file that contained the associated

1704

# protobuf element. For example: `"google/protobuf/source_context.proto"`.

1705

},

1706

"enumvalue": [ # Enum value definitions.

1707

{ # Enum value definition.

1708

"number": 42, # Enum value number.

1709

"options": [ # Protocol buffer options.

1710

{ # A protocol buffer option, which can be attached to a message, field,

1711

# enumeration, etc.

1712

"name": "A String", # The option's name. For example, `"java_package"`.

1713

"value": { # The option's value. For example, `"com.google.protobuf"`.

1714

"a_key": "", # Properties of the object. Contains field @type with type URL.

},

},

],

"name": "A String", # Enum value name.

1719

},

1720

],

1721

"options": [ # Protocol buffer options.

1722

{ # A protocol buffer option, which can be attached to a message, field,

1723

# enumeration, etc.

1724

"name": "A String", # The option's name. For example, `"java_package"`.

1725

"value": { # The option's value. For example, `"com.google.protobuf"`.

1726

"a_key": "", # Properties of the object. Contains field @type with type URL.

},

},

],

"name": "A String", # Enum type name.

1731

"syntax": "A String", # The source syntax.

1732

},

1733

],

1734

"types": [ # A list of all proto message types included in this API service.

1735

# Types referenced directly or indirectly by the `apis` are

1736

# automatically included. Messages which are not referenced but

1737

# shall be included, such as types used by the `google.protobuf.Any` type,

1738

# should be listed here by name. Example:

1739

#

1740

# types:

1741

# - name: google.protobuf.Int32

1742

{ # A protocol buffer message type.

1743

"oneofs": [ # The list of types appearing in `oneof` definitions in this type.

1744

"A String",

1745

],

1746

"name": "A String", # The fully qualified message name.

1747

"sourceContext": { # `SourceContext` represents information about the source of a # The source context.

1748

# protobuf element, like the file in which it is defined.

1749

"fileName": "A String", # The path-qualified name of the .proto file that contained the associated

1750

# protobuf element. For example: `"google/protobuf/source_context.proto"`.

1751

},

1752

"syntax": "A String", # The source syntax.

1753

"fields": [ # The list of fields.

1754

{ # A single field of a message type.

1755

"kind": "A String", # The field type.

1756

"oneofIndex": 42, # The index of the field type in `Type.oneofs`, for message or enumeration

1757

# types. The first type has index 1; zero means the type is not in the list.

1758

"typeUrl": "A String", # The field type URL, without the scheme, for message or enumeration

1759

# types. Example: `"type.googleapis.com/google.protobuf.Timestamp"`.

1760

"name": "A String", # The field name.

1761

"defaultValue": "A String", # The string value of the default value of this field. Proto2 syntax only.

1762

"jsonName": "A String", # The field JSON name.

1763

"number": 42, # The field number.

1764

"cardinality": "A String", # The field cardinality.

1765

"options": [ # The protocol buffer options.

1766

{ # A protocol buffer option, which can be attached to a message, field,

1767

# enumeration, etc.

1768

"name": "A String", # The option's name. For example, `"java_package"`.

1769

"value": { # The option's value. For example, `"com.google.protobuf"`.

1770

"a_key": "", # Properties of the object. Contains field @type with type URL.

},

},

],

"packed": True or False, # Whether to use alternative packed wire representation.

1775

},

1776

],

1777

"options": [ # The protocol buffer options.

1778

{ # A protocol buffer option, which can be attached to a message, field,

1779

# enumeration, etc.

1780

"name": "A String", # The option's name. For example, `"java_package"`.

1781

"value": { # The option's value. For example, `"com.google.protobuf"`.

1782

"a_key": "", # Properties of the object. Contains field @type with type URL.

},

},

],

},

],

"logging": { # Logging configuration of the service. # Logging configuration of the service.

1789

#

1790

# The following example shows how to configure logs to be sent to the

1791

# producer and consumer projects. In the example,

1792

# the `library.googleapis.com/activity_history` log is

1793

# sent to both the producer and consumer projects, whereas

1794

# the `library.googleapis.com/purchase_history` log is only sent to the

1795

# producer project:

1796

#

1797

# monitored_resources:

1798

# - type: library.googleapis.com/branch

1799

# labels:

1800

# - key: /city

1801

# description: The city where the library branch is located in.

1802

# - key: /name

1803

# description: The name of the branch.

1804

# logs:

1805

# - name: library.googleapis.com/activity_history

1806

# labels:

1807

# - key: /customer_id

1808

# - name: library.googleapis.com/purchase_history

1809

# logging:

1810

# producer_destinations:

1811

# - monitored_resource: library.googleapis.com/branch

1812

# logs:

1813

# - library.googleapis.com/activity_history

1814

# - library.googleapis.com/purchase_history

1815

# consumer_destinations:

1816

# - monitored_resource: library.googleapis.com/branch

1817

# logs:

1818

# - library.googleapis.com/activity_history

1819

"producerDestinations": [ # Logging configurations for sending logs to the producer project.

1820

# There can be multiple producer destinations, each one must have a

1821

# different monitored resource type. A log can be used in at most

1822

# one producer destination.

1823

{ # Configuration of a specific logging destination (the producer project

1824

# or the consumer project).

1825

"monitoredResource": "A String", # The monitored resource type. The type must be defined in

1826

# Service.monitored_resources section.

1827

"logs": [ # Names of the logs to be sent to this destination. Each name must

1828

# be defined in the Service.logs section.

"A String",

],

},

],

"consumerDestinations": [ # Logging configurations for sending logs to the consumer project.

1834

# There can be multiple consumer destinations, each one must have a

1835

# different monitored resource type. A log can be used in at most

1836

# one consumer destination.

1837

{ # Configuration of a specific logging destination (the producer project

1838

# or the consumer project).

1839

"monitoredResource": "A String", # The monitored resource type. The type must be defined in

1840

# Service.monitored_resources section.

1841

"logs": [ # Names of the logs to be sent to this destination. Each name must

1842

# be defined in the Service.logs section.

"A String",

],

},

],

},

"name": "A String", # The DNS address at which this service is available,

1849

# e.g. `calendar.googleapis.com`.

1850

"documentation": { # `Documentation` provides the information for describing a service. # Additional API documentation.

1851

#

1852

# Example:

1853

# <pre><code>documentation:

1854

# summary: >

1855

# The Google Calendar API gives access

1856

# to most calendar features.

1857

# pages:

1858

# - name: Overview

1859

# content: (== include google/foo/overview.md ==)

1860

# - name: Tutorial

1861

# content: (== include google/foo/tutorial.md ==)

1862

# subpages;

1863

# - name: Java

1864

# content: (== include google/foo/tutorial_java.md ==)

1865

# rules:

1866

# - selector: google.calendar.Calendar.Get

1867

# description: >

1868

# ...

1869

# - selector: google.calendar.Calendar.Put

# description: >

# ...

# </code></pre>

# Documentation is provided in markdown syntax. In addition to

1874

# standard markdown features, definition lists, tables and fenced

1875

# code blocks are supported. Section headers can be provided and are

1876

# interpreted relative to the section nesting of the context where

1877

# a documentation fragment is embedded.

1878

#

1879

# Documentation from the IDL is merged with documentation defined

1880

# via the config at normalization time, where documentation provided

1881

# by config rules overrides IDL provided.

1882

#

1883

# A number of constructs specific to the API platform are supported

1884

# in documentation text.

1885

#

1886

# In order to reference a proto element, the following

1887

# notation can be used:

1888

# <pre><code>[fully.qualified.proto.name][]</code></pre>

1889

# To override the display text used for the link, this can be used:

1890

# <pre><code>[display text][fully.qualified.proto.name]</code></pre>

1891

# Text can be excluded from doc using the following notation:

1892

# <pre><code>(-- internal comment --)</code></pre>

1893

# Comments can be made conditional using a visibility label. The below

1894

# text will be only rendered if the `BETA` label is available:

1895

# <pre><code>(--BETA: comment for BETA users --)</code></pre>

1896

# A few directives are available in documentation. Note that

1897

# directives must appear on a single line to be properly

1898

# identified. The `include` directive includes a markdown file from

1899

# an external source:

1900

# <pre><code>(== include path/to/file ==)</code></pre>

1901

# The `resource_for` directive marks a message to be the resource of

1902

# a collection in REST view. If it is not specified, tools attempt

1903

# to infer the resource from the operations in a collection:

1904

# <pre><code>(== resource_for v1.shelves.books ==)</code></pre>

1905

# The directive `suppress_warning` does not directly affect documentation

1906

# and is documented together with service config validation.

1907

"rules": [ # A list of documentation rules that apply to individual API elements.

1908

#

1909

# **NOTE:** All service configuration rules follow "last one wins" order.

1910

{ # A documentation rule provides information about individual API elements.

1911

"description": "A String", # Description of the selected API(s).

1912

"deprecationDescription": "A String", # Deprecation description of the selected element(s). It can be provided if an

1913

# element is marked as `deprecated`.

1914

"selector": "A String", # The selector is a comma-separated list of patterns. Each pattern is a

1915

# qualified name of the element which may end in "*", indicating a wildcard.

1916

# Wildcards are only allowed at the end and for a whole component of the

1917

# qualified name, i.e. "foo.*" is ok, but not "foo.b*" or "foo.*.bar". To

1918

# specify a default for all applicable elements, the whole pattern "*"

# is used.

},

],

"overview": "A String", # Declares a single overview page. For example:

1923

# <pre><code>documentation:

1924

# summary: ...

1925

# overview: (== include overview.md ==)

1926

# </code></pre>

1927

# This is a shortcut for the following declaration (using pages style):

1928

# <pre><code>documentation:

# summary: ...

# pages:

# - name: Overview

# content: (== include overview.md ==)

1933

# </code></pre>

1934

# Note: you cannot specify both `overview` field and `pages` field.

1935

"summary": "A String", # A short summary of what the service does. Can only be provided by

1936

# plain text.

1937

"pages": [ # The top level pages for the documentation set.

1938

{ # Represents a documentation page. A page can contain subpages to represent

1939

# nested documentation set structure.

1940

"content": "A String", # The Markdown content of the page. You can use <code>(== include {path} ==)</code>

1941

# to include content from a Markdown file.

1942

"subpages": [ # Subpages of this page. The order of subpages specified here will be

1943

# honored in the generated docset.

1944

# Object with schema name: Page

1945

],

1946

"name": "A String", # The name of the page. It will be used as an identity of the page to

1947

# generate URI of the page, text of the link to this page in navigation,

1948

# etc. The full page name (start from the root page name to this page

1949

# concatenated with `.`) can be used as reference to the page in your

1950

# documentation. For example:

1951

# <pre><code>pages:

1952

# - name: Tutorial

1953

# content: (== include tutorial.md ==)

1954

# subpages:

1955

# - name: Java

1956

# content: (== include tutorial_java.md ==)

1957

# </code></pre>

1958

# You can reference `Java` page using Markdown reference link syntax:

# `Java`.

},

],

"documentationRootUrl": "A String", # The URL to the root of documentation.

1963

},

1964

"systemTypes": [ # A list of all proto message types included in this API service.

1965

# It serves similar purpose as [google.api.Service.types], except that

1966

# these types are not needed by user-defined APIs. Therefore, they will not

1967

# show up in the generated discovery doc. This field should only be used

1968

# to define system APIs in ESF.

1969

{ # A protocol buffer message type.

1970

"oneofs": [ # The list of types appearing in `oneof` definitions in this type.

1971

"A String",

1972

],

1973

"name": "A String", # The fully qualified message name.

1974

"sourceContext": { # `SourceContext` represents information about the source of a # The source context.

1975

# protobuf element, like the file in which it is defined.

1976

"fileName": "A String", # The path-qualified name of the .proto file that contained the associated

1977

# protobuf element. For example: `"google/protobuf/source_context.proto"`.

1978

},

1979

"syntax": "A String", # The source syntax.

1980

"fields": [ # The list of fields.

1981

{ # A single field of a message type.

1982

"kind": "A String", # The field type.

1983

"oneofIndex": 42, # The index of the field type in `Type.oneofs`, for message or enumeration

1984

# types. The first type has index 1; zero means the type is not in the list.

1985

"typeUrl": "A String", # The field type URL, without the scheme, for message or enumeration

1986

# types. Example: `"type.googleapis.com/google.protobuf.Timestamp"`.

1987

"name": "A String", # The field name.

1988

"defaultValue": "A String", # The string value of the default value of this field. Proto2 syntax only.

1989

"jsonName": "A String", # The field JSON name.

1990

"number": 42, # The field number.

1991

"cardinality": "A String", # The field cardinality.

1992

"options": [ # The protocol buffer options.

1993

{ # A protocol buffer option, which can be attached to a message, field,

1994

# enumeration, etc.

1995

"name": "A String", # The option's name. For example, `"java_package"`.

1996

"value": { # The option's value. For example, `"com.google.protobuf"`.

1997

"a_key": "", # Properties of the object. Contains field @type with type URL.

},

},

],

"packed": True or False, # Whether to use alternative packed wire representation.

2002

},

2003

],

2004

"options": [ # The protocol buffer options.

2005

{ # A protocol buffer option, which can be attached to a message, field,

2006

# enumeration, etc.

2007

"name": "A String", # The option's name. For example, `"java_package"`.

2008

"value": { # The option's value. For example, `"com.google.protobuf"`.

2009

"a_key": "", # Properties of the object. Contains field @type with type URL.

},

},

],

},

],

"context": { # `Context` defines which contexts an API requests. # Context configuration.

#

# Example:

#

# context:

# rules:

# - selector: "*"

# requested:

# - google.rpc.context.ProjectContext

2024

# - google.rpc.context.OriginContext

2025

#

2026

# The above specifies that all methods in the API request

2027

# `google.rpc.context.ProjectContext` and

2028

# `google.rpc.context.OriginContext`.

2029

#

2030

# Available context types are defined in package

2031

# `google.rpc.context`.

2032

"rules": [ # A list of RPC context rules that apply to individual API methods.

2033

#

2034

# **NOTE:** All service configuration rules follow "last one wins" order.

2035

{ # A context rule provides information about the context for an individual API

2036

# element.

2037

"provided": [ # A list of full type names of provided contexts.

2038

"A String",

2039

],

2040

"requested": [ # A list of full type names of requested contexts.

2041

"A String",

2042

],

2043

"selector": "A String", # Selects the methods to which this rule applies.

2044

#

2045

# Refer to selector for syntax details.

},

],

},

}</pre>

</div>

<code class="details" id="getIamPolicy">getIamPolicy(resource=None, body, x__xgafv=None)</code>

2054

<pre>Gets the access control policy for a resource.

2055

Returns an empty policy if the resource exists and does not have a policy

set.

Args:

resource: string, REQUIRED: The resource for which the policy is being requested.

2060

`resource` is usually specified as a path. For example, a Project

2061

resource is specified as `projects/{project}`. (required)

2062

body: object, The request body. (required)

2063

The object takes the form of:

2064

2065

{ # Request message for `GetIamPolicy` method.

2066

}

2067

2068

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

2075

2076

{ # Defines an Identity and Access Management (IAM) policy. It is used to

2077

# specify access control policies for Cloud Platform resources.

2078

#

2079

#

2080

# A `Policy` consists of a list of `bindings`. A `Binding` binds a list of

2081

# `members` to a `role`, where the members can be user accounts, Google groups,

2082

# Google domains, and service accounts. A `role` is a named list of permissions

# defined by IAM.

#

# **Example**

#

# {

# "bindings": [

# {

# "role": "roles/owner",

2091

# "members": [

2092

# "user:mike@example.com",

2093

# "group:admins@example.com",

2094

# "domain:google.com",

2095

# "serviceAccount:my-other-app@appspot.gserviceaccount.com",

# ]

# },

# {

# "role": "roles/viewer",

2100

# "members": ["user:sean@example.com"]

# }

# ]

# }

#

# For a description of IAM and its features, see the

2106

# [IAM developer's guide](https://cloud.google.com/iam).

2107

"auditConfigs": [ # Specifies audit logging configs for "data access".

2108

# "data access": generally refers to data reads/writes and admin reads.

2109

# "admin activity": generally refers to admin writes.

2110

#

2111

# Note: `AuditConfig` doesn't apply to "admin activity", which always

2112

# enables audit logging.

2113

{ # Enables "data access" audit logging for a service and specifies a list

2114

# of members that are log-exempted.

2115

"exemptedMembers": [ # Specifies the identities that are exempted from "data access" audit

2116

# logging for the `service` specified above.

2117

# Follows the same format of Binding.members.

2118

"A String",

2119

],

2120

"service": "A String", # Specifies a service that will be enabled for "data access" audit

2121

# logging.

2122

# For example, `resourcemanager`, `storage`, `compute`.

2123

# `allServices` is a special value that covers all services.

2124

},

2125

],

2126

"rules": [ # If more than one rule is specified, the rules are applied in the following

2127

# manner:

2128

# - All matching LOG rules are always applied.

2129

# - If any DENY/DENY_WITH_LOG rule matches, permission is denied.

2130

# Logging will be applied if one or more matching rule requires logging.

2131

# - Otherwise, if any ALLOW/ALLOW_WITH_LOG rule matches, permission is

2132

# granted.

2133

# Logging will be applied if one or more matching rule requires logging.

2134

# - Otherwise, if no rule applies, permission is denied.

2135

{ # A rule to be applied in a Policy.

2136

"notIn": [ # If one or more 'not_in' clauses are specified, the rule matches

2137

# if the PRINCIPAL/AUTHORITY_SELECTOR is in none of the entries.

2138

# The format for in and not_in entries is the same as for members in a

2139

# Binding (see google/iam/v1/policy.proto).

2140

"A String",

2141

],

2142

"description": "A String", # Human-readable description of the rule.

2143

"in": [ # If one or more 'in' clauses are specified, the rule matches if

2144

# the PRINCIPAL/AUTHORITY_SELECTOR is in at least one of these entries.

2145

"A String",

2146

],

2147

"action": "A String", # Required

2148

"conditions": [ # Additional restrictions that must be met

2149

{ # A condition to be met.

2150

"iam": "A String", # Trusted attributes supplied by the IAM system.

2151

"svc": "A String", # Trusted attributes discharged by the service.

2152

"value": "A String", # DEPRECATED. Use 'values' instead.

2153

"sys": "A String", # Trusted attributes supplied by any service that owns resources and uses

2154

# the IAM system for access control.

2155

"values": [ # The objects of the condition. This is mutually exclusive with 'value'.

2156

"A String",

2157

],

2158

"op": "A String", # An operator to apply the subject with.

2159

},

2160

],

2161

"logConfig": [ # The config returned to callers of tech.iam.IAM.CheckPolicy for any entries

2162

# that match the LOG action.

2163

{ # Specifies what kind of log the caller must write

2164

# Increment a streamz counter with the specified metric and field names.

2165

#

2166

# Metric names should start with a '/', generally be lowercase-only,

2167

# and end in "_count". Field names should not contain an initial slash.

2168

# The actual exported metric names will have "/iam/policy" prepended.

2169

#

2170

# Field names correspond to IAM request parameters and field values are

2171

# their respective values.

2172

#

2173

# At present the only supported field names are

2174

# - "iam_principal", corresponding to IAMContext.principal;

2175

# - "" (empty string), resulting in one aggretated counter with no field.

2176

#

2177

# Examples:

2178

# counter { metric: "/debug_access_count" field: "iam_principal" }

2179

# ==> increment counter /iam/policy/backend_debug_access_count

2180

# {iam_principal=[value of IAMContext.principal]}

2181

#

2182

# At this time we do not support:

2183

# * multiple field names (though this may be supported in the future)

2184

# * decrementing the counter

2185

# * incrementing it by anything other than 1

2186

"counter": { # Options for counters # Counter options.

2187

"field": "A String", # The field value to attribute.

2188

"metric": "A String", # The metric to update.

2189

},

2190

"dataAccess": { # Write a Data Access (Gin) log # Data access options.

2191

},

2192

"cloudAudit": { # Write a Cloud Audit log # Cloud audit options.

},

},

],

"permissions": [ # A permission is a string of form '<service>.<resource type>.<verb>'

2197

# (e.g., 'storage.buckets.list'). A value of '*' matches all permissions,

2198

# and a verb part of '*' (e.g., 'storage.buckets.*') matches all verbs.

"A String",

],

},

],

"version": 42, # Version of the `Policy`. The default version is 0.

2204

"etag": "A String", # `etag` is used for optimistic concurrency control as a way to help

2205

# prevent simultaneous updates of a policy from overwriting each other.

2206

# It is strongly suggested that systems make use of the `etag` in the

2207

# read-modify-write cycle to perform policy updates in order to avoid race

2208

# conditions: An `etag` is returned in the response to `getIamPolicy`, and

2209

# systems are expected to put that etag in the request to `setIamPolicy` to

2210

# ensure that their change will be applied to the same version of the policy.

2211

#

2212

# If no `etag` is provided in the call to `setIamPolicy`, then the existing

2213

# policy is overwritten blindly.

2214

"bindings": [ # Associates a list of `members` to a `role`.

2215

# Multiple `bindings` must not be specified for the same `role`.

2216

# `bindings` with no members will result in an error.

2217

{ # Associates `members` with a `role`.

2218

"role": "A String", # Role that is assigned to `members`.

2219

# For example, `roles/viewer`, `roles/editor`, or `roles/owner`.

2220

# Required

2221

"members": [ # Specifies the identities requesting access for a Cloud Platform resource.

2222

# `members` can have the following values:

2223

#

2224

# * `allUsers`: A special identifier that represents anyone who is

2225

# on the internet; with or without a Google account.

2226

#

2227

# * `allAuthenticatedUsers`: A special identifier that represents anyone

2228

# who is authenticated with a Google account or a service account.

2229

#

2230

# * `user:{emailid}`: An email address that represents a specific Google

2231

# account. For example, `alice@gmail.com` or `joe@example.com`.

2232

#

2233

# * `serviceAccount:{emailid}`: An email address that represents a service

2234

# account. For example, `my-other-app@appspot.gserviceaccount.com`.

2235

#

2236

# * `group:{emailid}`: An email address that represents a Google group.

2237

# For example, `admins@example.com`.

2238

#

2239

# * `domain:{domain}`: A Google Apps domain name that represents all the

2240

# users of that domain. For example, `google.com` or `example.com`.

#

"A String",

],

},

],

"iamOwned": True or False,

}</pre>

</div>

<code class="details" id="list">list(producerProjectId=None, pageSize=None, pageToken=None, x__xgafv=None)</code>

2252

<pre>Lists all managed services.

2253

2254

Args:

2255

producerProjectId: string, Include services produced by the specified project.

2256

pageSize: integer, Requested size of the next page of data.

2257

pageToken: string, Token identifying which result to start with; returned by a previous list

2258

call.

2259

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

2266

2267

{ # Response message for `ListServices` method.

2268

"nextPageToken": "A String", # Token that can be passed to `ListServices` to resume a paginated query.

2269

"services": [ # The results of the query.

2270

{ # The full representation of a Service that is managed by

2271

# Google Service Management.

2272

"serviceName": "A String", # The name of the service. See the [overview](/service-management/overview)

2273

# for naming requirements.

2274

"producerProjectId": "A String", # ID of the project that produces and owns this service.

},

],

}</pre>

</div>

<code class="details" id="list_next">list_next(previous_request, previous_response)</code>

2282

<pre>Retrieves the next page of results.

2283

2284

Args:

2285

previous_request: The request for the previous page. (required)

2286

previous_response: The response from the request for the previous page. (required)

2287

2288

Returns:

2289

A request object that you can call 'execute()' on to request the next

2290

page. Returns None if there are no more items in the collection.

</pre>

</div>

<code class="details" id="setIamPolicy">setIamPolicy(resource=None, body, x__xgafv=None)</code>

2296

<pre>Sets the access control policy on the specified resource. Replaces any

existing policy.

Args:

resource: string, REQUIRED: The resource for which the policy is being specified.

2301

`resource` is usually specified as a path. For example, a Project

2302

resource is specified as `projects/{project}`. (required)

2303

body: object, The request body. (required)

2304

The object takes the form of:

2305

2306

{ # Request message for `SetIamPolicy` method.

2307

"policy": { # Defines an Identity and Access Management (IAM) policy. It is used to # REQUIRED: The complete policy to be applied to the `resource`. The size of

2308

# the policy is limited to a few 10s of KB. An empty policy is a

2309

# valid policy but certain Cloud Platform services (such as Projects)

2310

# might reject them.

2311

# specify access control policies for Cloud Platform resources.

2312

#

2313

#

2314

# A `Policy` consists of a list of `bindings`. A `Binding` binds a list of

2315

# `members` to a `role`, where the members can be user accounts, Google groups,

2316

# Google domains, and service accounts. A `role` is a named list of permissions

# defined by IAM.

#

# **Example**

#

# {

# "bindings": [

# {

# "role": "roles/owner",

2325

# "members": [

2326

# "user:mike@example.com",

2327

# "group:admins@example.com",

2328

# "domain:google.com",

2329

# "serviceAccount:my-other-app@appspot.gserviceaccount.com",

# ]

# },

# {

# "role": "roles/viewer",

2334

# "members": ["user:sean@example.com"]

# }

# ]

# }

#

# For a description of IAM and its features, see the

2340

# [IAM developer's guide](https://cloud.google.com/iam).

2341

"auditConfigs": [ # Specifies audit logging configs for "data access".

2342

# "data access": generally refers to data reads/writes and admin reads.

2343

# "admin activity": generally refers to admin writes.

2344

#

2345

# Note: `AuditConfig` doesn't apply to "admin activity", which always

2346

# enables audit logging.

2347

{ # Enables "data access" audit logging for a service and specifies a list

2348

# of members that are log-exempted.

2349

"exemptedMembers": [ # Specifies the identities that are exempted from "data access" audit

2350

# logging for the `service` specified above.

2351

# Follows the same format of Binding.members.

2352

"A String",

2353

],

2354

"service": "A String", # Specifies a service that will be enabled for "data access" audit

2355

# logging.

2356

# For example, `resourcemanager`, `storage`, `compute`.

2357

# `allServices` is a special value that covers all services.

2358

},

2359

],

2360

"rules": [ # If more than one rule is specified, the rules are applied in the following

2361

# manner:

2362

# - All matching LOG rules are always applied.

2363

# - If any DENY/DENY_WITH_LOG rule matches, permission is denied.

2364

# Logging will be applied if one or more matching rule requires logging.

2365

# - Otherwise, if any ALLOW/ALLOW_WITH_LOG rule matches, permission is

2366

# granted.

2367

# Logging will be applied if one or more matching rule requires logging.

2368

# - Otherwise, if no rule applies, permission is denied.

2369

{ # A rule to be applied in a Policy.

2370

"notIn": [ # If one or more 'not_in' clauses are specified, the rule matches

2371

# if the PRINCIPAL/AUTHORITY_SELECTOR is in none of the entries.

2372

# The format for in and not_in entries is the same as for members in a

2373

# Binding (see google/iam/v1/policy.proto).

2374

"A String",

2375

],

2376

"description": "A String", # Human-readable description of the rule.

2377

"in": [ # If one or more 'in' clauses are specified, the rule matches if

2378

# the PRINCIPAL/AUTHORITY_SELECTOR is in at least one of these entries.

2379

"A String",

2380

],

2381

"action": "A String", # Required

2382

"conditions": [ # Additional restrictions that must be met

2383

{ # A condition to be met.

2384

"iam": "A String", # Trusted attributes supplied by the IAM system.

2385

"svc": "A String", # Trusted attributes discharged by the service.

2386

"value": "A String", # DEPRECATED. Use 'values' instead.

2387

"sys": "A String", # Trusted attributes supplied by any service that owns resources and uses

2388

# the IAM system for access control.

2389

"values": [ # The objects of the condition. This is mutually exclusive with 'value'.

2390

"A String",

2391

],

2392

"op": "A String", # An operator to apply the subject with.

2393

},

2394

],

2395

"logConfig": [ # The config returned to callers of tech.iam.IAM.CheckPolicy for any entries

2396

# that match the LOG action.

2397

{ # Specifies what kind of log the caller must write

2398

# Increment a streamz counter with the specified metric and field names.

2399

#

2400

# Metric names should start with a '/', generally be lowercase-only,

2401

# and end in "_count". Field names should not contain an initial slash.

2402

# The actual exported metric names will have "/iam/policy" prepended.

2403

#

2404

# Field names correspond to IAM request parameters and field values are

2405

# their respective values.

2406

#

2407

# At present the only supported field names are

2408

# - "iam_principal", corresponding to IAMContext.principal;

2409

# - "" (empty string), resulting in one aggretated counter with no field.

2410

#

2411

# Examples:

2412

# counter { metric: "/debug_access_count" field: "iam_principal" }

2413

# ==> increment counter /iam/policy/backend_debug_access_count

2414

# {iam_principal=[value of IAMContext.principal]}

2415

#

2416

# At this time we do not support:

2417

# * multiple field names (though this may be supported in the future)

2418

# * decrementing the counter

2419

# * incrementing it by anything other than 1

2420

"counter": { # Options for counters # Counter options.

2421

"field": "A String", # The field value to attribute.

2422

"metric": "A String", # The metric to update.

2423

},

2424

"dataAccess": { # Write a Data Access (Gin) log # Data access options.

2425

},

2426

"cloudAudit": { # Write a Cloud Audit log # Cloud audit options.

},

},

],

"permissions": [ # A permission is a string of form '<service>.<resource type>.<verb>'

2431

# (e.g., 'storage.buckets.list'). A value of '*' matches all permissions,

2432

# and a verb part of '*' (e.g., 'storage.buckets.*') matches all verbs.

"A String",

],

},

],

"version": 42, # Version of the `Policy`. The default version is 0.

2438

"etag": "A String", # `etag` is used for optimistic concurrency control as a way to help

2439

# prevent simultaneous updates of a policy from overwriting each other.

2440

# It is strongly suggested that systems make use of the `etag` in the

2441

# read-modify-write cycle to perform policy updates in order to avoid race

2442

# conditions: An `etag` is returned in the response to `getIamPolicy`, and

2443

# systems are expected to put that etag in the request to `setIamPolicy` to

2444

# ensure that their change will be applied to the same version of the policy.

2445

#

2446

# If no `etag` is provided in the call to `setIamPolicy`, then the existing

2447

# policy is overwritten blindly.

2448

"bindings": [ # Associates a list of `members` to a `role`.

2449

# Multiple `bindings` must not be specified for the same `role`.

2450

# `bindings` with no members will result in an error.

2451

{ # Associates `members` with a `role`.

2452

"role": "A String", # Role that is assigned to `members`.

2453

# For example, `roles/viewer`, `roles/editor`, or `roles/owner`.

2454

# Required

2455

"members": [ # Specifies the identities requesting access for a Cloud Platform resource.

2456

# `members` can have the following values:

2457

#

2458

# * `allUsers`: A special identifier that represents anyone who is

2459

# on the internet; with or without a Google account.

2460

#

2461

# * `allAuthenticatedUsers`: A special identifier that represents anyone

2462

# who is authenticated with a Google account or a service account.

2463

#

2464

# * `user:{emailid}`: An email address that represents a specific Google

2465

# account. For example, `alice@gmail.com` or `joe@example.com`.

2466

#

2467

# * `serviceAccount:{emailid}`: An email address that represents a service

2468

# account. For example, `my-other-app@appspot.gserviceaccount.com`.

2469

#

2470

# * `group:{emailid}`: An email address that represents a Google group.

2471

# For example, `admins@example.com`.

2472

#

2473

# * `domain:{domain}`: A Google Apps domain name that represents all the

2474

# users of that domain. For example, `google.com` or `example.com`.

#

"A String",

],

},

],

"iamOwned": True or False,

},

}

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

2491

2492

{ # Defines an Identity and Access Management (IAM) policy. It is used to

2493

# specify access control policies for Cloud Platform resources.

2494

#

2495

#

2496

# A `Policy` consists of a list of `bindings`. A `Binding` binds a list of

2497

# `members` to a `role`, where the members can be user accounts, Google groups,

2498

# Google domains, and service accounts. A `role` is a named list of permissions

# defined by IAM.

#

# **Example**

#

# {

# "bindings": [

# {

# "role": "roles/owner",

2507

# "members": [

2508

# "user:mike@example.com",

2509

# "group:admins@example.com",

2510

# "domain:google.com",

2511

# "serviceAccount:my-other-app@appspot.gserviceaccount.com",

# ]

# },

# {

# "role": "roles/viewer",

2516

# "members": ["user:sean@example.com"]

# }

# ]

# }

#

# For a description of IAM and its features, see the

2522

# [IAM developer's guide](https://cloud.google.com/iam).

2523

"auditConfigs": [ # Specifies audit logging configs for "data access".

2524

# "data access": generally refers to data reads/writes and admin reads.

2525

# "admin activity": generally refers to admin writes.

2526

#

2527

# Note: `AuditConfig` doesn't apply to "admin activity", which always

2528

# enables audit logging.

2529

{ # Enables "data access" audit logging for a service and specifies a list

2530

# of members that are log-exempted.

2531

"exemptedMembers": [ # Specifies the identities that are exempted from "data access" audit

2532

# logging for the `service` specified above.

2533

# Follows the same format of Binding.members.

2534

"A String",

2535

],

2536

"service": "A String", # Specifies a service that will be enabled for "data access" audit

2537

# logging.

2538

# For example, `resourcemanager`, `storage`, `compute`.

2539

# `allServices` is a special value that covers all services.

2540

},

2541

],

2542

"rules": [ # If more than one rule is specified, the rules are applied in the following

2543

# manner:

2544

# - All matching LOG rules are always applied.

2545

# - If any DENY/DENY_WITH_LOG rule matches, permission is denied.

2546

# Logging will be applied if one or more matching rule requires logging.

2547

# - Otherwise, if any ALLOW/ALLOW_WITH_LOG rule matches, permission is

2548

# granted.

2549

# Logging will be applied if one or more matching rule requires logging.

2550

# - Otherwise, if no rule applies, permission is denied.

2551

{ # A rule to be applied in a Policy.

2552

"notIn": [ # If one or more 'not_in' clauses are specified, the rule matches

2553

# if the PRINCIPAL/AUTHORITY_SELECTOR is in none of the entries.

2554

# The format for in and not_in entries is the same as for members in a

2555

# Binding (see google/iam/v1/policy.proto).

2556

"A String",

2557

],

2558

"description": "A String", # Human-readable description of the rule.

2559

"in": [ # If one or more 'in' clauses are specified, the rule matches if

2560

# the PRINCIPAL/AUTHORITY_SELECTOR is in at least one of these entries.

2561

"A String",

2562

],

2563

"action": "A String", # Required

2564

"conditions": [ # Additional restrictions that must be met

2565

{ # A condition to be met.

2566

"iam": "A String", # Trusted attributes supplied by the IAM system.

2567

"svc": "A String", # Trusted attributes discharged by the service.

2568

"value": "A String", # DEPRECATED. Use 'values' instead.

2569

"sys": "A String", # Trusted attributes supplied by any service that owns resources and uses

2570

# the IAM system for access control.

2571

"values": [ # The objects of the condition. This is mutually exclusive with 'value'.

2572

"A String",

2573

],

2574

"op": "A String", # An operator to apply the subject with.

2575

},

2576

],

2577

"logConfig": [ # The config returned to callers of tech.iam.IAM.CheckPolicy for any entries

2578

# that match the LOG action.

2579

{ # Specifies what kind of log the caller must write

2580

# Increment a streamz counter with the specified metric and field names.

2581

#

2582

# Metric names should start with a '/', generally be lowercase-only,

2583

# and end in "_count". Field names should not contain an initial slash.

2584

# The actual exported metric names will have "/iam/policy" prepended.

2585

#

2586

# Field names correspond to IAM request parameters and field values are

2587

# their respective values.

2588

#

2589

# At present the only supported field names are

2590

# - "iam_principal", corresponding to IAMContext.principal;

2591

# - "" (empty string), resulting in one aggretated counter with no field.

2592

#

2593

# Examples:

2594

# counter { metric: "/debug_access_count" field: "iam_principal" }

2595

# ==> increment counter /iam/policy/backend_debug_access_count

2596

# {iam_principal=[value of IAMContext.principal]}

2597

#

2598

# At this time we do not support:

2599

# * multiple field names (though this may be supported in the future)

2600

# * decrementing the counter

2601

# * incrementing it by anything other than 1

2602

"counter": { # Options for counters # Counter options.

2603

"field": "A String", # The field value to attribute.

2604

"metric": "A String", # The metric to update.

2605

},

2606

"dataAccess": { # Write a Data Access (Gin) log # Data access options.

2607

},

2608

"cloudAudit": { # Write a Cloud Audit log # Cloud audit options.

},

},

],

"permissions": [ # A permission is a string of form '<service>.<resource type>.<verb>'

2613

# (e.g., 'storage.buckets.list'). A value of '*' matches all permissions,

2614

# and a verb part of '*' (e.g., 'storage.buckets.*') matches all verbs.

"A String",

],

},

],

"version": 42, # Version of the `Policy`. The default version is 0.

2620

"etag": "A String", # `etag` is used for optimistic concurrency control as a way to help

2621

# prevent simultaneous updates of a policy from overwriting each other.

2622

# It is strongly suggested that systems make use of the `etag` in the

2623

# read-modify-write cycle to perform policy updates in order to avoid race

2624

# conditions: An `etag` is returned in the response to `getIamPolicy`, and

2625

# systems are expected to put that etag in the request to `setIamPolicy` to

2626

# ensure that their change will be applied to the same version of the policy.

2627

#

2628

# If no `etag` is provided in the call to `setIamPolicy`, then the existing

2629

# policy is overwritten blindly.

2630

"bindings": [ # Associates a list of `members` to a `role`.

2631

# Multiple `bindings` must not be specified for the same `role`.

2632

# `bindings` with no members will result in an error.

2633

{ # Associates `members` with a `role`.

2634

"role": "A String", # Role that is assigned to `members`.

2635

# For example, `roles/viewer`, `roles/editor`, or `roles/owner`.

2636

# Required

2637

"members": [ # Specifies the identities requesting access for a Cloud Platform resource.

2638

# `members` can have the following values:

2639

#

2640

# * `allUsers`: A special identifier that represents anyone who is

2641

# on the internet; with or without a Google account.

2642

#

2643

# * `allAuthenticatedUsers`: A special identifier that represents anyone

2644

# who is authenticated with a Google account or a service account.

2645

#

2646

# * `user:{emailid}`: An email address that represents a specific Google

2647

# account. For example, `alice@gmail.com` or `joe@example.com`.

2648

#

2649

# * `serviceAccount:{emailid}`: An email address that represents a service

2650

# account. For example, `my-other-app@appspot.gserviceaccount.com`.

2651

#

2652

# * `group:{emailid}`: An email address that represents a Google group.

2653

# For example, `admins@example.com`.

2654

#

2655

# * `domain:{domain}`: A Google Apps domain name that represents all the

2656

# users of that domain. For example, `google.com` or `example.com`.

#

"A String",

],

},

],

"iamOwned": True or False,

}</pre>

</div>

<code class="details" id="testIamPermissions">testIamPermissions(resource=None, body, x__xgafv=None)</code>

2668

<pre>Returns permissions that a caller has on the specified resource.

2669

2670

Args:

2671

resource: string, REQUIRED: The resource for which the policy detail is being requested.

2672

`resource` is usually specified as a path. For example, a Project

2673

resource is specified as `projects/{project}`. (required)

2674

body: object, The request body. (required)

2675

The object takes the form of:

2676

2677

{ # Request message for `TestIamPermissions` method.

2678

"permissions": [ # The set of permissions to check for the `resource`. Permissions with

2679

# wildcards (such as '*' or 'storage.*') are not allowed. For more

2680

# information see

2681

# [IAM Overview](https://cloud.google.com/iam/docs/overview#permissions).

"A String",

],

}

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

2693

2694

{ # Response message for `TestIamPermissions` method.

2695

"permissions": [ # A subset of `TestPermissionsRequest.permissions` that the caller is

# allowed.

"A String",

],

}</pre>

</div>

<code class="details" id="undelete">undelete(serviceName=None, x__xgafv=None)</code>

2704

<pre>Revives a previously deleted managed service. The method restores the

2705

service using the configuration at the time the service was deleted.

2706

The target service must exist and must have been deleted within the

2707

last 30 days.

2708

2709

Operation<response: UndeleteServiceResponse>

2710

2711

Args:

2712

serviceName: string, The name of the service. See the [overview](/service-management/overview)

2713

for naming requirements. For example: `example.googleapis.com`. (required)

2714

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

2721

2722

{ # This resource represents a long-running operation that is the result of a

2723

# network API call.

2724

"metadata": { # Service-specific metadata associated with the operation. It typically

2725

# contains progress information and common metadata such as create time.

2726

# Some services might not provide such metadata. Any method that returns a

2727

# long-running operation should document the metadata type, if any.

2728

"a_key": "", # Properties of the object. Contains field @type with type URL.

2729

},

2730

"done": True or False, # If the value is `false`, it means the operation is still in progress.

2731

# If true, the operation is completed, and either `error` or `response` is

2732

# available.

2733

"response": { # The normal response of the operation in case of success. If the original

2734

# method returns no data on success, such as `Delete`, the response is

2735

# `google.protobuf.Empty`. If the original method is standard

2736

# `Get`/`Create`/`Update`, the response should be the resource. For other

2737

# methods, the response should have the type `XxxResponse`, where `Xxx`

2738

# is the original method name. For example, if the original method name

2739

# is `TakeSnapshot()`, the inferred response type is

2740

# `TakeSnapshotResponse`.

2741

"a_key": "", # Properties of the object. Contains field @type with type URL.

2742

},

2743

"name": "A String", # The server-assigned name, which is only unique within the same service that

2744

# originally returns it. If you use the default HTTP mapping, the

2745

# `name` should have the format of `operations/some/unique/name`.

2746

"error": { # The `Status` type defines a logical error model that is suitable for different # The error result of the operation in case of failure.

2747

# programming environments, including REST APIs and RPC APIs. It is used by

2748

# [gRPC](https://github.com/grpc). The error model is designed to be:

2749

#

2750

# - Simple to use and understand for most users

2751

# - Flexible enough to meet unexpected needs

#

# # Overview

#

# The `Status` message contains three pieces of data: error code, error message,

2756

# and error details. The error code should be an enum value of

2757

# google.rpc.Code, but it may accept additional error codes if needed. The

2758

# error message should be a developer-facing English message that helps

2759

# developers *understand* and *resolve* the error. If a localized user-facing

2760

# error message is needed, put the localized message in the error details or

2761

# localize it in the client. The optional error details may contain arbitrary

2762

# information about the error. There is a predefined set of error detail types

2763

# in the package `google.rpc` which can be used for common error conditions.

#

# # Language mapping

#

# The `Status` message is the logical representation of the error model, but it

2768

# is not necessarily the actual wire format. When the `Status` message is

2769

# exposed in different client libraries and different wire protocols, it can be

2770

# mapped differently. For example, it will likely be mapped to some exceptions

2771

# in Java, but more likely mapped to some error codes in C.

#

# # Other uses

#

# The error model and the `Status` message can be used in a variety of

2776

# environments, either with or without APIs, to provide a

2777

# consistent developer experience across different environments.

2778

#

2779

# Example uses of this error model include:

2780

#

2781

# - Partial errors. If a service needs to return partial errors to the client,

2782

# it may embed the `Status` in the normal response to indicate the partial

2783

# errors.

2784

#

2785

# - Workflow errors. A typical workflow has multiple steps. Each step may

2786

# have a `Status` message for error reporting purpose.

2787

#

2788

# - Batch operations. If a client uses batch request and batch response, the

2789

# `Status` message should be used directly inside batch response, one for

2790

# each error sub-response.

2791

#

2792

# - Asynchronous operations. If an API call embeds asynchronous operation

2793

# results in its response, the status of those operations should be

2794

# represented directly using the `Status` message.

2795

#

2796

# - Logging. If some API errors are stored in logs, the message `Status` could

2797

# be used directly after any stripping needed for security/privacy reasons.

2798

"message": "A String", # A developer-facing error message, which should be in English. Any

2799

# user-facing error message should be localized and sent in the

2800

# google.rpc.Status.details field, or localized by the client.

2801

"code": 42, # The status code, which should be an enum value of google.rpc.Code.

2802

"details": [ # A list of messages that carry the error details. There will be a

2803

# common set of message types for APIs to use.

2804

{

2805

"a_key": "", # Properties of the object. Contains field @type with type URL.

},

],

},

}</pre>

</div>

</body></html>